# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elation Health Report Internal Notes API
  version: 1.0.0
extends: openapi/elation-health-report-internal-notes-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: 5
- target: $.paths['/api/2.0/reports/{id}/internal_notes/'].get
  update:
    x-apievangelist-phrasing:
      intent: List internal notes on a report
      effect: read
      questions:
      - What internal notes has staff left on a lab or imaging report?
      - Can I see every internal note attached to a report?
      instructions:
      - text: List internal notes on report {id}.
        slots:
          id: path.id
      - text: Show all staff notes on report {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/reports/{id}/internal_notes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an internal note to a report
      effect: write
      questions:
      - How do I add a staff-only note to a report?
      - Can I leave an internal comment on a patient report?
      instructions:
      - text: Add internal note {text} to report {id}.
        slots:
          text: requestBody.text
          id: path.id
      - text: 'Note on report {id} for staff: {text}.'
        slots:
          id: path.id
          text: requestBody.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/reports/{id}/internal_notes/{note_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one internal note on a report
      effect: read
      questions:
      - Can I read a specific internal note on a report?
      - How do I fetch one staff note by its id?
      instructions:
      - text: Get internal note {note_id} on report {id}.
        slots:
          note_id: path.note_id
          id: path.id
      - text: Read note {note_id} from report {id}.
        slots:
          note_id: path.note_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/reports/{id}/internal_notes/{note_id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an internal note from a report
      effect: destructive
      questions:
      - How do I delete an internal note left on a report?
      - Can a staff note on a report be removed?
      instructions:
      - text: Delete internal note {note_id} from report {id}.
        slots:
          note_id: path.note_id
          id: path.id
      - text: Remove staff note {note_id} on report {id}.
        slots:
          note_id: path.note_id
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/reports/{id}/internal_notes/{note_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit an internal note on a report
      effect: write
      questions:
      - Can I edit the text of an internal note on a report?
      - How do I correct a staff note I already left?
      instructions:
      - text: Change internal note {note_id} on report {id} to {text}.
        slots:
          note_id: path.note_id
          id: path.id
          text: requestBody.text
      - text: Edit note {note_id} of report {id} to read {text}.
        slots:
          note_id: path.note_id
          id: path.id
          text: requestBody.text
      method: generated
      generated: '2026-09-26'