Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Suite Environments API

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

$.info
$.paths['/properties/{PROPERTY_ID}/environments'].get
$.paths['/properties/{PROPERTY_ID}/environments'].post
$.paths['/environments/{ENVIRONMENT_ID}'].get
$.paths['/environments/{ENVIRONMENT_ID}'].delete
$.paths['/environments/{ENVIRONMENT_ID}'].patch
$.paths['/environments/{ENVIRONMENT_ID}/builds'].get
$.paths['/environments/{ENVIRONMENT_ID}/secrets'].get
$.paths['/environments/{ENVIRONMENT_ID}/host'].get
$.paths['/environments/{ENVIRONMENT_ID}/relationships/host'].get
$.paths['/environments/{ENVIRONMENT_ID}/library'].get
$.paths['/environments/{ENVIRONMENT_ID}/property'].get
$.paths['/api/program/{programId}/environments'].get
$.paths['/api/program/{programId}/environments'].post
$.paths['/api/program/{programId}/environment/{environmentId}'].get
$.paths['/api/program/{programId}/environment/{environmentId}'].delete

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 Adobe Suite Environments API
  version: 1.0.0
extends: openapi/adobe-suite-environments-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: 17
- target: $.paths['/properties/{PROPERTY_ID}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a tag property's environments
      effect: read
      questions:
      - Which environments are set up on my Adobe tags property?
      - Can I filter a property's environments by stage, like only production?
      - How do I page through the environments on a tag property?
      instructions:
      - text: List the environments on tag property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      - text: Show the {stage} environments on property {PROPERTY_ID}.
        slots:
          stage: query.stage
          PROPERTY_ID: path.PROPERTY_ID
      - text: Find the environment named {name} on tag property {PROPERTY_ID}.
        slots:
          name: query.name
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/properties/{PROPERTY_ID}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment on a tag property
      effect: write
      questions:
      - How do I add a development, staging or production environment to a tags property?
      - Can I set up a new tag environment linked to a host?
      instructions:
      - text: Create a tag environment on property {PROPERTY_ID} with the attributes {data}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
          data: requestBody.data
      - text: Add a new development environment to tags property {PROPERTY_ID}.
        slots:
          PROPERTY_ID: path.PROPERTY_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a tag environment
      effect: read
      questions:
      - What are the settings of one tags environment?
      - Can I see a tag environment's stage and embed details by its ID?
      instructions:
      - text: Retrieve tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Show me the details of tags environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag environment
      effect: destructive
      questions:
      - How do I remove an environment from a tags property?
      - Can I delete a tag environment I no longer publish to?
      instructions:
      - text: Delete tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Remove tags environment {ENVIRONMENT_ID} from its property.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a tag environment
      effect: write
      questions:
      - Can I rename a tags environment or change its host?
      - What call edits the attributes of an existing tag environment?
      instructions:
      - text: Update tag environment {ENVIRONMENT_ID} with {data}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
          data: requestBody.data
      - text: Rename tags environment {ENVIRONMENT_ID} to the name I give you.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/builds'].get
  update:
    x-apievangelist-phrasing:
      intent: List an environment's builds
      effect: read
      questions:
      - Which library builds have been published to a tag environment?
      - Can I page through the build history of one environment?
      instructions:
      - text: List the builds for tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Show page {page} of builds on environment {ENVIRONMENT_ID}.
        slots:
          page: query.page[number]
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an environment's secrets
      effect: read
      questions:
      - What secrets are stored on a tag environment?
      - Can I list the credentials attached to one environment?
      instructions:
      - text: List the secrets for tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Show {size} secrets per page for environment {ENVIRONMENT_ID}.
        slots:
          size: query.page[size]
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/host'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the host an environment deploys to
      effect: read
      questions:
      - Which host does a tag environment deliver its builds to?
      - Can I see the full host record behind an environment?
      instructions:
      - text: Get the host for tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Show the host details used by environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/relationships/host'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's host relationship link
      effect: read
      questions:
      - What is the host relationship ID on a tag environment, without the full host?
      - Can I read just the relationship reference between an environment and its host?
      instructions:
      - text: Get the host relationship for environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Return only the host relationship reference of tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/library'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the library assigned to an environment
      effect: read
      questions:
      - Which tags library is currently assigned to an environment?
      - Can I see what library sits in my development environment?
      instructions:
      - text: Get the library assigned to tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Show which library environment {ENVIRONMENT_ID} is holding.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{ENVIRONMENT_ID}/property'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the property that owns an environment
      effect: read
      questions:
      - Which tags property does this environment belong to?
      - Can I trace an environment back to its owning property?
      instructions:
      - text: Get the property that owns tag environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      - text: Tell me the parent property of environment {ENVIRONMENT_ID}.
        slots:
          ENVIRONMENT_ID: path.ENVIRONMENT_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Cloud Manager program's environments
      effect: read
      questions:
      - What environments exist in my Cloud Manager program?
      - Can I list only the dev or stage environments of a program?
      instructions:
      - text: List the environments in Cloud Manager program {programId}.
        slots:
          programId: path.programId
      - text: Show the {type} environments in program {programId}.
        slots:
          type: query.type
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or clone a Cloud Manager environment
      effect: write
      questions:
      - How do I add a new AEM environment to a Cloud Manager program?
      - Which region can a new Cloud Manager environment be created in?
      instructions:
      - text: Create a {type} environment named {name} in program {programId} in region {region}.
        slots:
          type: requestBody.type
          name: requestBody.name
          programId: path.programId
          region: requestBody.region
      - text: Add Cloud Manager environment {name} of type {type} to program {programId} in {region}, described as {description}.
        slots:
          name: requestBody.name
          type: requestBody.type
          programId: path.programId
          region: requestBody.region
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud Manager environment
      effect: read
      questions:
      - What are the details of one Cloud Manager environment?
      - Can I check a program environment's type and status by its ID?
      instructions:
      - text: Get environment {environmentId} in Cloud Manager program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: Show the details of program {programId}'s environment {environmentId}.
        slots:
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Cloud Manager environment
      effect: destructive
      questions:
      - How do I delete an AEM environment from a Cloud Manager program?
      - Can the environment delete continue even if some resources fail to be removed?
      instructions:
      - text: Delete environment {environmentId} from Cloud Manager program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: 'Delete program {programId}''s environment {environmentId} ignoring resource deletion failures: {ignore}.'
        slots:
          programId: path.programId
          environmentId: path.environmentId
          ignore: query.ignoreResourcesDeletionResult
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: List available logs for an environment
      effect: read
      questions:
      - Which log files are available for an AEM environment over the last few days?
      - Can I see the logs for a specific service like author or publish?
      instructions:
      - text: List the {name} logs for service {service} in environment {environmentId} of program {programId} for the last {days} days.
        slots:
          name: query.name
          service: query.service
          environmentId: path.environmentId
          programId: path.programId
          days: query.days
      - text: Show which {service} log files exist on environment {environmentId}, program {programId}, over {days} days, log {name}.
        slots:
          service: query.service
          environmentId: path.environmentId
          programId: path.programId
          days: query.days
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/logs/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an environment log for a date
      effect: read
      questions:
      - How do I download a day's log file from a Cloud Manager environment?
      - Can I get the download link for one service log on a specific date?
      instructions:
      - text: Download the {name} log for {service} on {date} from environment {environmentId} in program {programId}.
        slots:
          name: query.name
          service: query.service
          date: query.date
          environmentId: path.environmentId
          programId: path.programId
      - text: Fetch the {date} {service} log file {name} for program {programId}, environment {environmentId}.
        slots:
          date: query.date
          service: query.service
          name: query.name
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'