Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Destinations API

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

$.info
$.paths['/destinations'].get
$.paths['/destinations'].post
$.paths['/destinations/{destinationId}'].get
$.paths['/destinations/{destinationId}'].put
$.paths['/destinations/{destinationId}'].delete
$.paths['/destinations/{destinationId}'].patch

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 Destinations API
  version: 1.0.0
extends: openapi/airbyte-public-destinations-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: 6
- target: $.paths['/destinations'].get
  update:
    x-apievangelist-phrasing:
      intent: List destinations
      effect: read
      questions:
      - How do I list the destinations set up in my workspaces?
      - Can I include deleted destinations when listing them?
      instructions:
      - text: List destinations in workspace {workspaceIds}.
        slots:
          workspaceIds: query.workspaceIds
      - text: List all my destinations, including deleted ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a destination
      effect: write
      questions:
      - How do I create a new destination like a warehouse to send data to?
      - What configuration do I need to supply when setting up a destination?
      instructions:
      - text: Create a destination named {name} in workspace {workspaceId} with configuration {configuration}.
        slots:
          name: requestBody.name
          workspaceId: requestBody.workspaceId
          configuration: requestBody.configuration
      - text: Set up destination {name} in workspace {workspaceId} from connector definition {definitionId} using {configuration}.
        slots:
          name: requestBody.name
          workspaceId: requestBody.workspaceId
          definitionId: requestBody.definitionId
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{destinationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a destination's details
      effect: read
      questions:
      - How do I view the configuration of one destination?
      - Can I see secret coordinates instead of masked values for a destination?
      instructions:
      - text: Get destination {destinationId}.
        slots:
          destinationId: path.destinationId
      - text: Show destination {destinationId} with secret coordinates included.
        slots:
          destinationId: path.destinationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{destinationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Fully overwrite a destination's configuration
      effect: write
      questions:
      - How do I replace a destination's entire configuration rather than patch it?
      - Can I overwrite every field of a destination in one call?
      instructions:
      - text: Overwrite destination {destinationId} with name {name} and full configuration {configuration}.
        slots:
          destinationId: path.destinationId
          name: requestBody.name
          configuration: requestBody.configuration
      - text: Replace all settings of destination {destinationId} with {configuration}, named {name}.
        slots:
          destinationId: path.destinationId
          configuration: requestBody.configuration
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{destinationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a destination
      effect: destructive
      questions:
      - How do I delete a destination I no longer write to?
      - Can I remove a destination from my workspace?
      instructions:
      - text: Delete destination {destinationId}.
        slots:
          destinationId: path.destinationId
      - text: Remove the destination {destinationId}.
        slots:
          destinationId: path.destinationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/destinations/{destinationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update a destination
      effect: write
      questions:
      - How do I change just one setting on a destination, like its name?
      - Can I update only part of a destination's configuration?
      instructions:
      - text: Rename destination {destinationId} to {name}.
        slots:
          destinationId: path.destinationId
          name: requestBody.name
      - text: Patch destination {destinationId} with configuration changes {configuration}.
        slots:
          destinationId: path.destinationId
          configuration: requestBody.configuration
      method: generated
      generated: '2026-09-26'