openapi: 3.0.3

info:
  title: Fogos.pt
  description: |
    Fogos.pt Official API Documentation.

    - [Registo para utilizar a API](https://fogos.pt/pt/api)
    - [Termos de utilização da API](https://fogos.pt/pt/api-termos)
  version: 1.0.0
  contact:
    name: Tomahock
    email: mail@fogos.pt

servers:
  - url: 'https://api.fogos.pt'
    description: Production Server
  - url: 'http://localhost:8080'
    description: Local Development Server

tags:
  - name: Assets
    description: Aerial firefighting assets and history (legacy).
  - name: Fires
    description: Legacy `/fires/*` and `/v1/*` incident endpoints.
  - name: Misc
    description: Miscellaneous text-formatted endpoints used by social bots.
  - name: Stats
    description: Statistics on fire incidents.
  - name: Warnings
    description: IPMA weather warnings and operational warnings.
  - name: RCM
    description: Risco de Incêndio (fire risk) maps and parish lookups.
  - name: Weather
    description: |
      Weather stations, daily observations, IPMA data, and derived products
      such as heat/cold wave detection.
  - name: Planes
    description: Aerial firefighting asset tracking (ADS-B).
  - name: Moderation
    description: |
      User-submitted photo moderation queue. Protected by `PHOTO_MODERATION_KEY`.
  - name: V2
    description: V2 incident endpoints — current generation.

paths:
  # Assets
  /v1/aerial:
    $ref: './assets/paths/legacy-v1-aerial.yaml'
  /v1/now/data:
    $ref: './assets/paths/legacy-v1-now-data.yaml'

  # Fires (legacy)
  /fires:
    $ref: './fires/paths/legacy-fires.yaml'
  /fires/danger:
    $ref: './fires/paths/legacy-fires-danger.yaml'
  /fires/data:
    $ref: './fires/paths/legacy-fires-data.yaml'
  /fires/status:
    $ref: './fires/paths/legacy-fires-status.yaml'
  /new/fires:
    $ref: './fires/paths/legacy-new-fires.yaml'
  /madeira/fires:
    $ref: './fires/paths/legacy-madeira-fires.yaml'
  /madeira/fires/status:
    $ref: './fires/paths/legacy-madeira-fires-status.yaml'
  /v1/active:
    $ref: './fires/paths/legacy-v1-active.yaml'
  /v1/list:
    $ref: './fires/paths/legacy-v1-list.yaml'
  /v1/now:
    $ref: './fires/paths/legacy-v1-now.yaml'

  # Misc (legacy — mostly text for social bots)
  /v1/risk-today:
    $ref: './misc/paths/legacy-v1-risk-today.yaml'
  /v1/risk-tomorrow:
    $ref: './misc/paths/legacy-v1-risk-tomorrow.yaml'
  /v1/risk-after:
    $ref: './misc/paths/legacy-v1-risk-after.yaml'
  /v1/risk:
    $ref: './misc/paths/legacy-v1-risk.yaml'
  /v1/status:
    $ref: './misc/paths/legacy-v1-status.yaml'

  # Warnings (legacy)
  /v1/madeira/warnings:
    $ref: './warnings/paths/legacy-v1-madeira-warnings.yaml'
  /v1/warnings:
    $ref: './warnings/paths/legacy-v1-warnings.yaml'
  /v1/warnings/site:
    $ref: './warnings/paths/legacy-v1-warnings-site.yaml'

  # Stats (legacy)
  /v1/stats:
    $ref: './stats/paths/legacy-v1-stats.yaml'
  /v1/stats/8hours:
    $ref: './stats/paths/legacy-v1-stats-8hours.yaml'
  /v1/stats/8hours/yesterday:
    $ref: './stats/paths/legacy-v1-stats-8hours-yesterday.yaml'
  /v1/stats/last-night:
    $ref: './stats/paths/legacy-v1-stats-last-night.yaml'
  /v1/stats/week:
    $ref: './stats/paths/legacy-v1-stats-week.yaml'
  /v1/stats/today:
    $ref: './stats/paths/legacy-v1-stats-today.yaml'
  /v1/stats/yesterday:
    $ref: './stats/paths/legacy-v1-stats-yesterday.yaml'
  /v1/stats/burn-area:
    $ref: './stats/paths/legacy-v1-stats-burn-area.yaml'
  /v1/stats/motive:
    $ref: './stats/paths/legacy-v1-stats-motive.yaml'

  # V2 — Incidents
  /v2/incidents/active:
    $ref: './fires/paths/v2-active.yaml'
  /v2/incidents/active/kml:
    $ref: './fires/paths/v2-active-kml.yaml'
  /v2/incidents/search:
    $ref: './fires/paths/v2-search.yaml'
  /v2/incidents/1000ha-burned:
    $ref: './fires/paths/v2-1000ha-burned.yaml'
  /v2/incidents/{id}/kml:
    $ref: './fires/paths/v2-incident-kml.yaml'
  /v2/incidents/{id}/kmlVost:
    $ref: './fires/paths/v2-incident-kmlvost.yaml'
  /v2/incidents/{id}/kmlFirms:
    $ref: './fires/paths/v2-incident-kmlfirms.yaml'
  /v2/incidents/{id}/kml/history:
    $ref: './fires/paths/v2-incident-kml-history.yaml'
  /v2/incidents/{id}/kml/history/{historyId}:
    $ref: './fires/paths/v2-incident-kml-history-detail.yaml'
  /v2/incidents/{id}/perimeter:
    $ref: './fires/paths/v2-incident-perimeter.yaml'
  /v2/incidents/{id}/simulation:
    $ref: './fires/paths/v2-incident-simulation.yaml'
  /v2/incidents/{id}/posit:
    $ref: './fires/paths/v2-incident-posit.yaml'
  /v2/incidents/{id}/photos:
    $ref: './fires/paths/v2-incident-photos.yaml'
  /v2/incidents/{id}/live-activity/register:
    $ref: './fires/paths/v2-incident-liveactivity-register.yaml'
  /v2/incidents/{id}/live-activity/unregister:
    $ref: './fires/paths/v2-incident-liveactivity-unregister.yaml'

  # V2 — Photo moderation
  /v2/moderation/photos:
    $ref: './fires/paths/v2-moderation-photos.yaml'
  /v2/moderation/photos/{photoId}/approve:
    $ref: './fires/paths/v2-moderation-photo-approve.yaml'
  /v2/moderation/photos/{photoId}/reject:
    $ref: './fires/paths/v2-moderation-photo-reject.yaml'

  # V2 — Weather
  /v2/weather/thunders:
    $ref: './weather/paths/v2-weather-thunders.yaml'
  /v2/weather/stations:
    $ref: './weather/paths/v2-weather-stations.yaml'
  /v2/weather/daily:
    $ref: './weather/paths/v2-weather-daily.yaml'
  /v2/weather/waves:
    $ref: './weather/paths/v2-weather-waves.yaml'
  /v2/weather/ipma-services:
    $ref: './weather/paths/v2-weather-ipma-services.yaml'

  # V2 — Fire perimeters and spread simulations (MTG FRP Processor)
  /v2/fire/perimeters:
    $ref: './fires/paths/v2-fire-perimeters.yaml'
  /v2/fire/simulation:
    $ref: './fires/paths/v2-fire-simulation.yaml'

  # V2 — RCM (fire risk maps)
  /v2/rcm/today:
    $ref: './rcm/paths/v2-rcm-today.yaml'
  /v2/rcm/tomorrow:
    $ref: './rcm/paths/v2-rcm-tomorrow.yaml'
  /v2/rcm/after:
    $ref: './rcm/paths/v2-rcm-after.yaml'
  /v2/rcm/parish:
    $ref: './rcm/paths/v2-rcm-parish.yaml'
  /v2/rcm/update:
    $ref: './rcm/paths/v2-rcm-update.yaml'

  # V2 — Planes
  /v2/planes:
    $ref: './planes/paths/v2-planes.yaml'
  /v2/planes/active:
    $ref: './planes/paths/v2-planes-active.yaml'
  /v2/planes/recent:
    $ref: './planes/paths/v2-planes-recent.yaml'
  /v2/planes/{icao}/track:
    $ref: './planes/paths/v2-planes-icao-track.yaml'
  /v2/planes/{icao}:
    $ref: './planes/paths/v2-planes-icao.yaml'

  # V2 — Warnings
  /v2/warnings/add:
    $ref: './warnings/paths/v2-warnings-add.yaml'
  /v2/warnings/add/agif:
    $ref: './warnings/paths/v2-warnings-add-agif.yaml'

  # V2 — Stats
  /v2/stats/today/ignitions-hourly:
    $ref: './stats/paths/v2-stats-ignitions-hourly.yaml'

  # V2 — Other
  /v2/other/mobile-contributors:
    $ref: './misc/paths/v2-mobile-contributors.yaml'