Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Service Identity Namespace API

5 actions 5 updates phrasing extends openapi/adobe-suite-identity-namespace-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 5

$.info
$.paths['/idnamespace/identities'].get
$.paths['/idnamespace/identities'].post
$.paths['/idnamespace/identities/{ID}'].get
$.paths['/idnamespace/identities/{ID}'].put

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 Identity Service Identity Namespace API
  version: 1.0.0
extends: openapi/adobe-suite-identity-namespace-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: 4
- target: $.paths['/idnamespace/identities'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity namespaces
      effect: read
      questions:
      - Which identity namespaces are available to my organization?
      - Can I see both standard and custom namespaces like Email or ECID?
      instructions:
      - text: List identity namespaces for org {org}.
        slots:
          org: header.x-gw-ims-org-id
      - text: Show all identity namespaces we can use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/idnamespace/identities'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom identity namespace
      effect: write
      questions:
      - How do I add a custom identity namespace for a loyalty ID?
      - What identity types can a new namespace be?
      instructions:
      - text: Create namespace {name} with code {code} of type {idType}.
        slots:
          name: requestBody.name
          code: requestBody.code
          idType: requestBody.idType
      - text: Add a custom identity namespace {name} using code {code}.
        slots:
          name: requestBody.name
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/idnamespace/identities/{ID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity namespace
      effect: read
      questions:
      - What code and type does a specific identity namespace have?
      - Can I look up one namespace by its ID?
      instructions:
      - text: Show identity namespace {ns}.
        slots:
          ns: path.ID
      - text: Get the details of namespace {ns}.
        slots:
          ns: path.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/idnamespace/identities/{ID}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an identity namespace
      effect: write
      questions:
      - Can I rename or re-describe an existing custom namespace?
      - What must be sent when updating a namespace?
      instructions:
      - text: Update namespace {ns} to name {name}, code {code}, type {idType}.
        slots:
          ns: path.ID
          name: requestBody.name
          code: requestBody.code
          idType: requestBody.idType
      - text: Change the description of namespace {ns} to {description}.
        slots:
          ns: path.ID
          description: requestBody.description
      method: generated
      generated: '2026-09-26'