Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager Programs API

9 actions 9 updates phrasing extends openapi/adobe-suite-programs-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/programs'].get
$.paths['/api/program/{programId}'].get
$.paths['/api/program/{programId}'].delete
$.paths['/api/program/{programId}/feedbacks'].post
$.paths['/api/program/{programId}/newRelicUsers'].get
$.paths['/api/program/{programId}/newRelicUsers'].patch
$.paths['/api/tenant/{tenantId}/programs'].get
$.paths['/api/tenant/{tenantId}/programs'].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 Programs API
  version: 1.0.0
extends: openapi/adobe-suite-programs-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/programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List programs (deprecated endpoint)
      effect: read
      questions:
      - Is there still an older endpoint that lists all my Cloud Manager programs?
      - What did the deprecated list-programs call return before the tenant version?
      instructions:
      - text: List my programs using the deprecated programs endpoint for org {x-gw-ims-org-id}.
        slots:
          x-gw-ims-org-id: header.x-gw-ims-org-id
      - text: Call the legacy list of all programs without a tenant ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a program by ID
      effect: read
      questions:
      - How do I look up the details of one Adobe Cloud Manager program?
      - Can I read a program's settings if I know its program ID?
      instructions:
      - text: Show me program {programId}.
        slots:
          programId: path.programId
      - text: Get the details of program {programId} in org {x-gw-ims-org-id}.
        slots:
          programId: path.programId
          x-gw-ims-org-id: header.x-gw-ims-org-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a program
      effect: destructive
      questions:
      - How do I delete a program I no longer need?
      - Can a Cloud Manager program be removed through the API?
      instructions:
      - text: Delete program {programId}.
        slots:
          programId: path.programId
      - text: Remove program {programId} from org {x-gw-ims-org-id}.
        slots:
          programId: path.programId
          x-gw-ims-org-id: header.x-gw-ims-org-id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/feedbacks'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit feedback on a program
      effect: write
      questions:
      - How do I leave a rating and comment on a program?
      - What feedback types can I submit for a program?
      instructions:
      - text: Give program {programId} a rating of {rating} as {type} feedback.
        slots:
          programId: path.programId
          rating: requestBody.rating
          type: requestBody.type
      - text: Post {type} feedback on program {programId} rated {rating} with comment {comment}.
        slots:
          type: requestBody.type
          programId: path.programId
          rating: requestBody.rating
          comment: requestBody.comment
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/newRelicUsers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a program's New Relic sub-account users
      effect: read
      questions:
      - Who has access to the New Relic sub-account for my program?
      - How do I see the New Relic users attached to a program?
      instructions:
      - text: List the New Relic sub-account users for program {programId}.
        slots:
          programId: path.programId
      - text: Show who is in program {programId}'s New Relic account.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/newRelicUsers'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add or remove New Relic sub-account users
      effect: write
      questions:
      - How do I add someone to my program's New Relic sub-account?
      - Can I remove New Relic users from a program in the same request?
      instructions:
      - text: Add {email} to the New Relic sub-account for program {programId}.
        slots:
          email: requestBody.email
          programId: path.programId
      - text: Add New Relic user {firstName} {lastName} ({email}) with role {role} to program {programId}.
        slots:
          firstName: requestBody.firstName
          lastName: requestBody.lastName
          email: requestBody.email
          role: requestBody.role
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tenant/{tenantId}/programs'].get
  update:
    x-apievangelist-phrasing:
      intent: List programs for a tenant
      effect: read
      questions:
      - How do I list every program defined for my tenant?
      - Which programs belong to a given tenant ID?
      instructions:
      - text: List all programs for tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      - text: Show the programs in tenant {tenantId}.
        slots:
          tenantId: path.tenantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tenant/{tenantId}/programs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a program for a tenant
      effect: write
      questions:
      - How do I create a new program for my tenant?
      - Can I set a go-live date and solutions when creating a program?
      instructions:
      - text: Create a {type} program named {name} in tenant {tenantId}.
        slots:
          type: requestBody.type
          name: requestBody.name
          tenantId: path.tenantId
      - text: Create program {name} of type {type} in tenant {tenantId} with solutions {solutionNames}.
        slots:
          name: requestBody.name
          type: requestBody.type
          tenantId: path.tenantId
          solutionNames: requestBody.solutionNames
      method: generated
      generated: '2026-09-26'