Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor App configurations API

7 actions 7 updates phrasing extends openapi/adobe-suite-app-configurations-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 7

$.info
$.paths['/companies/{COMPANY_ID}/app_configurations'].get
$.paths['/companies/{COMPANY_ID}/app_configurations'].post
$.paths['/app_configurations/{CONFIG_ID}'].get
$.paths['/app_configurations/{CONFIG_ID}'].delete
$.paths['/app_configurations/{CONFIG_ID}'].patch
$.paths['/app_configurations/{CONFIG_ID}/company'].get

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 App configurations API
  version: 1.0.0
extends: openapi/adobe-suite-app-configurations-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['/companies/{COMPANY_ID}/app_configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's app configurations
      effect: read
      questions:
      - Which mobile app configurations exist for my company in Tags?
      - Can I filter app configurations by platform or messaging service?
      instructions:
      - text: List app configurations for company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      - text: Show only app configurations on platform {platform} under {COMPANY_ID}.
        slots:
          platform: query.platform
          COMPANY_ID: path.COMPANY_ID
      - text: Find app configurations named {name} in company {COMPANY_ID}.
        slots:
          name: query.name
          COMPANY_ID: path.COMPANY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}/app_configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an app configuration
      effect: write
      questions:
      - How do I add push messaging credentials for a mobile app in Tags?
      - Can I create an app configuration under a company?
      instructions:
      - text: Create an app configuration for company {COMPANY_ID} with {data}.
        slots:
          COMPANY_ID: path.COMPANY_ID
          data: requestBody.data
      - text: Add a new app configuration to company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app_configurations/{CONFIG_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an app configuration
      effect: read
      questions:
      - What settings are stored on a specific app configuration?
      - Can I look up an app configuration by its ID?
      instructions:
      - text: Get app configuration {CONFIG_ID}.
        slots:
          CONFIG_ID: path.CONFIG_ID
      - text: Show the details of app configuration {CONFIG_ID}.
        slots:
          CONFIG_ID: path.CONFIG_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app_configurations/{CONFIG_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app configuration
      effect: destructive
      questions:
      - Can I remove an app configuration we no longer use?
      - What happens when I delete an app configuration?
      instructions:
      - text: Delete app configuration {CONFIG_ID}.
        slots:
          CONFIG_ID: path.CONFIG_ID
      - text: Remove the app configuration {CONFIG_ID} from Tags.
        slots:
          CONFIG_ID: path.CONFIG_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app_configurations/{CONFIG_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an app configuration
      effect: write
      questions:
      - How do I change the credentials or name of an app configuration?
      - Can I edit an existing app configuration in place?
      instructions:
      - text: Update app configuration {CONFIG_ID} with {data}.
        slots:
          CONFIG_ID: path.CONFIG_ID
          data: requestBody.data
      - text: Rename app configuration {CONFIG_ID} as I describe.
        slots:
          CONFIG_ID: path.CONFIG_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/app_configurations/{CONFIG_ID}/company'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the company owning an app configuration
      effect: read
      questions:
      - Which company owns a given app configuration?
      - Can I trace an app configuration back to its company?
      instructions:
      - text: Show the company that owns app configuration {CONFIG_ID}.
        slots:
          CONFIG_ID: path.CONFIG_ID
      - text: Get the owning company for app configuration {CONFIG_ID}.
        slots:
          CONFIG_ID: path.CONFIG_ID
      method: generated
      generated: '2026-09-26'