openapi: 3.1.0
info:
  title: Geofence
  version: 2.0.0
  description: Schema definition for the Geofence entity in the Beckn Mobility domain.
  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:
    Geofence:
      type: object
      title: Geofence
      description: A virtual geographic boundary used to define service areas, restricted
        zones, or operational boundaries for mobility assets.
      x-tags:
        - mobility
        - ride-hailing
      properties:
        geofenceType:
          description: Type of geofence (e.g. SERVICE_AREA, RESTRICTED, SPEED_LIMIT)
          type: string
        geometry:
          description: GeoJSON geometry defining the geofence boundary
          $ref: https://schema.beckn.io/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
        rules:
          description: Operational rules applied within this geofence
          type: string
        id:
          description: Unique identifier for the location
          type: string
        descriptor:
          description: Human-readable description of the location
          $ref: https://schema.beckn.io/core/v2.0/Descriptor/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.beckn.io/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.beckn.io/GeoJSONGeometry/v2.0/attributes.yaml#/components/schemas/GeoJSONGeometry
      additionalProperties: false