# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Swetrix Admin Annotations API
  version: 1.0.0
extends: openapi/swetrix-annotations-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: 4
- target: $.paths['/v1/project/annotations/{pid}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's chart annotations
      effect: read
      questions:
      - Which notes have been pinned to dates on my analytics charts?
      - Can I see every chart annotation saved for one Swetrix project?
      instructions:
      - text: List all chart annotations for project {pid}.
        slots:
          pid: path.pid
      - text: Show me the dated notes on the charts of project {pid}.
        slots:
          pid: path.pid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/annotation'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a chart on a specific date
      effect: write
      questions:
      - How do I mark a release date on my traffic chart with a note?
      - Can I add a text annotation to a specific day in a project's analytics?
      instructions:
      - text: Add an annotation to project {pid} on {date} saying {text}.
        slots:
          pid: requestBody.pid
          date: requestBody.date
          text: requestBody.text
      - text: Mark {date} on the charts of project {pid} with the note {text}.
        slots:
          date: requestBody.date
          pid: requestBody.pid
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/annotation'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing annotation's date or text
      effect: write
      questions:
      - Can I fix the wording of a chart annotation I already added?
      - Is it possible to move an existing annotation to a different date?
      instructions:
      - text: Change the text of annotation {id} in project {pid} to {text}.
        slots:
          id: requestBody.id
          pid: requestBody.pid
          text: requestBody.text
      - text: Move existing annotation {id} in project {pid} to {date}.
        slots:
          id: requestBody.id
          pid: requestBody.pid
          date: requestBody.date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/project/annotation/{id}/{pid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an annotation from a project
      effect: destructive
      questions:
      - How do I get rid of a chart annotation I no longer need?
      - What happens to the chart note when I delete an annotation?
      instructions:
      - text: Delete annotation {id} from project {pid}.
        slots:
          id: path.id
          pid: path.pid
      - text: Remove the chart note {id} on project {pid}.
        slots:
          id: path.id
          pid: path.pid
      method: generated
      generated: '2026-09-26'