Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Connections API

7 actions 7 updates phrasing extends openapi/kinde-connections-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 7

$.info

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

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

$.paths['/api/v1/connections/{connection_id}'].get

$.paths['/api/v1/connections/{connection_id}'].put

$.paths['/api/v1/connections/{connection_id}'].delete

$.paths['/api/v1/connections/{connection_id}'].patch

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 Connections API
  version: 1.0.0
extends: openapi/kinde-connections-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: 6
- target: $.paths['/api/v1/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: List authentication connections
      effect: read
      questions:
      - Which authentication connections are set up in my environment?
      - Can I find the connection used for a particular home realm domain?
      instructions:
      - text: List all my authentication connections.
      - text: Show connections for home realm domain {home_realm_domain}.
        slots:
          home_realm_domain: query.home_realm_domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/connections'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an authentication connection
      effect: write
      questions:
      - How do I set up a new enterprise or social sign-in connection?
      - Can I create a connection scoped to one organization?
      instructions:
      - text: Create a {strategy} connection named {name}.
        slots:
          strategy: requestBody.strategy
          name: requestBody.name
      - text: Add connection {display_name} for organization {organization_code}.
        slots:
          display_name: requestBody.display_name
          organization_code: requestBody.organization_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/connections/{connection_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an authentication connection
      effect: read
      questions:
      - Can I view the configuration of a single connection?
      - What strategy and options does a particular connection use?
      instructions:
      - text: Show connection {connection_id}.
        slots:
          connection_id: path.connection_id
      - text: Get the settings for auth connection {connection_id}.
        slots:
          connection_id: path.connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/connections/{connection_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a connection's whole configuration
      effect: write
      questions:
      - How do I replace a connection's entire config in one call?
      - Can I overwrite all of a connection's options rather than patching a few?
      instructions:
      - text: Replace the full configuration of connection {connection_id}.
        slots:
          connection_id: path.connection_id
      - text: Overwrite connection {connection_id} with name {name} and a new option set.
        slots:
          connection_id: path.connection_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/connections/{connection_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an authentication connection
      effect: destructive
      questions:
      - How do I delete a sign-in connection I no longer need?
      - Can I permanently remove an enterprise connection?
      instructions:
      - text: Delete connection {connection_id}.
        slots:
          connection_id: path.connection_id
      - text: Remove auth connection {connection_id} permanently.
        slots:
          connection_id: path.connection_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/connections/{connection_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a connection
      effect: write
      questions:
      - Can I just rename a connection or change its display name?
      - How do I change which applications a connection is enabled for?
      instructions:
      - text: Rename connection {connection_id} to {display_name}.
        slots:
          connection_id: path.connection_id
          display_name: requestBody.display_name
      - text: Enable connection {connection_id} only for applications {enabled_applications}.
        slots:
          connection_id: path.connection_id
          enabled_applications: requestBody.enabled_applications
      method: generated
      generated: '2026-09-26'