# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DoiT Annotations API
  version: 1.0.0
extends: openapi/doit-annotations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/analytics/v1/annotations'].get
  update:
    x-apievangelist-phrasing:
      intent: List annotations
      effect: read
      questions:
      - Which notes have been added to our cost reports?
      - Can I filter annotations or sort them?
      instructions:
      - text: List all annotations.
      - text: List annotations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/annotations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an annotation to reports
      effect: write
      questions:
      - How do I mark an event like a migration on my cost charts?
      - Can I attach a note to specific reports at a point in time?
      instructions:
      - text: Add annotation {content} at {timestamp}.
        slots:
          content: requestBody.content
          timestamp: requestBody.timestamp
      - text: Annotate reports {reports} with {content} at {timestamp}.
        slots:
          reports: requestBody.reports
          content: requestBody.content
          timestamp: requestBody.timestamp
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/annotations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an annotation
      effect: read
      questions:
      - How do I read one annotation's text and timestamp?
      - Which reports is a given annotation attached to?
      instructions:
      - text: Get annotation {id}.
        slots:
          id: path.id
      - text: Show the content of annotation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/annotations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an annotation
      effect: destructive
      questions:
      - How do I remove a note from my cost charts?
      - Can I delete an annotation I made by mistake?
      instructions:
      - text: Delete annotation {id}.
        slots:
          id: path.id
      - text: Remove annotation {id} from our reports.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/v1/annotations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing annotation
      effect: write
      questions:
      - How do I fix the text or time on an annotation already added?
      - Can I change which labels an annotation has?
      instructions:
      - text: Change annotation {id} text to {content}.
        slots:
          id: path.id
          content: requestBody.content
      - text: Move annotation {id} to timestamp {timestamp}.
        slots:
          id: path.id
          timestamp: requestBody.timestamp
      method: generated
      generated: '2026-10-01'