AlertCamp Parks V2 API

openapi: 3.2.0
info:
  title: AlertCamp Parks V2 API
  description: Service d'alertes de disponibilité SEPAQ pour le camping au Québec
  version: 0.1.0
tags:
- name: parks-v2
paths:
  /api/v2/parks/campgrounds/{campground_id}/maps:
    get:
      tags:
      - parks-v2
      summary: Get Campground Maps V2
      description: 'Every pin, including both activities'' rows for cross-listed inventory.


        Pass ``camp_type`` to get one activity''s rows — the ids that client''s

        selection and alerts are keyed on. Omit it to get the full set, which is

        what a browser showing every site on a map wants.'
      operationId: get_campground_maps_v2_api_v2_parks_campgrounds__campground_id__maps_get
      parameters:
      - name: campground_id
        in: path
        required: true
        schema:
          type: string
          title: Campground Id
      - name: camp_type
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Camp Type
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampgroundMapsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    SiteMapPosition:
      properties:
        site_id:
          type: string
          maxLength: 512
          title: Site Id
        x:
          type: integer
          minimum: 0.0
          title: X
        y:
          type: integer
          minimum: 0.0
          title: Y
        is_hot:
          type: boolean
          title: Is Hot
          description: Whether this site is in the curated hot_sites set (matches the same gold ring used on the park discovery map).
          default: false
      type: object
      required:
      - site_id
      - x
      - y
      title: SiteMapPosition
      description: A site's pixel position on a campground map's PNG.
    CampgroundMapsResponse:
      properties:
        campground_id:
          type: string
          maxLength: 128
          title: Campground Id
        maps:
          items:
            $ref: '#/components/schemas/CampgroundMapItem'
          type: array
          title: Maps
      type: object
      required:
      - campground_id
      - maps
      title: CampgroundMapsResponse
      description: Wrapper for the maps endpoint.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AmenityLegendEntry:
      properties:
        label:
          type: string
          maxLength: 128
          title: Label
        icon_url:
          type: string
          maxLength: 512
          title: Icon Url
        bg_color:
          anyOf:
          - type: string
            maxLength: 9
          - type: 'null'
          title: Bg Color
      type: object
      required:
      - label
      - icon_url
      title: AmenityLegendEntry
      description: 'One row of the amenity legend key — an icon + its name.


        Used for providers whose amenity icons are baked into the map artwork

        (Alberta), so we show a "what the icons mean" list rather than

        positional markers.  ``icon_url`` proxies the icon from our DB.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    MapLink:
      properties:
        x:
          type: number
          title: X
        y:
          type: number
          title: Y
        w:
          type: number
          title: W
        h:
          type: number
          title: H
        target_map_id:
          type: string
          maxLength: 128
          title: Target Map Id
      type: object
      required:
      - x
      - y
      - w
      - h
      - target_map_id
      title: MapLink
      description: A rectangle on a map that opens another map of the same campground.
    AmenityPosition:
      properties:
        legend_type:
          type: integer
          minimum: 0.0
          title: Legend Type
        x:
          type: integer
          minimum: 0.0
          title: X
        y:
          type: integer
          minimum: 0.0
          title: Y
        r:
          type: integer
          maximum: 255.0
          minimum: 0.0
          title: R
        g:
          type: integer
          maximum: 255.0
          minimum: 0.0
          title: G
        b:
          type: integer
          maximum: 255.0
          minimum: 0.0
          title: B
        icon_asset:
          type: string
          maxLength: 64
          title: Icon Asset
      type: object
      required:
      - legend_type
      - x
      - y
      - r
      - g
      - b
      - icon_asset
      title: AmenityPosition
      description: 'A legend marker (parking, restroom, water tap, etc.) on a campground map.


        `legend_type` is the GTC platform-wide enum (same code = same icon

        across OP/PC/BC).  `icon_asset` is the filename under

        `mobile/assets/legend_icons/` the client should render.  `r/g/b`

        is the colored backdrop the booking site draws behind the icon.'
    CampgroundMapItem:
      properties:
        id:
          type: string
          maxLength: 128
          title: Id
        gtc_map_id:
          anyOf:
          - type: integer
          - type: 'null'
          title: Gtc Map Id
        image_url:
          type: string
          maxLength: 512
          title: Image Url
        image_is_svg:
          type: boolean
          title: Image Is Svg
          default: false
        width:
          type: integer
          exclusiveMinimum: 0.0
          title: Width
        height:
          type: integer
          exclusiveMinimum: 0.0
          title: Height
        name:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Name
        display_order:
          type: integer
          minimum: 0.0
          title: Display Order
        sites:
          items:
            $ref: '#/components/schemas/SiteMapPosition'
          type: array
          title: Sites
        amenities:
          items:
            $ref: '#/components/schemas/AmenityPosition'
          type: array
          title: Amenities
        amenity_legend:
          items:
            $ref: '#/components/schemas/AmenityLegendEntry'
          type: array
          title: Amenity Legend
        links:
          items:
            $ref: '#/components/schemas/MapLink'
          type: array
          title: Links
      type: object
      required:
      - id
      - image_url
      - width
      - height
      - display_order
      - sites
      title: CampgroundMapItem
      description: A single map within a campground (one zone or area).