Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Trust Provider Secret API

5 actions 5 updates phrasing extends openapi/aembit-trust-provider-secret-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Aembit's API. It is a proposal applied on top of the contract, not a document Aembit publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v1/trust-providers/{tpId}/secrets'].get

$.paths['/api/v1/trust-providers/{tpId}/secrets'].post

$.paths['/api/v1/trust-providers/{tpId}/secrets/{secretId}'].get

$.paths['/api/v1/trust-providers/{tpId}/secrets/{secretId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aembit Cloud Trust Provider Secret API
  version: 1.0.0
extends: openapi/aembit-trust-provider-secret-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['/api/v1/trust-providers/{tpId}/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a trust provider's secrets
      effect: read
      questions:
      - Which secrets are registered on a trust provider?
      - Can I filter a trust provider's secrets?
      instructions:
      - text: List the secrets of trust provider {tpId}.
        slots:
          tpId: path.tpId
      - text: List secrets on trust provider {tpId} matching {filter}.
        slots:
          tpId: path.tpId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{tpId}/secrets'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a secret to a trust provider
      effect: write
      questions:
      - How do I add a new secret to a trust provider?
      - Can I rotate a trust provider's secret by adding another?
      instructions:
      - text: Add secret {secret} to trust provider {tpId}.
        slots:
          tpId: path.tpId
          secret: requestBody.secret
      - text: Create a {type} secret on trust provider {tpId} with value {secret}.
        slots:
          tpId: path.tpId
          type: requestBody.type
          secret: requestBody.secret
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{tpId}/secrets/{secretId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trust provider secret
      effect: read
      questions:
      - What are the details of one secret on a trust provider?
      - Can I read a single trust provider secret by ID?
      instructions:
      - text: Show secret {secretId} of trust provider {tpId}.
        slots:
          tpId: path.tpId
          secretId: path.secretId
      - text: Get trust provider {tpId}'s secret {secretId}.
        slots:
          tpId: path.tpId
          secretId: path.secretId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{tpId}/secrets/{secretId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a trust provider secret
      effect: destructive
      questions:
      - Can I revoke an old secret from a trust provider?
      - What is the call to delete one trust provider secret?
      instructions:
      - text: Delete secret {secretId} from trust provider {tpId}.
        slots:
          tpId: path.tpId
          secretId: path.secretId
      - text: Revoke trust provider {tpId}'s secret {secretId}.
        slots:
          tpId: path.tpId
          secretId: path.secretId
      method: generated
      generated: '2026-09-26'