openapi: 3.1.0
info:
  title: Route
  version: 2.0.0
  description: Schema definition for the Route 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:
    Route:
      x-iri: https://schema.nfh.global/Route/v2.0
      type: object
      title: Route
      description: The physical or logical path followed by a transport service, defined
        as an ordered sequence of stops or waypoints.
      x-tags:
        - mobility
        - schema-org
        - transmodel-netex
        - ride-hailing
      properties:
        routeId:
          description: Unique identifier for the route
          type: string
        shortName:
          description: Short public-facing name (e.g. 42A)
          type: string
        longName:
          description: Full descriptive name of the route
          type: string
        routeType:
          description: Mode of transport (e.g. BUS, RAIL, TRAM, FERRY)
          type: string
        operatorRef:
          description: Operator providing this route
          $ref: https://schema.nfh.global/Operator/v2.0/attributes.yaml#/components/schemas/Operator
        networkRef:
          description: Network this route belongs to
          $ref: https://schema.nfh.global/Network/v2.0/attributes.yaml#/components/schemas/Network
        id:
          description: Unique identifier for the item
          type: string
        descriptor:
          description: Human-readable description of the item
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        categoryId:
          description: Category code classifying the item
          $ref: https://schema.nfh.global/CategoryCode/v2.1/attributes.yaml#/components/schemas/CategoryCode
        price:
          description: Price specification for this item
          $ref: https://schema.nfh.global/PriceSpecification/v2.1/attributes.yaml#/components/schemas/PriceSpecification
        quantity:
          description: Available quantity of the item
          $ref: https://schema.nfh.global/Quantity/v2.0/attributes.yaml#/components/schemas/Quantity
        tags:
          description: Tags associated with the item
          type: string
      additionalProperties: false