Airbyte · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for airbyte-api Public Sources API
8 actions
8 updates
phrasing
extends
openapi/airbyte-public-sources-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/sources'].get
$.paths['/sources'].post
$.paths['/sources/{sourceId}'].get
$.paths['/sources/{sourceId}'].put
$.paths['/sources/{sourceId}'].delete
$.paths['/sources/{sourceId}'].patch
$.paths['/sources/initiateOAuth'].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 Sources API
version: 1.0.0
extends: openapi/airbyte-public-sources-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: 7
- target: $.paths['/sources'].get
update:
x-apievangelist-phrasing:
intent: List sources
effect: read
questions:
- How do I list the sources set up in my workspaces?
- Can I include deleted sources when listing them?
instructions:
- text: List sources in workspace {workspaceIds}.
slots:
workspaceIds: query.workspaceIds
- text: List all my sources, including deleted ones.
method: generated
generated: '2026-09-26'
- target: $.paths['/sources'].post
update:
x-apievangelist-phrasing:
intent: Create a source
effect: write
questions:
- How do I create a new source to pull data from, like a database or app?
- Can I create a source using the secret id from the OAuth redirect flow?
instructions:
- text: Create a source named {name} in workspace {workspaceId} with configuration {configuration}.
slots:
name: requestBody.name
workspaceId: requestBody.workspaceId
configuration: requestBody.configuration
- text: Create source {name} in workspace {workspaceId} using OAuth secret {secretId} and configuration {configuration}.
slots:
name: requestBody.name
workspaceId: requestBody.workspaceId
secretId: requestBody.secretId
configuration: requestBody.configuration
method: generated
generated: '2026-09-26'
- target: $.paths['/sources/{sourceId}'].get
update:
x-apievangelist-phrasing:
intent: Get a source's details
effect: read
questions:
- How do I view the configuration of one source?
- Can I see secret coordinates instead of masked values for a source?
instructions:
- text: Get source {sourceId}.
slots:
sourceId: path.sourceId
- text: Show source {sourceId} with secret coordinates included.
slots:
sourceId: path.sourceId
method: generated
generated: '2026-09-26'
- target: $.paths['/sources/{sourceId}'].put
update:
x-apievangelist-phrasing:
intent: Fully overwrite a source's configuration
effect: write
questions:
- How do I replace a source's entire configuration rather than patch it?
- Can I overwrite every field of a source in one call?
instructions:
- text: Overwrite source {sourceId} with name {name} and full configuration {configuration}.
slots:
sourceId: path.sourceId
name: requestBody.name
configuration: requestBody.configuration
- text: Replace all settings of source {sourceId} with {configuration}, named {name}.
slots:
sourceId: path.sourceId
configuration: requestBody.configuration
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/sources/{sourceId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a source
effect: destructive
questions:
- How do I delete a source I no longer pull from?
- Can I remove a source from my workspace?
instructions:
- text: Delete source {sourceId}.
slots:
sourceId: path.sourceId
- text: Remove the source {sourceId}.
slots:
sourceId: path.sourceId
method: generated
generated: '2026-09-26'
- target: $.paths['/sources/{sourceId}'].patch
update:
x-apievangelist-phrasing:
intent: Partially update a source
effect: write
questions:
- How do I change just one setting on a source, like its name?
- Can I move a source to a different workspace?
instructions:
- text: Rename source {sourceId} to {name}.
slots:
sourceId: path.sourceId
name: requestBody.name
- text: Move source {sourceId} to workspace {workspaceId}.
slots:
sourceId: path.sourceId
workspaceId: requestBody.workspaceId
- text: Patch source {sourceId} with configuration changes {configuration}.
slots:
sourceId: path.sourceId
configuration: requestBody.configuration
method: generated
generated: '2026-09-26'
- target: $.paths['/sources/initiateOAuth'].post
update:
x-apievangelist-phrasing:
intent: Start OAuth sign-in for a source
effect: write
questions:
- How do I get the URL a user visits to authorize a source with OAuth?
- Can I request custom OAuth scopes when starting a source's authorization?
instructions:
- text: Start OAuth for a {sourceType} source in workspace {workspaceId}, redirecting to {redirectUrl}.
slots:
sourceType: requestBody.sourceType
workspaceId: requestBody.workspaceId
redirectUrl: requestBody.redirectUrl
- text: Get an OAuth consent URL for {sourceType} in workspace {workspaceId} with scopes {requestedScopes}, returning to {redirectUrl}.
slots:
sourceType: requestBody.sourceType
workspaceId: requestBody.workspaceId
requestedScopes: requestBody.requestedScopes
redirectUrl: requestBody.redirectUrl
method: generated
generated: '2026-09-26'