docs.yml

---
  swagger: "2.0"
  info:
    version: "0.1"
    title: "AVURNAVs"
    description: "Tells about in-force navigational warnings in metropolitan France"
    contact:
      name: "Antoine Augusti"
    license:
      name: "MIT"
  host: "avurnav.antoine-augusti.fr"
  basePath: "/"
  schemes:
    - "https"
  produces:
    - "application/json"
  paths:
    /avurnavs/regions/{region}:
      get:
        description: >
          Returns in-force navigational warnings for the region under the supervision of a specific Préfet Maritime. Navigational warnings are called AVURNAVs ("avis urgents aux navigateurs") in French.
          This endpoint is limited at 60 HTTP requests / minute / IP address.
        produces:
          - "application/json"
        parameters:
          - name: region
            in: path
            description: The Préfet Maritime region
            required: true
            type: string
            enum: [atlantique, manche, méditerranée]
        responses:
          "200":
            description: "A list of in-force navigational warnings for this region"
            schema:
              type: "array"
              items:
                $ref: "#/definitions/AVURNAV"
            headers:
              X-RateLimit-Limit:
                description: The number of HTTP requests authorized in this current period
                type: integer
              X-RateLimit-Remaining:
                description: The number of HTTP requests remaining in this current period
                type: integer
              X-RateLimit-Reset:
                description: UNIX timestamp telling when the current period will end
                type: integer
  definitions:
    AVURNAV:
      required:
        - number
        - title
        - content
        - latitude
        - longitude
        - url
        - valid_from
        - valid_until
        - premar_region
      properties:
        number:
          type: string
          pattern: '^\d+\/\d{2}$'
          example: "1115/18"
        title:
          type: string
          example: "ANTIFER - PHARE DE GATEVILLE"
        content:
          type: string
          example: "LES NAVIGATEURS SONT INFORMES DE LA MISE EN PLACE CE JOUR A TITRE D'ESSAIS D'UN SYSTEME AIS SUR LE PHARE DE GATTEVILLE (MMSI 992271217). (LFLA 30400). POSITION (WGS84): 49-41,8N 001-16,0W"
        latitude:
          type: number
          format: float
          example: 49.222
        longitude:
          type: number
          format: float
          example: -1.2654
        url:
          type: string
          format: url
          example: "https://www.premar-manche.gouv.fr/avis-urgents-aux-navigateurs/antifer-phare-gateville-1115.html"
        valid_from:
          type: string
          format: date
          example: "2018-12-01"
        valid_until:
          type: string
          format: date
          example: "2018-12-31"
        premar_region:
          type: string
          example: "Atlantique"