openapi: 3.1.0
info:
  title: Frequency
  version: 2.0.0
  description: Schema definition for the Frequency entity in the Beckn Mobility domain.
  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:
    Frequency:
      x-iri: https://schema.nfh.global/Frequency/v2.0
      type: object
      title: Frequency
      description: A headway-based service specification indicating how often a vehicle
        runs on a route within a given time window.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        headwaySecs:
          description: Time in seconds between consecutive vehicle departures
          type: number
        exactTimes:
          description: Whether departures are at exact scheduled times (true) or headway-based
            (false)
          type: boolean
        startTime:
          description: Time at which this frequency period begins (HH:MM:SS)
          type: string
        endTime:
          description: Time at which this frequency period ends (HH:MM:SS)
          type: string
        id:
          description: Unique identifier for the constraint
          type: string
        constraintType:
          description: Type of constraint (extensible term)
          type: string
        operator:
          description: Comparator operator (e.g. <=, >=, =)
          type: string
        value:
          description: Numeric value of the constraint
          type: number
        unitCode:
          description: Unit of measure code (UN/ECE Rec 20)
          type: string
        validity:
          description: Validity window for this constraint
          $ref: https://schema.nfh.global/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
      additionalProperties: false