swagger: "2.0"
basePath: /api
info:
  description: API de Dados Abertos com dados processados pelo grupo de monitoramento de Queimadas do INPE.
  title: Dados Abertos - API
  version: "1.0"
  x-apisguru-categories:
    - location
  x-description-language: br
  x-origin:
    - format: swagger
      url: http://queimadas.dgi.inpe.br/queimadas/dados-abertos/api/swagger.json
      version: "2.0"
  x-providerName: inpe.br
  x-serviceName: dados-abertos
consumes:
  - application/json
produces:
  - application/json
responses:
  MaskError:
    description: When any error occurs on mask
  ParseError:
    description: When a mask can't be parsed
tags:
  - description: Focos de calor das últimas 24 horas detectados por todos os satélites
    name: focos
  - description: Endpoints auxiliares
    name: auxiliar
paths:
  /auxiliar/estados:
    get:
      operationId: get_estados_auxiliar_resource
      parameters:
        - collectionFormat: multi
          description: Código do país pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          items:
            type: integer
          name: pais_id
          type: array
      responses:
        "200":
          description: Sucesso
        "400":
          description: Erro de validação
      summary: Endpoint para retorno dos dados de estados utilizados na filtragem de focos
      tags:
        - auxiliar
  /auxiliar/municipios:
    get:
      operationId: get_municipios_auxiliar_resource
      parameters:
        - description: Código do país pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: pais_id
          required: true
          type: integer
        - collectionFormat: multi
          description: Código do estado pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          items:
            type: integer
          name: estado_id
          type: array
      responses:
        "200":
          description: Sucesso
        "400":
          description: Erro de validação
      summary: Endpoint para retorno dos dados de municípios utilizados na filtragem de focos
      tags:
        - auxiliar
  /auxiliar/paises:
    get:
      operationId: get_paises_auxiliar_resource
      responses:
        "200":
          description: Sucesso
      summary: Endpoint para retorno dos dados de países utilizados na filtragem de focos
      tags:
        - auxiliar
  /auxiliar/satelites:
    get:
      operationId: get_satelite_auxiliar_resource
      responses:
        "200":
          description: Sucesso
      summary: Endpoint para retorno dos dados de satélites utilizados na filtragem de focos
      tags:
        - auxiliar
  /focos/:
    get:
      operationId: get_focos_resource
      parameters:
        - description: Código do país pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: pais_id
          type: integer
        - description: Código do estado pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: estado_id
          type: integer
        - description: Código do município pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: municipio_id
          type: integer
        - collectionFormat: multi
          description: Nome do satélte pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          items:
            type: string
          name: satelite
          type: array
        - description: An optional fields mask
          format: mask
          in: header
          name: X-Fields
          type: string
      responses:
        "200":
          description: Sucesso
        "400":
          description: Erro de validação
      summary: Endpoint para retorno dos dados de focos de calor
      tags:
        - focos
  /focos/count:
    get:
      operationId: get_focos_count_resource
      parameters:
        - description: Código do país pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: pais_id
          type: integer
        - description: Código do estado pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: estado_id
          type: integer
        - description: Código do município pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          name: municipio_id
          type: integer
        - collectionFormat: multi
          description: Nome do satélte pelo qual será filtrado o resultado. Ver rotas auxiliares.
          in: query
          items:
            type: string
          name: satelite
          type: array
      responses:
        "200":
          description: Sucesso
        "400":
          description: Erro de validação
      summary: Endpoint para retorno da contagem dos focos de calor
      tags:
        - focos
