Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Source Definitions API

6 actions 6 updates phrasing extends openapi/airbyte-public-source-definitions-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['/workspaces/{workspaceId}/definitions/sources'].get

$.paths['/workspaces/{workspaceId}/definitions/sources'].post

$.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].get

$.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].put

$.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].delete

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 Source Definitions API
  version: 1.0.0
extends: openapi/airbyte-public-source-definitions-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['/workspaces/{workspaceId}/definitions/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List a workspace's source definitions
      effect: read
      questions:
      - Which source connector definitions exist in my workspace?
      - How do I see the custom source connectors registered in a workspace?
      instructions:
      - text: List the source definitions in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show all source connector definitions for workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a custom source connector image
      effect: write
      questions:
      - How do I add a custom source connector from my own Docker image?
      - Can I register a source definition with a documentation URL?
      instructions:
      - text: Create source definition {name} in workspace {workspaceId} from image {dockerRepository}:{dockerImageTag}.
        slots:
          name: requestBody.name
          workspaceId: path.workspaceId
          dockerRepository: requestBody.dockerRepository
          dockerImageTag: requestBody.dockerImageTag
      - text: Register custom source {name} in workspace {workspaceId} using repository {dockerRepository} tag {dockerImageTag}, docs at {documentationUrl}.
        slots:
          name: requestBody.name
          workspaceId: path.workspaceId
          dockerRepository: requestBody.dockerRepository
          dockerImageTag: requestBody.dockerImageTag
          documentationUrl: requestBody.documentationUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a source definition
      effect: read
      questions:
      - How do I check which Docker image a source definition uses?
      - What details are stored for a single source definition?
      instructions:
      - text: Get source definition {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      - text: Show the image tag of source definition {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a source definition's name or image tag
      effect: write
      questions:
      - How do I bump the image tag of a custom source connector?
      - Can I rename a source definition I registered?
      instructions:
      - text: Update source definition {definitionId} in workspace {workspaceId} to name {name} and image tag {dockerImageTag}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
          name: requestBody.name
          dockerImageTag: requestBody.dockerImageTag
      - text: Upgrade custom source {definitionId} in workspace {workspaceId} to tag {dockerImageTag}, keeping name {name}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
          dockerImageTag: requestBody.dockerImageTag
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/sources/{definitionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a source definition
      effect: destructive
      questions:
      - How do I delete a custom source connector definition?
      - Can I remove a source definition from my workspace?
      instructions:
      - text: Delete source definition {definitionId} from workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      - text: Remove custom source connector {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'