openapi: 3.1.0
info:
  title: Prognosis
  version: 2.0.0
  description: Schema definition for the Prognosis 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:
    Prognosis:
      type: object
      title: Prognosis
      description: A real-time prediction of a vehicle's arrival or departure time
        at a stop, including an indication of prediction confidence.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        scheduledTime:
          description: Timetabled scheduled time
          type: string
          format: date-time
        estimatedTime:
          description: Predicted actual time
          type: string
          format: date-time
        certainty:
          description: Confidence of the prognosis (e.g. real, prognosis, calculated,
            unknown)
          type: string
        delaySeconds:
          description: Delay in seconds relative to the scheduled time
          type: number
        id:
          description: Unique identifier for the tracking record
          type: string
        url:
          description: URL endpoint for real-time tracking information
          type: string
          format: uri
        status:
          description: Current tracking status
          $ref: https://schema.beckn.io/State/v2.0/attributes.yaml#/components/schemas/State
        validity:
          description: Validity period for this tracking record
          $ref: https://schema.beckn.io/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
      additionalProperties: false