# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kinde Permissions API
  version: 1.0.0
extends: openapi/kinde-permissions-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: 5
- target: $.paths['/account_api/v1/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the signed-in user's permissions
      effect: read
      questions:
      - What permissions does the currently logged-in user have?
      - Can my app check the signed-in user's permissions?
      instructions:
      - text: List my permissions.
      - text: Show the current user's permissions, {page_size} at a time.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all defined permissions
      effect: read
      questions:
      - Which permissions are defined across my business?
      - Can I sort the permission list by name?
      instructions:
      - text: List every permission defined in my account.
      - text: Show all permissions sorted by {sort}.
        slots:
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a permission
      effect: write
      questions:
      - How do I define a new permission like create:invoices?
      - Can I give a permission a description when creating it?
      instructions:
      - text: Create a permission {name} with key {key}.
        slots:
          name: requestBody.name
          key: requestBody.key
      - text: Add permission {key} described as {description}.
        slots:
          key: requestBody.key
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/permissions/{permission_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a permission
      effect: destructive
      questions:
      - How do I delete a permission definition?
      - Can I remove a permission that's no longer used?
      instructions:
      - text: Delete permission {permission_id}.
        slots:
          permission_id: path.permission_id
      - text: Remove the permission definition {permission_id}.
        slots:
          permission_id: path.permission_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/permissions/{permission_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a permission
      effect: write
      questions:
      - Can I rename a permission or change its key?
      - How do I edit a permission's description?
      instructions:
      - text: Rename permission {permission_id} to {name}.
        slots:
          permission_id: path.permission_id
          name: requestBody.name
      - text: Change the key of permission {permission_id} to {key}.
        slots:
          permission_id: path.permission_id
          key: requestBody.key
      method: generated
      generated: '2026-09-26'