openapi: 3.1.0
info:
  title: TripSpecification
  version: 2.0.0
  description: Schema definition for the TripSpecification 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:
    TripSpecification:
      type: object
      title: TripSpecification
      description: A description of the desired journey used as input to search and
        price transport options.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        origin:
          description: Desired origin of the trip
          $ref: https://schema.beckn.io/Location/v2.0/attributes.yaml#/components/schemas/Location
        destination:
          description: Desired destination of the trip
          $ref: https://schema.beckn.io/Location/v2.0/attributes.yaml#/components/schemas/Location
        time:
          description: Desired departure or arrival time
          type: string
          format: date-time
        numTravelers:
          description: Number of travelers for whom to price options
          type: number
        modes:
          description: Preferred transport modes for the trip
          type: string
        textSearch:
          description: Free-text search query expressing what the traveler is looking
            for
          type: string
        filters:
          description: JSONPath filter criteria applied to the search results
          type: string
        spatial:
          description: Geographic constraints on the search area
          $ref: https://schema.beckn.io/SpatialConstraint/v2.0/attributes.yaml#/components/schemas/SpatialConstraint
        provider:
          description: Identifier of a specific provider to search within
          type: string
      additionalProperties: false