Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Verifiable Credentials API

6 actions 6 updates phrasing extends openapi/auth0-verifiable-credentials-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/verifiable-credentials/verification/templates'].get
$.paths['/verifiable-credentials/verification/templates'].post
$.paths['/verifiable-credentials/verification/templates/{id}'].get
$.paths['/verifiable-credentials/verification/templates/{id}'].delete
$.paths['/verifiable-credentials/verification/templates/{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 Auth0 Management Verifiable Credentials API
  version: 1.0.0
extends: openapi/auth0-verifiable-credentials-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/verifiable-credentials/verification/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List verifiable credential templates
      effect: read
      questions:
      - Which verifiable credential verification templates exist in my Auth0 tenant?
      - Can I page through credential templates?
      instructions:
      - text: List my verifiable credential templates.
      - text: Show the next {take} credential verification templates.
        slots:
          take: query.take
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifiable-credentials/verification/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a verifiable credential template
      effect: write
      questions:
      - How do I set up verification for a mobile driver's license style credential?
      - Can I restrict which trusted issuers a credential template accepts?
      instructions:
      - text: Create credential template {name} of type {type} with dialect {dialect}, presentation {presentation} and trusted issuers {well_known_trusted_issuers}.
        slots:
          name: requestBody.name
          type: requestBody.type
          dialect: requestBody.dialect
          presentation: requestBody.presentation
          well_known_trusted_issuers: requestBody.well_known_trusted_issuers
      - text: Add VC template {name}, type {type}, dialect {dialect}, requesting {presentation}, trusting {well_known_trusted_issuers}.
        slots:
          name: requestBody.name
          type: requestBody.type
          dialect: requestBody.dialect
          presentation: requestBody.presentation
          well_known_trusted_issuers: requestBody.well_known_trusted_issuers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifiable-credentials/verification/templates/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a verifiable credential template
      effect: read
      questions:
      - What does one credential template ask the holder to present?
      - Can I fetch a single verifiable credential template by ID?
      instructions:
      - text: Get verifiable credential template {id}.
        slots:
          id: path.id
      - text: Show the presentation and issuers of credential template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifiable-credentials/verification/templates/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a verifiable credential template
      effect: destructive
      questions:
      - Can I delete a credential template I no longer use?
      - What's the way to remove a verifiable credential template?
      instructions:
      - text: Delete verifiable credential template {id}.
        slots:
          id: path.id
      - text: Remove credential template {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/verifiable-credentials/verification/templates/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a verifiable credential template
      effect: write
      questions:
      - How do I change the trusted issuers on an existing credential template?
      - Can I rename a verifiable credential template?
      instructions:
      - text: Rename credential template {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the trusted issuers of credential template {id} to {well_known_trusted_issuers}.
        slots:
          id: path.id
          well_known_trusted_issuers: requestBody.well_known_trusted_issuers
      method: generated
      generated: '2026-10-01'