openapi: 3.1.0
info:
  title: Pathway
  version: 2.0.0
  description: Schema definition for the Pathway 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:
    Pathway:
      x-iri: https://schema.nfh.global/Pathway/v2.0
      type: object
      title: Pathway
      description: A connection between two points within a transit station (e.g.,
        stairway, elevator, walkway) used for indoor navigation and accessibility
        routing.
      x-tags:
        - mobility
        - geosparql
        - ride-hailing
      properties:
        pathwayId:
          description: Unique identifier for the pathway
          type: string
        fromStopId:
          description: Stop at the start of the pathway
          $ref: https://schema.nfh.global/Stop/v2.0/attributes.yaml#/components/schemas/Stop
        toStopId:
          description: Stop at the end of the pathway
          $ref: https://schema.nfh.global/Stop/v2.0/attributes.yaml#/components/schemas/Stop
        pathwayMode:
          description: Type of pathway (1=walkway, 2=stairs, 3=moving_sidewalk, 4=escalator,
            5=elevator, 6=fare_gate, 7=exit_gate)
          type: string
        isBidirectional:
          description: Whether the pathway can be traversed in both directions
          type: boolean
        length:
          description: Length of the pathway in metres
          type: number
        traversalTime:
          description: Time in seconds to traverse the pathway
          type: number
        id:
          description: Unique identifier for the location
          type: string
        descriptor:
          description: Human-readable description of the location
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        gps:
          description: GPS coordinates as a latitude,longitude string
          type: string
        address:
          description: Physical address of the location
          $ref: https://schema.nfh.global/Address/v2.0/attributes.yaml#/components/schemas/Address
        city:
          description: City name
          type: string
        country:
          description: ISO 3166-1 alpha-2 country code
          type: string
        geojson:
          description: GeoJSON geometry object representing this location
          $ref: https://schema.nfh.global/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
      additionalProperties: false