openapi: 3.1.0
info:
  title: RideRequest
  version: 2.0.0
  description: Schema definition for the RideRequest 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:
    RideRequest:
      x-iri: https://schema.nfh.global/RideRequest/v2.0
      type: object
      title: RideRequest
      description: A passenger's request for an on-demand transport service between
        two points, specifying origin, destination, and travel preferences.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        origin:
          description: Pickup location for the ride
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
        destination:
          description: Dropoff location for the ride
          $ref: https://schema.nfh.global/Location/v2.0/attributes.yaml#/components/schemas/Location
        requestedTime:
          description: Requested pickup time
          type: string
          format: date-time
        passengerCount:
          description: Number of passengers
          type: number
        vehiclePreference:
          description: Preferred vehicle category
          $ref: https://schema.nfh.global/VehicleCategory/v2.0/attributes.yaml#/components/schemas/VehicleCategory
        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.nfh.global/SpatialConstraint/v2.0/attributes.yaml#/components/schemas/SpatialConstraint
        provider:
          description: Identifier of a specific provider to search within
          type: string
      additionalProperties: false