Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management APIs API

13 actions 13 updates phrasing extends openapi/kinde-apis-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Kinde's API. It is a proposal applied on top of the contract, not a document Kinde publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info

$.paths['/api/v1/apis'].get

$.paths['/api/v1/apis'].post

$.paths['/api/v1/apis/{api_id}'].get

$.paths['/api/v1/apis/{api_id}'].delete

$.paths['/api/v1/apis/{api_id}/scopes'].get

$.paths['/api/v1/apis/{api_id}/scopes'].post

$.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].get

$.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].delete

$.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].patch

$.paths['/api/v1/apis/{api_id}/applications'].patch

$.paths['/api/v1/apis/{api_id}/applications/{application_id}/scopes/{scope_id}'].post

$.paths['/api/v1/apis/{api_id}/applications/{application_id}/scopes/{scope_id}'].delete

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 Kinde Management APIs API
  version: 1.0.0
extends: openapi/kinde-apis-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: 12
- target: $.paths['/api/v1/apis'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered APIs
      effect: read
      questions:
      - Which APIs have I registered in Kinde?
      - Can I see all my registered APIs sorted by name?
      instructions:
      - text: List all the APIs I've registered.
      - text: Show my registered APIs, expanding {expand}.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new API
      effect: write
      questions:
      - How do I register my backend API so it can receive access tokens?
      - What audience value do I need when registering an API?
      instructions:
      - text: Register a new API named {name} with audience {audience}.
        slots:
          name: requestBody.name
          audience: requestBody.audience
      - text: Add API {name} using {audience} as its token audience.
        slots:
          name: requestBody.name
          audience: requestBody.audience
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a registered API
      effect: read
      questions:
      - Can I view the configuration of one registered API?
      - Where do I find the audience and details of a specific API?
      instructions:
      - text: Show the details of registered API {api_id}.
        slots:
          api_id: path.api_id
      - text: Get the audience configured for API {api_id}.
        slots:
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a registered API
      effect: destructive
      questions:
      - How do I remove an API I registered but no longer need?
      - Can I unregister an API entirely?
      instructions:
      - text: Delete registered API {api_id}.
        slots:
          api_id: path.api_id
      - text: Unregister the API {api_id}.
        slots:
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List an API's scopes
      effect: read
      questions:
      - Which scopes are defined on one of my APIs?
      - Can I list every scope an API exposes?
      instructions:
      - text: List the scopes defined for API {api_id}.
        slots:
          api_id: path.api_id
      - text: Show all scopes on API {api_id}.
        slots:
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/scopes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a scope on an API
      effect: write
      questions:
      - How do I define a new scope like read:orders on my API?
      - Can I add a description when creating an API scope?
      instructions:
      - text: Create scope {key} on API {api_id}.
        slots:
          key: requestBody.key
          api_id: path.api_id
      - text: Add scope {key} to API {api_id} described as {description}.
        slots:
          key: requestBody.key
          api_id: path.api_id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one API scope
      effect: read
      questions:
      - Can I look up a single scope on an API by its ID?
      - What does one particular API scope contain?
      instructions:
      - text: Show scope {scope_id} on API {api_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
      - text: Get the details of API scope {scope_id} for API {api_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API scope
      effect: destructive
      questions:
      - How do I remove a scope I defined on an API?
      - Can I delete an API scope that's no longer used?
      instructions:
      - text: Delete scope {scope_id} from API {api_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
      - text: Remove the scope {scope_id} defined on API {api_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/scopes/{scope_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an API scope's description
      effect: write
      questions:
      - Can I change the description of an existing API scope?
      - What can I edit on a scope after it's created?
      instructions:
      - text: Change the description of scope {scope_id} on API {api_id} to {description}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
          description: requestBody.description
      - text: Update API scope {scope_id} on API {api_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/applications'].patch
  update:
    x-apievangelist-phrasing:
      intent: Authorize applications for an API
      effect: write
      questions:
      - How do I let an application request access tokens for my API?
      - Can I authorize several applications against one API at once?
      instructions:
      - text: Authorize applications {applications} to request tokens for API {api_id}.
        slots:
          applications: requestBody.applications
          api_id: path.api_id
      - text: Update which applications can access API {api_id}.
        slots:
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/applications/{application_id}/scopes/{scope_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a scope to an API application
      effect: write
      questions:
      - Can I grant a specific scope to an application that's authorized for an API?
      - How do I limit an application to certain API scopes?
      instructions:
      - text: Grant scope {scope_id} on API {api_id} to application {application_id}.
        slots:
          scope_id: path.scope_id
          api_id: path.api_id
          application_id: path.application_id
      - text: Add scope {scope_id} to application {application_id} for API {api_id}.
        slots:
          scope_id: path.scope_id
          application_id: path.application_id
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/apis/{api_id}/applications/{application_id}/scopes/{scope_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a scope from an API application
      effect: destructive
      questions:
      - How do I take a scope away from an application's API access?
      - Can I revoke one scope from an application without deauthorizing it?
      instructions:
      - text: Remove scope {scope_id} from application {application_id} on API {api_id}.
        slots:
          scope_id: path.scope_id
          application_id: path.application_id
          api_id: path.api_id
      - text: Revoke application {application_id}'s scope {scope_id} for API {api_id}.
        slots:
          application_id: path.application_id
          scope_id: path.scope_id
          api_id: path.api_id
      method: generated
      generated: '2026-09-26'