# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Settings App API
  version: 1.0.0
extends: openapi/elation-health-app-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: 7
- target: $.paths['/app/subscriptions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List my app's event subscriptions
      effect: read
      questions:
      - Which resource webhooks is my app currently subscribed to?
      - How do I check what change notifications my integration receives?
      instructions:
      - text: List my app's active resource subscriptions.
      - text: Show every webhook subscription my integration holds.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/subscriptions/'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to updates on a resource
      effect: write
      questions:
      - How do I get a webhook when patients or appointments change in Elation?
      - Can I choose which properties trigger a change notification?
      instructions:
      - text: Subscribe to {resource} updates and deliver them to {target}.
        slots:
          resource: requestBody.resource
          target: requestBody.target
      - text: Watch resource {resource} for changes to properties {properties}.
        slots:
          resource: requestBody.resource
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/published_events/'].get
  update:
    x-apievangelist-phrasing:
      intent: List events published to my app
      effect: read
      questions:
      - What change events have been published to my app recently?
      - How do I review the event log my webhook subscriptions produced?
      instructions:
      - text: List the events published to my app.
      - text: Show the published event log for my integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/subscriptions/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unsubscribe from resource updates
      effect: destructive
      questions:
      - How do I stop receiving webhooks for a resource?
      - Can I cancel one of my app's event subscriptions?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Stop the webhook feed for subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/published_events/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one published event
      effect: read
      questions:
      - How do I inspect a single event that was published to my app?
      - Can I see whether a specific published event was processed?
      instructions:
      - text: Get published event {event_id}.
        slots:
          event_id: path.event_id
      - text: Show the payload and processing status of event {event_id}.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/published_events/{event_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Record processing results for an event
      effect: write
      questions:
      - How do I report back that my app processed an event, with status code and timestamp?
      - What must I send to fully record the outcome of a published event?
      instructions:
      - text: Mark event {event_id} processed at {processed_date} with status code {status_code} and error {error_content}.
        slots:
          event_id: path.event_id
          processed_date: requestBody.processed_date
          status_code: requestBody.status_code
          error_content: requestBody.error_content
      - text: Replace the processing record on event {event_id} with a full PUT.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app/published_events/{event_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch the processing status of an event
      effect: write
      questions:
      - Can I set just the error content on a published event that failed?
      - Which call patches one field of an event's delivery outcome?
      instructions:
      - text: Patch event {event_id} with error content {error_content}.
        slots:
          event_id: path.event_id
          error_content: requestBody.error_content
      - text: Set only status code {status_code} on published event {event_id}.
        slots:
          status_code: requestBody.status_code
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'