Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Companies API

7 actions 7 updates phrasing extends openapi/adobe-suite-companies-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'].get
$.paths['/companies/{COMPANY_ID}'].get
$.paths['/companies/{COMPANY_ID}/properties'].get
$.paths['/companies/{COMPANY_ID}/properties'].post
$.paths['/companies/{COMPANY_ID}/app_configurations'].get
$.paths['/companies/{COMPANY_ID}/app_configurations'].post

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 Companies API
  version: 1.0.0
extends: openapi/adobe-suite-companies-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag companies
      effect: read
      questions:
      - Which companies can I access in Experience Platform Tags?
      - Can I filter the company list by name or organization ID?
      instructions:
      - text: List the Tags companies I have access to.
      - text: Find the company named {name}.
        slots:
          name: query.name
      - text: Show companies for organization {org_id}.
        slots:
          org_id: query.org_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tag company
      effect: read
      questions:
      - How do I look up the details of a single Tags company?
      - What does a company record include when fetched by ID?
      instructions:
      - text: Show company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      - text: Get the details of Tags company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's tag properties
      effect: read
      questions:
      - What tag properties does my company have?
      - Can I list only enabled web or mobile properties?
      instructions:
      - text: List the properties of company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      - text: Show {platform} properties in company {COMPANY_ID} where enabled is {enabled}.
        slots:
          platform: query.platform
          COMPANY_ID: path.COMPANY_ID
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag property
      effect: write
      questions:
      - How do I create a new web or mobile property in Tags?
      - What goes in the payload when defining a property under a company?
      instructions:
      - text: Create a new property under company {COMPANY_ID} with {data}.
        slots:
          COMPANY_ID: path.COMPANY_ID
          data: requestBody.data
      - text: Add a tag property to company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}/app_configurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's app configurations
      effect: read
      questions:
      - Which push messaging app configurations exist for my company?
      - Can I filter app configurations by messaging service or platform?
      instructions:
      - text: List app configurations for company {COMPANY_ID}.
        slots:
          COMPANY_ID: path.COMPANY_ID
      - text: Show {messaging_service} app configurations in company {COMPANY_ID}.
        slots:
          messaging_service: query.messaging_service
          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 register a mobile app configuration for push messaging?
      - What attributes must an app configuration include when created?
      instructions:
      - text: Create an app configuration under company {COMPANY_ID} with {data}.
        slots:
          COMPANY_ID: path.COMPANY_ID
          data: requestBody.data
      - text: Set up a new push messaging app configuration for company {COMPANY_ID} using {data}.
        slots:
          COMPANY_ID: path.COMPANY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'