Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Destination Authoring Credentials API

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

$.info
$.paths['/credentials'].get
$.paths['/credentials'].post
$.paths['/credentials/{INSTANCE_ID}'].get
$.paths['/credentials/{INSTANCE_ID}'].put
$.paths['/credentials/{INSTANCE_ID}'].delete

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 Destination Authoring Credentials API
  version: 1.0.0
extends: openapi/adobe-suite-credentials-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: 5
- target: $.paths['/credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List destination credential configurations
      effect: read
      questions:
      - Which credential configurations exist for my destinations?
      - Can I see every credential setup for our IMS organization?
      instructions:
      - text: List all destination credential configurations.
      - text: Show credential configurations in sandbox {sandbox}.
        slots:
          sandbox: header.x-sandbox-name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination credential configuration
      effect: write
      questions:
      - How do I store credentials a destination uses to deliver data?
      - Can I create a basic authentication credential for a destination?
      instructions:
      - text: Create a {type} credential configuration named {name}.
        slots:
          type: requestBody.type
          name: requestBody.name
      - text: Create a basic auth credential with {basicAuthentication}.
        slots:
          basicAuthentication: requestBody.basicAuthentication
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{INSTANCE_ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a destination credential configuration
      effect: read
      questions:
      - How do I look up one credential configuration?
      - Can I see the details of a specific destination credential?
      instructions:
      - text: Show credential configuration {instance}.
        slots:
          instance: path.INSTANCE_ID
      - text: Get the details of destination credential {instance}.
        slots:
          instance: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{INSTANCE_ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a destination credential configuration
      effect: write
      questions:
      - Can I rotate the credentials stored in an existing configuration?
      - How do I change the type or name of a credential configuration?
      instructions:
      - text: Update credential configuration {instance} to type {type}.
        slots:
          instance: path.INSTANCE_ID
          type: requestBody.type
      - text: Replace the basic auth on credential {instance} with {basicAuthentication}.
        slots:
          instance: path.INSTANCE_ID
          basicAuthentication: requestBody.basicAuthentication
      method: generated
      generated: '2026-09-26'
- target: $.paths['/credentials/{INSTANCE_ID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination credential configuration
      effect: destructive
      questions:
      - How do I remove a credential configuration a destination no longer needs?
      - Can I delete one credential configuration by its instance ID?
      instructions:
      - text: Delete credential configuration {instance}.
        slots:
          instance: path.INSTANCE_ID
      - text: Remove destination credential {instance}.
        slots:
          instance: path.INSTANCE_ID
      method: generated
      generated: '2026-09-26'