AlertCamp Hot Sites V2 API

openapi: 3.2.0
info:
  title: AlertCamp Hot Sites V2 API
  description: Service d'alertes de disponibilité SEPAQ pour le camping au Québec
  version: 0.1.0
tags:
- name: hot-sites-v2
paths:
  /api/v2/hot-sites/count:
    get:
      tags:
      - hot-sites-v2
      summary: Count Hot Sites
      description: Return the aggregate hot_sites count for the wizard's filters.
      operationId: count_hot_sites_api_v2_hot_sites_count_get
      parameters:
      - name: provider
        in: query
        required: true
        schema:
          type: string
          description: Provider id (e.g. bc_parks, ontario_parks, parks_canada).
          title: Provider
        description: Provider id (e.g. bc_parks, ontario_parks, parks_canada).
      - name: activity_type
        in: query
        required: true
        schema:
          type: string
          description: 'Activity bucket: camping | chalet | backcountry | canoe_camping | peche.'
          title: Activity Type
        description: 'Activity bucket: camping | chalet | backcountry | canoe_camping | peche.'
      - name: park_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: When set, scope the count to a single park.
          title: Park Id
        description: When set, scope the count to a single park.
      - name: equipment_mode
        in: query
        required: false
        schema:
          type: string
          description: any | tent | rv (matches the wizard's equipment filter).
          default: any
          title: Equipment Mode
        description: any | tent | rv (matches the wizard's equipment filter).
      - name: sub_equipment_id
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
          - type: 'null'
          description: Required when equipment_mode='rv'.
          title: Sub Equipment Id
        description: Required when equipment_mode='rv'.
      - name: require_electricity
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Require Electricity
      - name: require_accessible
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Require Accessible
      - name: require_pets
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Require Pets
      - name: require_pull_through
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Require Pull Through
      - name: require_tent_only
        in: query
        required: false
        schema:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Require Tent Only
      - name: party_size
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            minimum: 1
          - type: 'null'
          description: When set, drop sites whose ``max_occupancy`` is below this. Sites with NULL max_occupancy pass (capacity unknown) — same convention as ``site_passes_party_filter``.
          title: Party Size
        description: When set, drop sites whose ``max_occupancy`` is below this. Sites with NULL max_occupancy pass (capacity unknown) — same convention as ``site_passes_party_filter``.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HotSiteCountResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HotSiteCountResponse:
      properties:
        total:
          type: integer
          title: Total
          description: Active hot_sites matching provider + activity_type (+ optional park_id). No equipment/amenity filters applied.
        matching:
          type: integer
          title: Matching
          description: Subset of ``total`` that also passes the supplied equipment + amenity filters. Equal to ``total`` when no filters are active.
      type: object
      required:
      - total
      - matching
      title: HotSiteCountResponse
      description: Aggregate count of hot sites matching the wizard's filters.
    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
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError