Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Permissions API

6 actions 6 updates phrasing extends openapi/airbyte-public-permissions-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/permissions/{permissionId}'].get

$.paths['/permissions/{permissionId}'].delete

$.paths['/permissions/{permissionId}'].patch

$.paths['/permissions'].get

$.paths['/permissions'].post

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 airbyte-api Public Permissions API
  version: 1.0.0
extends: openapi/airbyte-public-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['/permissions/{permissionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission's details
      effect: read
      questions:
      - How do I look up a single permission by its id?
      - What role and scope does a given permission grant?
      instructions:
      - text: Get permission {permissionId}.
        slots:
          permissionId: path.permissionId
      - text: Show the details of permission {permissionId}.
        slots:
          permissionId: path.permissionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/permissions/{permissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's permission
      effect: destructive
      questions:
      - How do I revoke a user's permission?
      - Can I delete a permission so someone loses access to a workspace?
      instructions:
      - text: Delete permission {permissionId}.
        slots:
          permissionId: path.permissionId
      - text: Revoke the user permission {permissionId}.
        slots:
          permissionId: path.permissionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/permissions/{permissionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a permission's role
      effect: write
      questions:
      - How do I change a user's role on an existing permission?
      - Can I upgrade someone from reader to admin?
      instructions:
      - text: Change permission {permissionId} to {permissionType}.
        slots:
          permissionId: path.permissionId
          permissionType: requestBody.permissionType
      - text: Update the role on permission {permissionId} to {permissionType}.
        slots:
          permissionId: path.permissionId
          permissionType: requestBody.permissionType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's permissions
      effect: read
      questions:
      - What permissions does a particular user have?
      - Can I read another user's permissions within my organization?
      instructions:
      - text: List the permissions for user {userId}.
        slots:
          userId: query.userId
      - text: List user {userId}'s permissions in organization {organizationId}.
        slots:
          userId: query.userId
          organizationId: query.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a permission to a user
      effect: write
      questions:
      - How do I give a user access to a workspace?
      - Can I make a user an organization admin?
      instructions:
      - text: Grant user {userId} {permissionType} on workspace {workspaceId}.
        slots:
          userId: requestBody.userId
          permissionType: requestBody.permissionType
          workspaceId: requestBody.workspaceId
      - text: Give user {userId} the {permissionType} role in organization {organizationId}.
        slots:
          userId: requestBody.userId
          permissionType: requestBody.permissionType
          organizationId: requestBody.organizationId
      method: generated
      generated: '2026-09-26'