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.
# 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 Groups API
version: 1.0.0
extends: openapi/airbyte-public-groups-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['/groups'].get
update:
x-apievangelist-phrasing:
intent: List groups in an organization
effect: read
questions:
- What user groups exist in my organization?
- How do I list all the groups for an organization?
instructions:
- text: List the groups in organization {organizationId}.
slots:
organizationId: query.organizationId
- text: Show the first {limit} groups in organization {organizationId}.
slots:
limit: query.limit
organizationId: query.organizationId
method: generated
generated: '2026-09-26'
- target: $.paths['/groups'].post
update:
x-apievangelist-phrasing:
intent: Create a user group
effect: write
questions:
- How do I create a group to manage access for a team?
- Can I add a description when creating a group?
instructions:
- text: Create a group named {name} in organization {organizationId}.
slots:
name: requestBody.name
organizationId: requestBody.organizationId
- text: Create group {name} in organization {organizationId} described as {description}.
slots:
name: requestBody.name
organizationId: requestBody.organizationId
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/groups/{groupId}'].get
update:
x-apievangelist-phrasing:
intent: Get a group's details
effect: read
questions:
- How do I look up one group by its id?
- What name and description does a group have?
instructions:
- text: Get group {groupId}.
slots:
groupId: path.groupId
- text: Show the details of group {groupId}.
slots:
groupId: path.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/groups/{groupId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a group
effect: destructive
questions:
- How do I delete a group entirely?
- Does deleting a group remove all of its memberships?
instructions:
- text: Delete group {groupId}.
slots:
groupId: path.groupId
- text: Delete group {groupId} along with all its memberships.
slots:
groupId: path.groupId
method: generated
generated: '2026-09-26'
- target: $.paths['/groups/{groupId}'].patch
update:
x-apievangelist-phrasing:
intent: Rename or redescribe a group
effect: write
questions:
- How do I rename an existing group?
- Can I change a group's description?
instructions:
- text: Rename group {groupId} to {name}.
slots:
groupId: path.groupId
name: requestBody.name
- text: Change the description of group {groupId} to {description}.
slots:
groupId: path.groupId
description: requestBody.description
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.