Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Region Deployments API

5 actions 5 updates phrasing extends openapi/adobe-suite-region-deployments-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 5

$.info

$.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments/{regionDeploymentId}'].get

$.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].get

$.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].post

$.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].patch

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloud Manager Region Deployments API
  version: 1.0.0
extends: openapi/adobe-suite-region-deployments-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: 4
- target: $.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments/{regionDeploymentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one region deployment
      effect: read
      questions:
      - How do I look up a single region deployment of a Cloud Manager environment?
      - Can I check the status of one additional publish region by its ID?
      instructions:
      - text: Get region deployment {regionDeploymentId} in environment {environmentId} of program {programId}.
        slots:
          regionDeploymentId: path.regionDeploymentId
          environmentId: path.environmentId
          programId: path.programId
      - text: Show the status of region deployment {regionDeploymentId} for program {programId}, environment {environmentId}.
        slots:
          regionDeploymentId: path.regionDeploymentId
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an environment's region deployments
      effect: read
      questions:
      - Which regions is my environment deployed to?
      - How do I list all region deployments for an environment?
      instructions:
      - text: List the region deployments for environment {environmentId} in program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: Show every region program {programId} environment {environmentId} runs in.
        slots:
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add region deployments to an environment
      effect: write
      questions:
      - How do I add another region to an environment?
      - Can I deploy an environment into extra regions through the API?
      instructions:
      - text: Add region deployments to environment {environmentId} in program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: Deploy program {programId} environment {environmentId} into the new regions I list.
        slots:
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/regionDeployments'].patch
  update:
    x-apievangelist-phrasing:
      intent: Remove region deployments from an environment
      effect: destructive
      questions:
      - How do I remove a region from an environment?
      - Can I stop running an environment in one of its extra regions?
      instructions:
      - text: Remove region deployments from environment {environmentId} in program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: Take program {programId} environment {environmentId} out of the regions I list.
        slots:
          programId: path.programId
          environmentId: path.environmentId
      method: generated
      generated: '2026-09-26'