Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Domain Mappings - CDN Configurations API

9 actions 9 updates phrasing extends openapi/adobe-suite-domain-mappings-cdn-configurations-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 9

$.info
$.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].get
$.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].put
$.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].delete
$.paths['/api/program/{programId}/domain-mapping/{domainMappingId}/verify'].put
$.paths['/api/program/{programId}/domain-mappings'].get
$.paths['/api/program/{programId}/domain-mappings'].post
$.paths['/api/program/{programId}/environment/{environmentId}/domain-mappings'].get
$.paths['/api/program/{programId}/site/{siteId}/domain-mappings'].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 Cloud Manager Domain Mappings - CDN Configurations API
  version: 1.0.0
extends: openapi/adobe-suite-domain-mappings-cdn-configurations-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: 8
- target: $.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain mapping
      effect: read
      questions:
      - How is a particular custom domain mapped to its CDN origin in my Cloud Manager program?
      - What certificate and tier does one domain mapping use?
      instructions:
      - text: Show domain mapping {domainMappingId} in program {programId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
      - text: Get the CDN configuration {domainMappingId} for program {programId} in org {org}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
          org: header.x-gw-ims-org-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a domain mapping's certificate or tier
      effect: write
      questions:
      - How do I swap the SSL certificate on an existing domain mapping?
      - Can I change which tier a domain mapping points at?
      instructions:
      - text: Update domain mapping {domainMappingId} in program {programId} to use certificate {certificateId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
          certificateId: requestBody.certificateId
      - text: Move domain mapping {domainMappingId} in program {programId} to tier {tier} with certificate {certificateId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
          tier: requestBody.tier
          certificateId: requestBody.certificateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain-mapping/{domainMappingId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a domain mapping
      effect: destructive
      questions:
      - How do I remove a custom domain's CDN configuration from a program?
      - What happens to traffic when I delete a domain mapping?
      instructions:
      - text: Delete domain mapping {domainMappingId} from program {programId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
      - text: Remove the CDN configuration {domainMappingId} in program {programId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain-mapping/{domainMappingId}/verify'].put
  update:
    x-apievangelist-phrasing:
      intent: Verify DNS changes for a domain mapping
      effect: write
      questions:
      - How can I check whether the DNS records for my custom domain are set up correctly?
      - Has my domain's DNS been changed enough to start routing traffic?
      instructions:
      - text: Verify the DNS setup for domain mapping {domainMappingId} in program {programId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
      - text: Check whether DNS changes are in place for mapping {domainMappingId} of program {programId}.
        slots:
          domainMappingId: path.domainMappingId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain mappings in a program
      effect: read
      questions:
      - Which custom domains are mapped to CDN origins across my whole program?
      - Can I filter a program's domain mappings by status or certificate?
      instructions:
      - text: List all domain mappings in program {programId}.
        slots:
          programId: path.programId
      - text: List domain mappings in program {programId} with status {status}.
        slots:
          programId: path.programId
          status: query.status
      - text: Find the domain mappings in program {programId} that use certificate {certificateId}.
        slots:
          programId: path.programId
          certificateId: query.certificateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/domain-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a domain mapping (CDN configuration)
      effect: write
      questions:
      - How do I point a custom domain at an environment or site through the CDN?
      - What do I need, like a domain, certificate and origin, to create a CDN configuration?
      instructions:
      - text: Map domain {domainId} to origin {originId} in program {programId} using certificate {certificateId} on tier {tier}.
        slots:
          domainId: requestBody.domainId
          originId: requestBody.originId
          programId: path.programId
          certificateId: requestBody.certificateId
          tier: requestBody.tier
      - text: Create a CDN configuration in program {programId} for domain {domainId} with origin type {originType}.
        slots:
          programId: path.programId
          domainId: requestBody.domainId
          originType: requestBody.originType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/environment/{environmentId}/domain-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain mappings for an environment
      effect: read
      questions:
      - Which custom domains route to a specific environment?
      - Can I see only the domain mappings for my production environment?
      instructions:
      - text: List domain mappings for environment {environmentId} in program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      - text: Show which domains point at environment {environmentId} of program {programId}.
        slots:
          environmentId: path.environmentId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/site/{siteId}/domain-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List domain mappings for an EDS site
      effect: read
      questions:
      - Which custom domains are mapped to a particular Edge Delivery Services site?
      - Can I list domain mappings scoped to one EDS site?
      instructions:
      - text: List domain mappings for EDS site {siteId} in program {programId}.
        slots:
          siteId: path.siteId
          programId: path.programId
      - text: Show the domains routed to site {siteId} in program {programId}.
        slots:
          siteId: path.siteId
          programId: path.programId
      method: generated
      generated: '2026-09-26'