openapi: 3.1.0
info:
  title: LocationInformationRequest
  version: 2.0.0
  description: Schema definition for the LocationInformationRequest entity in the
  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:
    LocationInformationRequest:
      x-iri: https://schema.nfh.global/LocationInformationRequest/v2.0
      type: object
      title: LocationInformationRequest
      description: A request for details about a specific geographic location, stop,
        or point of interest in the transport network.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        requestType:
          description: Type of location information requested (e.g. STOP, ADDRESS,
            POI)
          type: string
        locationName:
          description: Name or keyword to search for
          type: string
        coordinates:
          description: Geographic coordinates to query around
          $ref: https://schema.nfh.global/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
        radius:
          description: Search radius in metres
          type: number
        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