Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Credential Provider (Deprecated) API

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

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

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 Credential Provider (Deprecated) API
  version: 1.0.0
extends: openapi/aembit-credential-provider-deprecated-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: 8
- target: $.paths['/api/v1/credential-providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential provider (v1)
      effect: read
      questions:
      - What type and lifetime does a credential provider have in the v1 API?
      - Can I fetch one credential provider by ID using the deprecated endpoint?
      instructions:
      - text: Show v1 credential provider {id}.
        slots:
          id: path.id
      - text: Get credential provider {id} from the old v1 API.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential provider (v1)
      effect: destructive
      questions:
      - Can I delete a credential provider through the v1 API?
      - What breaks if I delete a credential provider used by policies?
      instructions:
      - text: Delete v1 credential provider {id}.
        slots:
          id: path.id
      - text: Remove credential provider {id} using the deprecated endpoint.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a credential provider (v1)
      effect: write
      questions:
      - Can I change a credential provider's provider details without a full update in v1?
      - Is it possible to deactivate a credential provider via v1?
      instructions:
      - text: Deactivate v1 credential provider {id}.
        slots:
          id: path.id
      - text: Set the provider details of credential provider {id} to {details}.
        slots:
          id: path.id
          details: requestBody.providerDetailJSON
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers/{id}/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential provider's authorization URL (v1)
      effect: read
      questions:
      - Where do I send a user to authorize an OAuth credential provider in v1?
      - How do I get the consent URL for a credential provider using the old API?
      instructions:
      - text: Get the authorization URL for v1 credential provider {id}.
        slots:
          id: path.id
      - text: Give me the v1 consent link for credential provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List credential providers (v1)
      effect: read
      questions:
      - Which credential providers exist according to the v1 API?
      - Can I filter credential providers in the deprecated list?
      instructions:
      - text: List credential providers with the v1 API.
      - text: List v1 credential providers matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a credential provider (v1)
      effect: write
      questions:
      - How do I fully update a credential provider with the v1 API?
      - Can I change a credential's lifetime with a full v1 update?
      instructions:
      - text: Replace v1 credential provider {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Update credential provider {name} to a lifetime of {seconds} seconds.
        slots:
          name: requestBody.name
          seconds: requestBody.lifetimeTimeSpanSeconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credential provider (v1)
      effect: write
      questions:
      - How do I create a credential provider with the deprecated API?
      - Can I set the credential type and lifetime when creating a v1 credential provider?
      instructions:
      - text: Create v1 credential provider {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      - text: Add a credential provider {name} with details {details} via v1.
        slots:
          name: requestBody.name
          details: requestBody.providerDetailJSON
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-providers/{id}/verification'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a credential provider (v1)
      effect: read
      questions:
      - Will this credential provider actually return a credential, checked through v1?
      - How do I test a credential provider's configuration using the old API?
      instructions:
      - text: Verify v1 credential provider {id}.
        slots:
          id: path.id
      - text: Test whether credential provider {id} returns a credential using v1.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'