Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Callbacks API

6 actions 6 updates phrasing extends openapi/adobe-suite-callbacks-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/properties/{PROPERTY_ID}/callbacks'].get
$.paths['/properties/{PROPERTY_ID}/callbacks'].post
$.paths['/callbacks/{CALLBACK_ID}'].get
$.paths['/callbacks/{CALLBACK_ID}'].delete
$.paths['/callbacks/{CALLBACK_ID}'].patch

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Reactor Callbacks API
  version: 1.0.0
extends: openapi/adobe-suite-callbacks-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['/properties/{PROPERTY_ID}/callbacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's callbacks
      effect: read
      questions:
      - Which callbacks are registered on my tag property?
      - Can I see callbacks created after a certain date?
      instructions:
      - text: List callbacks on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show callbacks on property {property} created at {created_at}.
        slots:
          property: path.PROPERTY_ID
          created_at: query.created_at
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/callbacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a callback on a property
      effect: write
      questions:
      - How do I get a webhook when events happen on a tag property?
      - Can I subscribe my URL to build and publish events?
      instructions:
      - text: Create a callback on property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Register a webhook for property {property} using {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/callbacks/{CALLBACK_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a callback
      effect: read
      questions:
      - What URL and subscriptions does a specific callback have?
      - Can I look up one callback by ID?
      instructions:
      - text: Show callback {callback}.
        slots:
          callback: path.CALLBACK_ID
      - text: Get the details of callback {callback}.
        slots:
          callback: path.CALLBACK_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/callbacks/{CALLBACK_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a callback
      effect: destructive
      questions:
      - Can I stop a callback from receiving notifications by deleting it?
      - Is deleting a callback permanent?
      instructions:
      - text: Delete callback {callback}.
        slots:
          callback: path.CALLBACK_ID
      - text: Remove webhook callback {callback}.
        slots:
          callback: path.CALLBACK_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/callbacks/{CALLBACK_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a callback
      effect: write
      questions:
      - How do I change the URL or subscriptions on an existing callback?
      - Can I edit a callback after registering it?
      instructions:
      - text: Update callback {callback} with {data}.
        slots:
          callback: path.CALLBACK_ID
          data: requestBody.data
      - text: Change the URL of callback {callback} using {data}.
        slots:
          callback: path.CALLBACK_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'