Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Domain API

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

$.info
$.paths['/api/program/{programId}/domains'].get
$.paths['/api/program/{programId}/domains'].post
$.paths['/api/program/{programId}/domain/{domain-id}'].get
$.paths['/api/program/{programId}/domain/{domain-id}'].put
$.paths['/api/program/{programId}/domain/{domain-id}'].delete
$.paths['/api/program/{programId}/domain/{domain-id}/validate'].put
$.paths['/api/program/{programId}/domain/{domain-id}/validation'].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 Cloud Manager Domain API
  version: 1.0.0
extends: openapi/adobe-suite-domain-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: 7
- target: $.paths['/api/program/{programId}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom domains in a Cloud Manager program
      effect: read
      questions:
      - Which custom domains are registered in my Cloud Manager program?
      - Can I list only the domains that have passed TXT or ACME verification?
      instructions:
      - text: List all domains in program {programId}.
        slots:
          programId: path.programId
      - text: Show domains in program {programId} filtered to TXT-verified {isTxt}.
        slots:
          programId: path.programId
          isTxt: query.isTxt
      - text: Search program {programId}'s domain list for {name}.
        slots:
          programId: path.programId
          name: query.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a custom domain to a program
      effect: write
      questions:
      - How do I add a custom domain name to a Cloud Manager program?
      - What's the first step to put my own domain on an AEM program?
      instructions:
      - text: Add domain {domainName} to program {programId}.
        slots:
          domainName: requestBody.domainName
          programId: path.programId
      - text: Register custom domain {domainName} in Cloud Manager program {programId}.
        slots:
          domainName: requestBody.domainName
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain/{domain-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one domain by ID
      effect: read
      questions:
      - What's the verification status of a specific domain by its ID?
      - Can I fetch one domain's details if I know its domain ID?
      instructions:
      - text: Show domain {domainId} in program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      - text: Get the details for domain ID {domainId} of program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain/{domain-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a domain's label
      effect: write
      questions:
      - Can I change the label on a domain I already added?
      - How do I relabel a custom domain in Cloud Manager?
      instructions:
      - text: Set the label of domain {domainId} in program {programId} to {label}.
        slots:
          domainId: path.domain-id
          programId: path.programId
          label: requestBody.label
      - text: Relabel domain {domainId} as {label} in program {programId}.
        slots:
          domainId: path.domain-id
          label: requestBody.label
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain/{domain-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from a program
      effect: destructive
      questions:
      - How do I remove a custom domain from my Cloud Manager program?
      - Can I delete a domain I no longer use?
      instructions:
      - text: Delete domain {domainId} from program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      - text: Remove custom domain {domainId} from Cloud Manager program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain/{domain-id}/validate'].put
  update:
    x-apievangelist-phrasing:
      intent: Run a domain ownership validation check
      effect: write
      questions:
      - After adding my TXT record, how do I tell Cloud Manager to verify the domain?
      - Can I re-run ownership validation for a domain with a specific validation type?
      instructions:
      - text: Check validation of domain {domainId} in program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      - text: Validate domain {domainId} in program {programId} using {validationType} validation.
        slots:
          domainId: path.domain-id
          programId: path.programId
          validationType: requestBody.validationType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain/{domain-id}/validation'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a domain ownership validation token
      effect: write
      questions:
      - Where do I get the token to prove I own a custom domain?
      - Can I generate a new validation token of a particular type for a domain?
      instructions:
      - text: Create a validation token for domain {domainId} in program {programId}.
        slots:
          domainId: path.domain-id
          programId: path.programId
      - text: Generate a {validationType} ownership token for domain {domainId} in {programId}.
        slots:
          validationType: requestBody.validationType
          domainId: path.domain-id
          programId: path.programId
      method: generated
      generated: '2026-09-26'