# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Sensors API
  version: 1.0.0
extends: openapi/microsoft-azure-sensors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors'].get
  update:
    x-apievangelist-phrasing:
      intent: List sensors from a sensor partner
      effect: read
      questions:
      - Which farm sensors has a given sensor partner registered?
      - Can I filter a partner's sensors by device or sensor data model?
      instructions:
      - text: List sensors for sensor partner {partner}.
        slots:
          partner: path.sensorPartnerId
      - text: Show partner {partner} sensors attached to devices {devices}.
        slots:
          partner: path.sensorPartnerId
          devices: query.deviceIds
      - text: List partner {partner} sensors using data model {model}.
        slots:
          partner: path.sensorPartnerId
          model: query.sensorDataModelIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors/{sensorId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sensor
      effect: read
      questions:
      - What are the details of one sensor, like its depth and location?
      - Can I fetch a single sensor by partner and sensor ID?
      instructions:
      - text: Show sensor {sensor} from partner {partner}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      - text: Get the configuration of sensor {sensor} under partner {partner}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors/{sensorId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a sensor
      effect: destructive
      questions:
      - How do I remove a decommissioned sensor from a sensor partner?
      - Can I delete one sensor entity permanently?
      instructions:
      - text: Delete sensor {sensor} from partner {partner}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      - text: Remove decommissioned sensor {sensor} of partner {partner}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors/{sensorId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update a sensor
      effect: write
      questions:
      - How do I register a new soil or weather sensor under a sensor partner?
      - Can I set a sensor's installation depth and hardware ID?
      instructions:
      - text: Create sensor {sensor} for partner {partner} on device {device}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
          device: requestBody.deviceId
      - text: Set sensor {sensor} of partner {partner} to data model {model}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
          model: requestBody.sensorDataModelId
      - text: Record depth {depth} meters for sensor {sensor} under partner {partner}.
        slots:
          depth: requestBody.depthInMeters
          sensor: path.sensorId
          partner: path.sensorPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sensor's connection strings
      effect: read
      questions:
      - Where do I find the connection string a sensor uses to send data?
      - Can I retrieve the primary and secondary connection strings of a sensor?
      instructions:
      - text: Get the connection strings for sensor {sensor} of partner {partner}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      - text: Show how sensor {sensor} under partner {partner} connects.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sensor-partners/{sensorPartnerId}/sensors/{sensorId}/connection-strings/:renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew a sensor's connection string
      effect: write
      questions:
      - How do I rotate a sensor's connection string if it leaked?
      - Can I renew only the secondary connection string of a sensor?
      instructions:
      - text: Renew the {kind} connection string for sensor {sensor} of partner {partner}.
        slots:
          kind: requestBody.connectionStringType
          sensor: path.sensorId
          partner: path.sensorPartnerId
      - text: Rotate sensor {sensor} credentials for partner {partner}, type {kind}.
        slots:
          sensor: path.sensorId
          partner: path.sensorPartnerId
          kind: requestBody.connectionStringType
      method: generated
      generated: '2026-09-26'