Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Group Permissions API

4 actions 4 updates phrasing extends openapi/airbyte-public-group-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 4

$.info
$.paths['/groups/{groupId}/permissions'].get
$.paths['/groups/{groupId}/permissions'].post
$.paths['/groups/{groupId}/permissions/{permissionId}'].delete

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 airbyte-api Public Group Permissions API
  version: 1.0.0
extends: openapi/airbyte-public-group-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: 3
- target: $.paths['/groups/{groupId}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a group's permissions
      effect: read
      questions:
      - What permissions does a group have?
      - Which workspaces or organizations can a group's members access?
      instructions:
      - text: List the permissions assigned to group {groupId}.
        slots:
          groupId: path.groupId
      - text: Show what access group {groupId} has been granted.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{groupId}/permissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a permission to a group
      effect: write
      questions:
      - How do I give a whole group access to a workspace?
      - Can I assign an organization-level permission to a group?
      instructions:
      - text: Grant group {groupId} {permissionType} on workspace {workspaceId}.
        slots:
          groupId: path.groupId
          permissionType: requestBody.permissionType
          workspaceId: requestBody.workspaceId
      - text: Give group {groupId} the {permissionType} permission for organization {organizationId}.
        slots:
          groupId: path.groupId
          permissionType: requestBody.permissionType
          organizationId: requestBody.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/groups/{groupId}/permissions/{permissionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a permission from a group
      effect: destructive
      questions:
      - How do I revoke a group's access to a workspace?
      - Can I remove a single permission from a group?
      instructions:
      - text: Remove permission {permissionId} from group {groupId}.
        slots:
          permissionId: path.permissionId
          groupId: path.groupId
      - text: Revoke group {groupId}'s permission {permissionId}.
        slots:
          groupId: path.groupId
          permissionId: path.permissionId
      method: generated
      generated: '2026-09-26'