# 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 Insights API
  version: 1.0.0
extends: openapi/microsoft-azure-insights-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['/insights/cascade-delete/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a cascade delete job for insights
      effect: read
      questions:
      - How do I check whether an insight cascade delete job has finished?
      - What status does an insights cascade-delete job report?
      instructions:
      - text: Get insight cascade delete job {jobId}.
        slots:
          jobId: path.jobId
      - text: Show the progress of insights deletion job {jobId}.
        slots:
          jobId: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/insights/cascade-delete/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Delete an insight and its dependents via a job
      effect: destructive
      questions:
      - How do I delete an insight along with everything attached to it?
      - Which identifiers does an insight cascade delete need?
      instructions:
      - text: Start cascade delete job {jobId} for insight {insightId} for {resourceType} {resourceId} of party {partyId}, model {modelId}.
        slots:
          jobId: path.jobId
          insightId: query.insightId
          resourceType: query.resourceType
          resourceId: query.resourceId
          partyId: query.partyId
          modelId: query.modelId
      - text: Cascade-delete insight {insightId} and its attachments as job {jobId} (party {partyId}, model {modelId}, {resourceType} {resourceId}).
        slots:
          insightId: query.insightId
          jobId: path.jobId
          partyId: query.partyId
          modelId: query.modelId
          resourceType: query.resourceType
          resourceId: query.resourceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights'].get
  update:
    x-apievangelist-phrasing:
      intent: List insights for a party's resource
      effect: read
      questions:
      - Which insights have been generated for a field or crop resource of a party?
      - Can I filter insights by start date, status or measurement?
      - How many insights can I get back per page?
      instructions:
      - text: List insights for {resourceType} {resourceId} of party {partyId}, model {modelId}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
      - text: List insights for {resourceType} {resourceId} of party {partyId}, model {modelId}, with status {statuses}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
          statuses: query.statuses
      - text: List insights for {resourceType} {resourceId} (party {partyId}, model {modelId}) starting after {minStart}.
        slots:
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
          minStart: query.minInsightStartDateTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an insight for a party's resource
      effect: read
      questions:
      - How can I read one specific insight a model produced?
      - What measurements does a single insight record contain?
      instructions:
      - text: Get insight {insightId} for {resourceType} {resourceId} of party {partyId}, model {modelId}.
        slots:
          insightId: path.insightId
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
      - text: Show the measurements of insight {insightId} for resource {resourceId}, party {partyId}, model {modelId}, type {resourceType}.
        slots:
          insightId: path.insightId
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
          resourceType: path.resourceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an insight
      effect: destructive
      questions:
      - Can I delete one insight without a cascade job?
      - What removes a single insight record?
      instructions:
      - text: Delete insight {insightId} for {resourceType} {resourceId} of party {partyId}, model {modelId}.
        slots:
          insightId: path.insightId
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
      - text: Remove only the single insight record {insightId} from {resourceType} {resourceId}, party {partyId}, model {modelId}.
        slots:
          insightId: path.insightId
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parties/{partyId}/models/{modelId}/resource-types/{resourceType}/resources/{resourceId}/insights/{insightId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Create or update an insight
      effect: write
      questions:
      - How do I store a model's insight against a party's resource?
      - Can I set measurements and a time window on an insight?
      instructions:
      - text: Create or update insight {insightId} for {resourceType} {resourceId} of party {partyId}, model {modelId}.
        slots:
          insightId: path.insightId
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
      - text: Save insight {insightId} on {resourceType} {resourceId} (party {partyId}, model {modelId}) with measurements {measurements}.
        slots:
          insightId: path.insightId
          resourceType: path.resourceType
          resourceId: path.resourceId
          partyId: path.partyId
          modelId: path.modelId
          measurements: requestBody.measurements
      method: generated
      generated: '2026-09-26'