openapi: 3.1.0
info:
  title: GeofencingZone
  version: 2.0.0
  description: Schema definition for the GeofencingZone 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:
    GeofencingZone:
      x-iri: https://schema.nfh.global/GeofencingZone/v2.0
      type: object
      title: GeofencingZone
      description: A virtual geographic boundary used to define operational areas,
        speed limits, parking rules, or restrictions for shared mobility services.
      x-tags:
        - mobility
        - geosparql
        - schema-org
        - ride-hailing
      properties:
        featureType:
          description: Type of geofencing zone feature (e.g. parking, restricted,
            slow)
          type: string
        geometry:
          description: GeoJSON geometry defining the zone boundary
          $ref: https://schema.nfh.global/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
        rideAllowed:
          description: Whether riding is permitted within this zone
          type: boolean
        rideThroughAllowed:
          description: Whether riding through without stopping is permitted
          type: boolean
        stationParking:
          description: Whether docking at a station is required to end a trip here
          type: boolean
        id:
          description: Unique identifier for the location
          type: string
        descriptor:
          description: Human-readable description of the location
          $ref: https://schema.nfh.global/Descriptor/v2.0/attributes.yaml#/components/schemas/Descriptor
        gps:
          description: GPS coordinates as a latitude,longitude string
          type: string
        address:
          description: Physical address of the location
          $ref: https://schema.nfh.global/Address/v2.0/attributes.yaml#/components/schemas/Address
        city:
          description: City name
          type: string
        country:
          description: ISO 3166-1 alpha-2 country code
          type: string
        geojson:
          description: GeoJSON geometry object representing this location
          $ref: https://schema.nfh.global/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
      additionalProperties: false
