Airbyte · OpenAPI Overlay 1.0.0

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

6 actions 6 updates phrasing extends openapi/airbyte-public-declarative-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/declarative_sources'].get

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

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

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

$.paths['/workspaces/{workspaceId}/definitions/declarative_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 Declarative Source Definitions API
  version: 1.0.0
extends: openapi/airbyte-public-declarative-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/declarative_sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List low-code declarative source definitions
      effect: read
      questions:
      - Which low-code declarative sources have been built in my workspace?
      - How do I see the declarative source definitions made with the connector builder?
      instructions:
      - text: List the declarative source definitions in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      - text: Show all low-code sources defined in workspace {workspaceId}.
        slots:
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/declarative_sources'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a declarative source from a manifest
      effect: write
      questions:
      - How do I publish a custom source from a low-code CDK manifest?
      - Can I create a declarative source definition by uploading a manifest?
      instructions:
      - text: Create a declarative source named {name} in workspace {workspaceId} from manifest {manifest}.
        slots:
          name: requestBody.name
          workspaceId: path.workspaceId
          manifest: requestBody.manifest
      - text: Add low-code source {name} to workspace {workspaceId} using manifest {manifest}.
        slots:
          name: requestBody.name
          workspaceId: path.workspaceId
          manifest: requestBody.manifest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/declarative_sources/{definitionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a declarative source definition
      effect: read
      questions:
      - How do I view the manifest behind one declarative source?
      - What does a declarative source definition record contain?
      instructions:
      - text: Get declarative source definition {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      - text: Show the low-code manifest of declarative source {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/declarative_sources/{definitionId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a declarative source's manifest
      effect: write
      questions:
      - How do I push a new manifest version to an existing declarative source?
      - Can I update the low-code manifest of a source I already published?
      instructions:
      - text: Update declarative source {definitionId} in workspace {workspaceId} with manifest {manifest}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
          manifest: requestBody.manifest
      - text: Replace the manifest of low-code source {definitionId} in workspace {workspaceId} with {manifest}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
          manifest: requestBody.manifest
      method: generated
      generated: '2026-09-26'
- target: $.paths['/workspaces/{workspaceId}/definitions/declarative_sources/{definitionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a declarative source definition
      effect: destructive
      questions:
      - How do I delete a low-code source definition I built?
      - Can I remove a declarative source definition from a workspace?
      instructions:
      - text: Delete declarative source definition {definitionId} from workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      - text: Remove low-code source {definitionId} in workspace {workspaceId}.
        slots:
          definitionId: path.definitionId
          workspaceId: path.workspaceId
      method: generated
      generated: '2026-09-26'