# 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 v2 API
  version: 1.0.0
extends: openapi/aembit-credential-provider-v2-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/v2/credential-providers'].get
  update:
    x-apievangelist-phrasing:
      intent: List credential providers
      effect: read
      questions:
      - Which credential providers are configured in my tenant?
      - Can I group or filter credential providers?
      - How do I page through credential providers in one resource set?
      instructions:
      - text: List my credential providers.
      - text: List credential providers matching {filter}.
        slots:
          filter: query.filter
      - text: Show credential providers in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a credential provider
      effect: write
      questions:
      - How do I fully update a credential provider?
      - Can I overwrite a credential provider's definition in a given resource set?
      instructions:
      - text: Replace a credential provider's full definition.
      - text: Update a credential provider in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credential provider
      effect: write
      questions:
      - How do I create a credential provider that issues credentials to workloads?
      - Can I add a credential provider to a specific resource set?
      instructions:
      - text: Create a new credential provider.
      - text: Create a credential provider in resource set {resourceSet}.
        slots:
          resourceSet: header.X-Aembit-ResourceSet
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential provider
      effect: read
      questions:
      - What is configured on a specific credential provider?
      - Can I read one credential provider by its ID?
      instructions:
      - text: Show credential provider {id}.
        slots:
          id: path.id
      - text: Fetch the details of credential provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credential provider
      effect: destructive
      questions:
      - Can I delete a credential provider I no longer use?
      - Is removing a credential provider by ID reversible?
      instructions:
      - text: Delete credential provider {id}.
        slots:
          id: path.id
      - text: Remove the credential provider with ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a credential provider
      effect: write
      questions:
      - Can I change just the type or details of a credential provider?
      - Is it possible to disable a credential provider without deleting it?
      instructions:
      - text: Disable credential provider {id}.
        slots:
          id: path.id
      - text: Change credential provider {id} to type {type}.
        slots:
          id: path.id
          type: requestBody.type
      - text: Update 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/v2/credential-providers/{id}/verification'].get
  update:
    x-apievangelist-phrasing:
      intent: Verify a credential provider
      effect: read
      questions:
      - Will this credential provider successfully return a credential?
      - How do I check a credential provider is configured correctly?
      instructions:
      - text: Verify credential provider {id}.
        slots:
          id: path.id
      - text: Check that credential provider {id} can issue a credential.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/credential-providers/{id}/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a credential provider's authorization URL
      effect: read
      questions:
      - Where does a user go to authorize an OAuth credential provider?
      - How do I get the consent URL for a credential provider?
      instructions:
      - text: Get the authorization URL for credential provider {id}.
        slots:
          id: path.id
      - text: Give me the consent link to authorize credential provider {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'