Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloud Manager SSL Certificates API

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

$.info
$.paths['/api/program/{programId}/certificate/{certificateId}'].get
$.paths['/api/program/{programId}/certificate/{certificateId}'].put
$.paths['/api/program/{programId}/certificate/{certificateId}'].delete
$.paths['/api/program/{programId}/certificates'].get
$.paths['/api/program/{programId}/certificates'].post
$.paths['/api/program/{programId}/dv-certificates'].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 SSL Certificates API
  version: 1.0.0
extends: openapi/adobe-suite-ssl-certificates-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: 6
- target: $.paths['/api/program/{programId}/certificate/{certificateId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSL certificate in a program
      effect: read
      questions:
      - How do I look up one SSL certificate in my Cloud Manager program?
      - Can I check the details of a certificate by its ID?
      instructions:
      - text: Show certificate {certificateId} in program {programId}.
        slots:
          certificateId: path.certificateId
          programId: path.programId
      - text: Get SSL certificate {certificateId} for program {programId}.
        slots:
          certificateId: path.certificateId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/certificate/{certificateId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SSL certificate
      effect: write
      questions:
      - How do I replace an expiring certificate with a renewed one?
      - What PEM files do I need to update an existing SSL certificate?
      instructions:
      - text: Update certificate {certificateId} in program {programId} with name {name}, certificate {certificate}, key {privateKey} and chain {chain}.
        slots:
          certificateId: path.certificateId
          programId: path.programId
          name: requestBody.name
          certificate: requestBody.certificate
          privateKey: requestBody.privateKey
          chain: requestBody.chain
      - text: Renew certificate {certificateId} in {programId} with the new PEM files.
        slots:
          certificateId: path.certificateId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/certificate/{certificateId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSL certificate
      effect: destructive
      questions:
      - How do I remove an SSL certificate from a program?
      - Can I delete a certificate I no longer use?
      instructions:
      - text: Delete certificate {certificateId} from program {programId}.
        slots:
          certificateId: path.certificateId
          programId: path.programId
      - text: Remove SSL certificate {certificateId} in {programId}.
        slots:
          certificateId: path.certificateId
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/certificates'].get
  update:
    x-apievangelist-phrasing:
      intent: List SSL certificates in a program
      effect: read
      questions:
      - How do I list all SSL certificates for my program?
      - Can I filter certificates by status or type?
      instructions:
      - text: List certificates in program {programId}.
        slots:
          programId: path.programId
      - text: List {status} certificates of type {sslCertificateType} in {programId}.
        slots:
          status: query.status
          sslCertificateType: query.sslCertificateType
          programId: path.programId
      - text: Find certificates named {name} in program {programId}.
        slots:
          name: query.name
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a customer-managed SSL certificate
      effect: write
      questions:
      - How do I upload my own SSL certificate to a Cloud Manager program?
      - What do I need to provide to add a customer-managed certificate?
      instructions:
      - text: Add certificate {name} to program {programId} with cert {certificate}, key {privateKey} and chain {chain}.
        slots:
          name: requestBody.name
          programId: path.programId
          certificate: requestBody.certificate
          privateKey: requestBody.privateKey
          chain: requestBody.chain
      - text: Upload my own SSL certificate to program {programId}.
        slots:
          programId: path.programId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/program/{programId}/dv-certificates'].post
  update:
    x-apievangelist-phrasing:
      intent: Request a domain-validated certificate
      effect: write
      questions:
      - Can Adobe issue a domain-validated certificate for my domains instead of me uploading one?
      - How do I create a DV certificate covering several domains?
      instructions:
      - text: Create a DV certificate for domains {domainIds} in program {programId}.
        slots:
          domainIds: requestBody.domainIds
          programId: path.programId
      - text: Request DV certificate {name} for domains {domainIds} in {programId}.
        slots:
          name: requestBody.name
          domainIds: requestBody.domainIds
          programId: path.programId
      method: generated
      generated: '2026-09-26'