Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Trust Provider API

7 actions 7 updates phrasing extends openapi/aembit-trust-provider-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 7

$.info
$.paths['/api/v1/trust-providers'].get
$.paths['/api/v1/trust-providers'].put
$.paths['/api/v1/trust-providers'].post
$.paths['/api/v1/trust-providers/{id}'].get
$.paths['/api/v1/trust-providers/{id}'].delete
$.paths['/api/v1/trust-providers/{id}'].patch

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 Aembit Cloud Trust Provider API
  version: 1.0.0
extends: openapi/aembit-trust-provider-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/v1/trust-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List trust providers
      effect: read
      questions:
      - Which trust providers attest my workloads?
      - Can I list only active trust providers?
      - How do I filter trust providers?
      instructions:
      - text: List my trust providers.
      - text: List trust providers with active set to {active}.
        slots:
          active: query.active
      - text: List trust providers matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a trust provider
      effect: write
      questions:
      - How do I change the match rules on a trust provider?
      - Can I update the OIDC URL of an existing trust provider?
      instructions:
      - text: Update trust provider {name} with match rules {matchRules}.
        slots:
          name: requestBody.name
          matchRules: requestBody.matchRules
      - text: Replace trust provider {name} of type {provider} with OIDC URL {oidcUrl}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
          oidcUrl: requestBody.oidcUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a trust provider
      effect: write
      questions:
      - How do I add a trust provider to verify workload identity?
      - Can I validate workloads with a JWKS or certificate on a new trust provider?
      instructions:
      - text: Create trust provider {name} of type {provider}.
        slots:
          name: requestBody.name
          provider: requestBody.provider
      - text: Create trust provider {name} that verifies tokens against JWKS {jwks}.
        slots:
          name: requestBody.name
          jwks: requestBody.jwks
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a trust provider
      effect: read
      questions:
      - What match rules does a specific trust provider apply?
      - How many agent controllers use a given trust provider?
      instructions:
      - text: Show trust provider {id}.
        slots:
          id: path.id
      - text: Get the match rules of trust provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a trust provider
      effect: destructive
      questions:
      - Can I delete a trust provider no policy uses?
      - What is the call to remove a trust provider by ID?
      instructions:
      - text: Delete trust provider {id}.
        slots:
          id: path.id
      - text: Remove the trust provider with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/trust-providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a trust provider
      effect: write
      questions:
      - Can I rotate the certificate or symmetric key on a trust provider?
      - Is it possible to change only the metadata URL of a trust provider?
      instructions:
      - text: Set the match rules of trust provider {id} to {matchRules}.
        slots:
          id: path.id
          matchRules: requestBody.matchRules
      - text: Replace the certificate on trust provider {id} with {certificate}.
        slots:
          id: path.id
          certificate: requestBody.certificate
      - text: Deactivate trust provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'