Kinde · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kinde Management Subscribers API

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

$.info
$.paths['/api/v1/subscribers'].get
$.paths['/api/v1/subscribers'].post
$.paths['/api/v1/subscribers/{subscriber_id}'].get

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 Kinde Management Subscribers API
  version: 1.0.0
extends: openapi/kinde-subscribers-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: 3
- target: $.paths['/api/v1/subscribers'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribers
      effect: read
      questions:
      - Who has subscribed to my mailing list?
      - Can I sort subscribers by email address?
      instructions:
      - text: List all subscribers.
      - text: Show subscribers sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/subscribers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a subscriber
      effect: write
      questions:
      - How do I add someone as a subscriber?
      - What details do I need to create a subscriber?
      instructions:
      - text: Add subscriber {first_name} {last_name} with email {email}.
        slots:
          first_name: query.first_name
          last_name: query.last_name
          email: query.email
      - text: Subscribe {email} under the name {first_name} {last_name}.
        slots:
          email: query.email
          first_name: query.first_name
          last_name: query.last_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/subscribers/{subscriber_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a subscriber
      effect: read
      questions:
      - Can I look up one subscriber's record?
      - Where do I see a single subscriber's details?
      instructions:
      - text: Show subscriber {subscriber_id}.
        slots:
          subscriber_id: path.subscriber_id
      - text: Get the record for subscriber {subscriber_id}.
        slots:
          subscriber_id: path.subscriber_id
      method: generated
      generated: '2026-09-26'