# 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 REST Messaging API
  version: 1.0.0
extends: openapi/elation-health-messaging-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['/message_threads/'].get
  update:
    x-apievangelist-phrasing:
      intent: List secure message threads
      effect: read
      questions:
      - How do I see all the secure message threads in the practice?
      - Can I page through message threads with limit and offset?
      instructions:
      - text: List secure message threads, {limit} per page.
        slots:
          limit: query.limit
      - text: Show the next page of message threads starting at offset {offset}.
        slots:
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a secure message thread
      effect: write
      questions:
      - How do I start a new secure message conversation about a patient?
      - Can I add members and a note when opening a message thread?
      instructions:
      - text: Start a secure thread titled {subject} about patient {patient}.
        slots:
          subject: requestBody.subject
          patient: requestBody.patient
      - text: Open a new thread {subject} with members {members} and note {note}.
        slots:
          subject: requestBody.subject
          members: requestBody.members
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a secure message thread
      effect: read
      questions:
      - How do I open one secure message thread by ID?
      - Who are the members of a particular message thread?
      instructions:
      - text: Retrieve message thread {id}.
        slots:
          id: path.id
      - text: Show the subject and members of thread {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a secure message thread
      effect: write
      questions:
      - How do I overwrite a thread's subject, members and patient in one call?
      - Which call fully replaces a message thread?
      instructions:
      - text: Replace thread {id} with subject {subject}, members {members} and patient {patient}.
        slots:
          id: path.id
          subject: requestBody.subject
          members: requestBody.members
          patient: requestBody.patient
      - text: Overwrite message thread {id} in full with note {note}.
        slots:
          id: path.id
          note: requestBody.note
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a secure message thread
      effect: destructive
      questions:
      - How do I delete a message thread that was opened by mistake?
      - Can I remove a secure conversation from the practice?
      instructions:
      - text: Delete message thread {id}.
        slots:
          id: path.id
      - text: Remove secure conversation {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/message_threads/{id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a secure message thread
      effect: write
      questions:
      - Can I add members to an existing thread with a PATCH?
      - How do I rename a message thread's subject without replacing it?
      instructions:
      - text: Patch thread {id} with subject {subject} and add members {members}.
        slots:
          id: path.id
          subject: requestBody.subject
          members: requestBody.members
      - text: Rename conversation {id} to {subject}.
        slots:
          id: path.id
          subject: requestBody.subject
      method: generated
      generated: '2026-09-26'