openapi: 3.1.0
info:
  title: StopEvent
  version: 2.0.0
  description: Schema definition for the StopEvent 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:
    StopEvent:
      x-iri: https://schema.nfh.global/StopEvent/v2.0
      type: object
      title: StopEvent
      description: A departure or arrival event at a stop, used to retrieve the next
        or previous vehicle movements at a specific location.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        stopEventType:
          description: Type of event (DEPARTURE, ARRIVAL)
          type: string
        timetabledTime:
          description: Scheduled time for the event
          type: string
          format: date-time
        estimatedTime:
          description: Estimated actual time for the event
          type: string
          format: date-time
        serviceJourneyRef:
          description: Reference to the vehicle journey for this event
          $ref: https://schema.nfh.global/VehicleJourney/v2.0/attributes.yaml#/components/schemas/VehicleJourney
        stopPointRef:
          description: Reference to the stop point where the event occurs
          $ref: https://schema.nfh.global/StopPoint/v2.0/attributes.yaml#/components/schemas/StopPoint
        id:
          description: Unique identifier for the fulfillment stop
          type: string
        location:
          description: Geographic location of the stop
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
        type:
          description: Type of stop (start, end, intermediate)
          type: string
        instructions:
          description: Instructions for passengers at this stop
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        time:
          description: Expected time window at this stop
          $ref: https://schema.nfh.global/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
      additionalProperties: false