openapi: 3.1.0
info:
  title: PlanningResult
  version: 2.0.0
  description: Schema definition for the PlanningResult entity in the Beckn Mobility
  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:
    PlanningResult:
      x-iri: https://schema.nfh.global/PlanningResult/v2.0
      type: object
      title: PlanningResult
      description: The output of a MaaS platform planning request, listing available
        transport options for a requested trip.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        origin:
          description: Origin location for the planning query
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
        destination:
          description: Destination location for the planning query
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
        options:
          description: Available transport options returned
          $ref: https://schema.nfh.global/RideOption/v2.0/attributes.yaml#/components/schemas/RideOption
        itineraries:
          description: Multi-modal itinerary options if applicable
          $ref: https://schema.nfh.global/Itinerary/v2.0/attributes.yaml#/components/schemas/Itinerary
        id:
          description: Unique identifier for the catalog
          type: string
        descriptor:
          description: Human-readable description of the catalog
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        tags:
          description: Tags associated with the catalog
          type: string
      additionalProperties: false