openapi: 3.1.0
info:
  title: StationStatus
  version: 2.0.0
  description: Schema definition for the StationStatus entity in the Beckn Mobility
  license:
    name: CC-BY-NC-SA 4.0 International
    url: https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    StationStatus:
      x-iri: https://schema.nfh.global/StationStatus/v2.0
      type: object
      title: StationStatus
      description: The real-time operational state of a shared mobility station, including
        the number of available docks and vehicles.
      x-tags:
        - mobility
        - schema-org
        - ride-hailing
      properties:
        stationId:
          description: Unique identifier of the station being reported
          type: string
        numBikesAvailable:
          description: Number of bikes currently available for rental
          type: number
        numDocksAvailable:
          description: Number of empty docking points currently available
          type: number
        isInstalled:
          description: Whether the station is physically installed and operational
          type: boolean
        isRenting:
          description: Whether the station is currently renting bikes
          type: boolean
        isReturning:
          description: Whether the station is currently accepting bike returns
          type: boolean
        lastReported:
          description: Timestamp of the last status update for this station
          type: string
          format: date-time
        id:
          description: Unique identifier for the state
          type: string
        descriptor:
          description: Human-readable description of the state
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        updatedAt:
          description: Timestamp when the state was last updated
          type: string
          format: date-time
      additionalProperties: false