# 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 Event Subscriptions API
  version: 1.0.0
extends: openapi/elation-health-event-subscriptions-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: 16
- target: $.paths['/api/2.0/app/published_events/'].get
  update:
    x-apievangelist-phrasing:
      intent: List events published to my app
      effect: read
      questions:
      - Which webhook events has Elation published to my app so far?
      - Can I page through my app's published events and sort them?
      instructions:
      - text: List the events published to my app.
      - text: Show {limit} of my app's published events ordered by {order_by}.
        slots:
          limit: query.limit
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/published_events/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one event published to my app
      effect: read
      questions:
      - What did a single event delivered to my app contain?
      - Can I look up one app published event to see its status code and target?
      instructions:
      - text: Get app published event {event_id}.
        slots:
          event_id: path.event_id
      - text: Show the delivery details of my app's event {event_id}.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/published_events/{event_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an app published event record
      effect: write
      questions:
      - Can I overwrite an event published to my app, including its processed date?
      - What fields must I send to fully replace an app published event?
      instructions:
      - text: Replace app published event {event_id} with processed date {processed_date}.
        slots:
          event_id: path.event_id
          processed_date: requestBody.processed_date
      - text: Overwrite my app's event {event_id} setting status code {status_code} and processed date {processed_date}.
        slots:
          event_id: path.event_id
          status_code: requestBody.status_code
          processed_date: requestBody.processed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/published_events/{event_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch fields on an app published event
      effect: write
      questions:
      - Can I change just the error content on an event sent to my app?
      - Is there a way to partially update one of my app's published events?
      instructions:
      - text: Patch app event {event_id} to record error {error_content}.
        slots:
          event_id: path.event_id
          error_content: requestBody.error_content
      - text: Mark my app's event {event_id} processed on {processed_date}.
        slots:
          event_id: path.event_id
          processed_date: requestBody.processed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/subscriptions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List my app's resource subscriptions
      effect: read
      questions:
      - Which resources is my app currently subscribed to for updates?
      - Can I page through all of my app's webhook subscriptions?
      instructions:
      - text: List my app's subscriptions.
      - text: Show {limit} of my app subscriptions starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/subscriptions/'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe my app to resource updates
      effect: write
      questions:
      - How do I get my app notified when Elation patients or appointments change?
      - What happens if my app subscribes to the same resource and target twice?
      instructions:
      - text: Subscribe my app to {resource} updates delivered to {target}.
        slots:
          resource: requestBody.resource
          target: requestBody.target
      - text: Create an app subscription for {resource} sending to {target} signed with key {signing_pub_key}.
        slots:
          resource: requestBody.resource
          target: requestBody.target
          signing_pub_key: requestBody.signing_pub_key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/subscriptions/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my app's subscriptions
      effect: read
      questions:
      - Can I check which resource and target one of my app subscriptions points at?
      - Where do I see the details of a single app subscription?
      instructions:
      - text: Get app subscription {id}.
        slots:
          id: path.id
      - text: Show the target URL for my app subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/app/subscriptions/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of my app's subscriptions
      effect: destructive
      questions:
      - How do I stop my app receiving updates for a resource?
      - Can I remove an app subscription I no longer need?
      instructions:
      - text: Delete app subscription {id}.
        slots:
          id: path.id
      - text: Unsubscribe my app by removing subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/published_events/'].get
  update:
    x-apievangelist-phrasing:
      intent: List published webhook events
      effect: read
      questions:
      - Which events have been published to my webhook subscriptions?
      - Can I sort the published events feed outside the app namespace?
      instructions:
      - text: List published events.
      - text: Show {limit} published events sorted by {order_by}.
        slots:
          limit: query.limit
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/published_events/{event_id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one published webhook event
      effect: read
      questions:
      - How can I inspect a single published event and the resource it carried?
      - What resource id did a particular published event refer to?
      instructions:
      - text: Get published event {event_id}.
        slots:
          event_id: path.event_id
      - text: Look up the resource behind published event {event_id}.
        slots:
          event_id: path.event_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/published_events/{event_id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a published event record
      effect: write
      questions:
      - Can I fully replace a published event with a new processed date?
      - Which field is required when overwriting a published event?
      instructions:
      - text: Fully overwrite published event {event_id}, marking it processed {processed_date}.
        slots:
          event_id: path.event_id
          processed_date: requestBody.processed_date
      - text: Overwrite published event {event_id} with event type {event_type} processed on {processed_date}.
        slots:
          event_id: path.event_id
          event_type: requestBody.event_type
          processed_date: requestBody.processed_date
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/published_events/{event_id}/'].patch
  update:
    x-apievangelist-phrasing:
      intent: Patch fields on a published event
      effect: write
      questions:
      - Can I update only the status code of a published event?
      - Is partial updating supported for published events?
      instructions:
      - text: Set the status code of published event {event_id} to {status_code}.
        slots:
          event_id: path.event_id
          status_code: requestBody.status_code
      - text: Patch published event {event_id} with error content {error_content}.
        slots:
          event_id: path.event_id
          error_content: requestBody.error_content
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/subscriptions/'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource update subscriptions
      effect: read
      questions:
      - What webhook subscriptions exist outside the app namespace?
      - Can I list subscriptions a page at a time?
      instructions:
      - text: List all subscriptions.
      - text: Show subscriptions ordered by {order_by}.
        slots:
          order_by: query.order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/subscriptions/'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to resource updates
      effect: write
      questions:
      - How do I register a webhook subscription for a resource's updates?
      - Will I get a 409 if I subscribe to the same resource and target again?
      instructions:
      - text: Create a subscription to {resource} delivering to {target}.
        slots:
          resource: requestBody.resource
          target: requestBody.target
      - text: Subscribe {target} to {resource} changes with properties {properties}.
        slots:
          target: requestBody.target
          resource: requestBody.resource
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/subscriptions/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource update subscription
      effect: read
      questions:
      - How do I view a single subscription and its signing key?
      - Can I see when a subscription was created?
      instructions:
      - text: Get subscription {id}.
        slots:
          id: path.id
      - text: Show the resource and target on subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/2.0/subscriptions/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource update subscription
      effect: destructive
      questions:
      - How do I cancel a webhook subscription?
      - Can I delete a subscription so events stop arriving?
      instructions:
      - text: Delete subscription {id}.
        slots:
          id: path.id
      - text: Cancel subscription {id} so it stops sending events.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'