openapi: 3.0.2
info:
  title: Resenhas do Mercado Aberto
  version: '1.0'
  description: |-

    Esta API lista os relatórios da Resenha de Mercado Aberto já publicados.
  license:
    url: http://www.opendefinition.org/licenses/odc-odbl
    name: Licença Aberta para Bases de Dados (ODbL) do Open Data Commons
  contact:
    url: https://www.bcb.gov.br/acessoinformacao/faleconosco
    name: Banco Central do Brasil
servers:
  - url: https://www.bcb.gov.br/api/servico/sitebcb/resenhamercadoaberto
    description: Ambiente de produção
paths:
  /:
    parameters: []
    get:
      summary: Lista das resenhas de mercado aberto
      responses:
        '200':
          description: Lista de relatórios obtida com sucesso.
          content:
            application/json:
              schema:       
                $ref: '#/components/schemas/relatorios'
              examples:
                Lista de relatórios:
                  $ref: '#/components/examples/exemplo_relatorios'
      operationId: reportList
      description: >-
        Lista informações básicas dos relatórios de Resenha de Mercado
        publicados.
      parameters:
        - schema:
            type: integer
            minimum: 1
            maximum: 3000
            default: 5
            example: 5
          in: query
          name: quantidade
          description: Quantidade de relatórios a serem retornados, em ordem decrescente
          required: true

components:
  schemas:
    relatorios:
      type: object
      additionalProperties: false
      properties:
        conteudo:    
          type: array
          title: Relatórios          
          items:
            type: object
            additionalProperties: false
            properties:
              dataInicio:
                type: string
                title: Data de início do período considerado no relatório
                format: date
                description: "Data de início do período considerado no relatório, com formato conforme especificação RFC-3339 (ex: 2021-09-03)"
                example: '2021-09-03'
              dataFim:
                type: string
                title: Data de fim do período considerado no relatório
                format: date
                description: "Data de fim do período considerado no relatório, com formato conforme especificação RFC-3339 (ex: 2021-09-03)"
                example: '2021-09-10'
              url:
                type: string
                title: Url
                description: Caminho completo para acesso ao arquivo PDF do relatório
                example: "https://www.bcb.gov.br/content/ri/relatorioinflacao/202106/ri202106p.pdf"

  examples:
    exemplo_relatorios:
      value:
        conteudo:
        - dataInicio: '2020-04-13'
          dataFim: '2020-04-17'
          url: https://www4.bcb.gov.br/pec/GCI/PORT/focus/W20200413-20200417.pdf
        - dataInicio: '2020-04-06'
          dataFim: '2020-04-09'
          url: https://www4.bcb.gov.br/pec/GCI/PORT/focus/W20200406-20200409.pdf
        - dataInicio: '2020-03-30'
          dataFim: '2020-04-03'
          url: https://www4.bcb.gov.br/pec/GCI/PORT/focus/W20200330-20200403.pdf