Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reactor Properties API

25 actions 25 updates phrasing extends openapi/adobe-suite-properties-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 25 · first 16 shown; the file carries all of them

$.info
$.paths['/companies/{COMPANY_ID}/properties'].get
$.paths['/companies/{COMPANY_ID}/properties'].post
$.paths['/properties/{PROPERTY_ID}'].get
$.paths['/properties/{PROPERTY_ID}'].delete
$.paths['/properties/{PROPERTY_ID}'].patch
$.paths['/properties/{PROPERTY_ID}/company'].get
$.paths['/properties/{PROPERTY_ID}/callbacks'].get
$.paths['/properties/{PROPERTY_ID}/callbacks'].post
$.paths['/properties/{PROPERTY_ID}/data_elements'].get
$.paths['/properties/{PROPERTY_ID}/data_elements'].post
$.paths['/properties/{PROPERTY_ID}/environments'].get
$.paths['/properties/{PROPERTY_ID}/environments'].post
$.paths['/properties/{PROPERTY_ID}/extensions'].get
$.paths['/properties/{PROPERTY_ID}/extensions'].post
$.paths['/properties/{PROPERTY_ID}/hosts'].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 Properties API
  version: 1.0.0
extends: openapi/adobe-suite-properties-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: 24
- target: $.paths['/companies/{COMPANY_ID}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's tag properties
      effect: read
      questions:
      - Which tag properties does my company have in Adobe Experience Platform Tags?
      - Can I list only the enabled properties for a particular platform like web or mobile?
      - What tag properties exist under a given company ID?
      instructions:
      - text: List all tag properties for company {company}.
        slots:
          company: path.COMPANY_ID
      - text: Show the {platform} properties in company {company} that are enabled.
        slots:
          platform: query.platform
          company: path.COMPANY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/companies/{COMPANY_ID}/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag property for a company
      effect: write
      questions:
      - How do I set up a new tag property for a website under my company?
      - Can I create a mobile tag property through the Reactor API?
      instructions:
      - text: Create a new tag property in company {company}.
        slots:
          company: path.COMPANY_ID
      - text: 'Add a property to company {company} with these settings: {data}.'
        slots:
          company: path.COMPANY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag property's details
      effect: read
      questions:
      - What settings does a specific tag property have?
      - Where can I see the domains and platform configured on one property?
      instructions:
      - text: Show me the details of tag property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Fetch property {property} so I can check its configuration.
        slots:
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag property
      effect: destructive
      questions:
      - Can I permanently remove a tag property I no longer use?
      - What happens when I delete a property with its rules and libraries?
      instructions:
      - text: Delete tag property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Remove the property {property} from our tags account.
        slots:
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a tag property's settings
      effect: write
      questions:
      - How can I change the name or domains of an existing tag property?
      - Is it possible to edit a property's settings after it has been created?
      instructions:
      - text: Update tag property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: 'Rename property {property} using these attributes: {data}.'
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/company'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the company that owns a property
      effect: read
      questions:
      - Which company does a particular tag property belong to?
      - Can I look up the owning company from a property ID?
      instructions:
      - text: Show the company that owns property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find which company property {property} belongs to.
        slots:
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/callbacks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's callbacks
      effect: read
      questions:
      - What webhook callbacks are registered on my tag property?
      - Can I see which callbacks were created or updated recently on a property?
      instructions:
      - text: List the callbacks on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show callbacks for property {property} updated at {updated_at}.
        slots:
          property: path.PROPERTY_ID
          updated_at: query.updated_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 notified at my own URL when something changes in a tag property?
      - Can I register a webhook callback for build events on a property?
      instructions:
      - text: Create a callback on property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Register a new webhook callback for property {property} using {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/data_elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's data elements
      effect: read
      questions:
      - Which data elements are defined in my tag property?
      - Can I filter data elements by name or by whether they are published?
      instructions:
      - text: List data elements in property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find data elements named {name} in property {property}.
        slots:
          name: query.name
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/data_elements'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data element in a property
      effect: write
      questions:
      - What do I need to create a new data element in a tag property?
      - Can I add a data element that reads a value from the page through the API?
      instructions:
      - text: Create a data element in property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a new data element to property {property} defined as {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's environments
      effect: read
      questions:
      - What development, staging and production environments does my property have?
      - Can I find only the environments in a given stage?
      instructions:
      - text: List the environments for property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show {stage} environments in property {property}.
        slots:
          stage: query.stage
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment for a property
      effect: write
      questions:
      - How do I add a new development environment to a tag property?
      - Does an environment need a host assigned when I create it?
      instructions:
      - text: Create an environment in property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a staging environment to property {property} using {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's installed extensions
      effect: read
      questions:
      - Which extensions are installed on my tag property?
      - Can I check which version of an extension a property is running?
      instructions:
      - text: List extensions installed on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show extensions in property {property} with display name {display_name}.
        slots:
          property: path.PROPERTY_ID
          display_name: query.display_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Install an extension on a property
      effect: write
      questions:
      - How do I install an extension package into a tag property?
      - Can I add an extension to a property programmatically instead of in the UI?
      instructions:
      - text: Install an extension on property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add the extension described by {data} to property {property}.
        slots:
          data: requestBody.data
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/hosts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's hosts
      effect: read
      questions:
      - Where are the library builds for my property hosted?
      - Which hosts are configured for a tag property?
      instructions:
      - text: List the hosts configured on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show hosts named {name} on property {property}.
        slots:
          name: query.name
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/hosts'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a host to a property
      effect: write
      questions:
      - Can I use my own SFTP server as a host for tag library builds?
      - What is needed to add a new host to a property?
      instructions:
      - text: Create a host on property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add an SFTP host to property {property} using {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/libraries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's libraries
      effect: read
      questions:
      - What libraries exist for my tag property and what state are they in?
      - Can I find libraries that are stale or already published?
      instructions:
      - text: List libraries in property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show libraries in property {property} in state {state}.
        slots:
          property: path.PROPERTY_ID
          state: query.state
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/libraries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a library in a property
      effect: write
      questions:
      - How do I start a new library to bundle rule and data element changes?
      - Can I create a tag library through the API before building it?
      instructions:
      - text: Create a library in property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Start a new library for property {property} named in {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's rules
      effect: read
      questions:
      - Which rules are defined in my tag property?
      - Can I find rules that have unpublished changes or are disabled?
      instructions:
      - text: List the rules in property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find rules named {name} in property {property}.
        slots:
          name: query.name
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a rule in a property
      effect: write
      questions:
      - How do I add a new tag rule to a property?
      - Can I create a rule via the API and attach components later?
      instructions:
      - text: Create a rule in property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a new rule to property {property} defined as {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a property's secrets
      effect: read
      questions:
      - What secrets are stored for event forwarding on my property?
      - Can I filter a property's secrets by environment or status?
      instructions:
      - text: List secrets for property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Show secrets in property {property} for environment {environment_id}.
        slots:
          property: path.PROPERTY_ID
          environment_id: query.environment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a secret for a property
      effect: write
      questions:
      - How do I store a credential as a secret for event forwarding?
      - Can I create a token or OAuth secret tied to a property environment?
      instructions:
      - text: Create a secret in property {property} with {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a new secret to property {property} using {data}.
        slots:
          property: path.PROPERTY_ID
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: List notes on a property
      effect: read
      questions:
      - What notes have teammates left on a tag property?
      - Can I search a property's notes for specific text?
      instructions:
      - text: List notes on property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Find notes on property {property} containing {text}.
        slots:
          property: path.PROPERTY_ID
          text: query.text
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to a property
      effect: write
      questions:
      - Can I leave a comment on a tag property for my team?
      - Is there a way to annotate a property with a note through the API?
      instructions:
      - text: Add a note to property {property}.
        slots:
          property: path.PROPERTY_ID
      - text: Leave a note on tag property {property} explaining the latest change.
        slots:
          property: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'