openapi: 3.1.0
info:
  title: PickupPolicy
  version: 2.0.0
  description: Schema definition for the PickupPolicy 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:
    PickupPolicy:
      x-iri: https://schema.nfh.global/PickupPolicy/v2.0
      type: object
      title: PickupPolicy
      description: A set of rules governing the locations and conditions under which
        passengers may be picked up for a ride-hailing or on-demand transport service.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        allowedPickupAreas:
          description: Geographic areas where pickup is permitted
          $ref: https://schema.nfh.global/Geofence/v2.0/attributes.yaml#/components/schemas/Geofence
        pickupConditions:
          description: Conditions that must be met for a valid pickup
          type: string
        pickupNote:
          description: Customer-facing note about pickup rules
          type: string
        id:
          description: Unique identifier for the policy
          type: string
        policyType:
          description: Type of policy (extensible term)
          type: string
        descriptor:
          description: Human-readable description of the policy
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        validity:
          description: Validity window for this policy version
          $ref: https://schema.nfh.global/TimePeriod/v2.0/attributes.yaml#/components/schemas/TimePeriod
        policyAttributes:
          description: Extensible domain-specific policy attributes
          $ref: https://schema.nfh.global/Attributes/v2.0/attributes.yaml#/components/schemas/Attributes
      additionalProperties: false