Aembit · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aembit Cloud Credential Provider Integration API

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

$.info

$.paths['/api/v1/credential-integrations/{id}'].get

$.paths['/api/v1/credential-integrations/{id}'].delete

$.paths['/api/v1/credential-integrations/{id}'].patch

$.paths['/api/v1/credential-integrations'].get

$.paths['/api/v1/credential-integrations'].put

$.paths['/api/v1/credential-integrations'].post

$.paths['/api/v1/credential-integrations/list/{type}'].get

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 Credential Provider Integration API
  version: 1.0.0
extends: openapi/aembit-credential-provider-integration-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: 7
- target: $.paths['/api/v1/credential-integrations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential provider integration
      effect: read
      questions:
      - What does a specific credential provider integration contain?
      - Can I read one credential integration by its ID?
      instructions:
      - text: Show credential provider integration {id}.
        slots:
          id: path.id
      - text: Get the details of credential integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential provider integration
      effect: destructive
      questions:
      - Can I remove a credential provider integration?
      - What is the way to delete a credential integration by ID?
      instructions:
      - text: Delete credential provider integration {id}.
        slots:
          id: path.id
      - text: Remove credential integration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle a credential provider integration
      effect: write
      questions:
      - Can I disable a credential provider integration temporarily?
      - Is it possible to rename a credential integration?
      instructions:
      - text: Deactivate credential provider integration {id}.
        slots:
          id: path.id
      - text: Rename credential integration {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List credential provider integrations
      effect: read
      questions:
      - Which credential provider integrations are set up?
      - Can I filter or sort credential integrations?
      instructions:
      - text: List my credential provider integrations.
      - text: List credential integrations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a credential provider integration
      effect: write
      questions:
      - How do I fully update a credential provider integration?
      - Can I overwrite a credential integration's settings?
      instructions:
      - text: Replace a credential provider integration's definition.
      - text: Overwrite the settings of an existing credential integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credential provider integration
      effect: write
      questions:
      - How do I set up a new credential provider integration?
      - Can I add an integration that credential providers draw from?
      instructions:
      - text: Create a credential provider integration.
      - text: Add a new credential integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/credential-integrations/list/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: List credential integrations of one type
      effect: read
      questions:
      - Which credential integrations of a given type can I choose from?
      - How do I get a simple list of credential integrations by type for a dropdown?
      instructions:
      - text: List credential provider integrations of type {type}.
        slots:
          type: path.type
      - text: Give me the selectable credential integrations for type {type}.
        slots:
          type: path.type
      method: generated
      generated: '2026-09-26'