# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Geofencing V8 API
  version: 1.0.0
extends: openapi/here-geofencing-v8-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/v8/geofence'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which geofences contain a point
      effect: read
      questions:
      - Is a given location inside any of my geofence polygons?
      - Can I search both custom layers and core map layers around a point?
      instructions:
      - text: Check which geometries in layers {layers} contain point {point}.
        slots:
          layers: query.layers
          point: query.in
      - text: Find geofences in {layers} around {point} matching filter {filter}.
        slots:
          layers: query.layers
          point: query.in
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/geofence'].post
  update:
    x-apievangelist-phrasing:
      intent: Check geofences for many asset positions
      effect: read
      questions:
      - How do I check many vehicle positions against geofences in one request?
      - Can I send asset points in the body for a geofence search?
      instructions:
      - text: Post a batch of asset positions {points} in the request body and check them against geofences within {spatial}.
        slots:
          points: requestBody.point
          spatial: query.in
      - text: Run a bulk geofence check for asset points {points} in map {map_name}.
        slots:
          points: requestBody.point
          map_name: query.mapName
      method: generated
      generated: '2026-10-02'
- target: $.paths['/v8/geofence/upload'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload geofence geometries from WKT or a shapefile
      effect: write
      questions:
      - How do I upload my own geofence polygons?
      - Can one layer mix polygons and points?
      instructions:
      - text: Upload the WKT file {file} as geofence layer {layer_id}.
        slots:
          file: query.file
          layer_id: query.layerId
      - text: Import geometries {file} into layer {layer_id} and grant access to apps {granted_app_ids}.
        slots:
          file: query.file
          layer_id: query.layerId
          granted_app_ids: query.grantedAppIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/geofence/modify'].post
  update:
    x-apievangelist-phrasing:
      intent: Append, update or delete geometries in a layer
      effect: write
      questions:
      - Can I add new shapes to an existing geofence layer?
      - How long until modified geometries become available?
      instructions:
      - text: Apply {action} to layer {layer_id} with geometries from {file}.
        slots:
          action: query.action
          layer_id: query.layerId
          file: query.file
      - text: Append the geometries in {file} to existing layer {layer_id} using action {action}.
        slots:
          file: query.file
          layer_id: query.layerId
          action: query.action
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/geofence/delete'].get
  update:
    x-apievangelist-phrasing:
      intent: Delete geofence layers or a whole map
      effect: destructive
      questions:
      - How do I delete a geofence layer I uploaded?
      - Can readonly layers be deleted individually?
      instructions:
      - text: Delete geofence layers {layer_id}.
        slots:
          layer_id: query.layerId
      - text: Delete the whole map {layer_id} including all its layers.
        slots:
          layer_id: query.layerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v8/geofence/attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the attributes of my geofence geometries
      effect: read
      questions:
      - Can I list the custom attributes stored on my geofence shapes?
      - Is there a way to page through geometry attributes of a large layer?
      instructions:
      - text: Get the attributes of geometries in layers {layers}.
        slots:
          layers: query.layers
      - text: List geometry attributes in {layers} for tiles {area}, {count} at a time.
        slots:
          layers: query.layers
          area: query.in
          count: query.count
      method: generated
      generated: '2026-09-26'