Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Dataplanes API

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

$.paths['/dataplanes'].post

$.paths['/dataplanes/{dataplaneId}'].get

$.paths['/dataplanes/{dataplaneId}'].delete

$.paths['/dataplanes/{dataplaneId}'].patch

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 Dataplanes API
  version: 1.0.0
extends: openapi/airbyte-public-dataplanes-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['/dataplanes'].get
  update:
    x-apievangelist-phrasing:
      intent: List dataplanes
      effect: read
      questions:
      - What dataplanes are running in my regions?
      - Can I list only the dataplanes that belong to certain regions?
      instructions:
      - text: List all dataplanes.
      - text: List the dataplanes in region {regionIds}.
        slots:
          regionIds: query.regionIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dataplanes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a dataplane in a region
      effect: write
      questions:
      - How do I add a new dataplane to a region?
      - Can I create a dataplane that starts out disabled?
      instructions:
      - text: Create a dataplane named {name} in region {regionId}.
        slots:
          name: requestBody.name
          regionId: requestBody.regionId
      - text: Add a dataplane called {name} to region {regionId} with enabled set to {enabled}.
        slots:
          name: requestBody.name
          regionId: requestBody.regionId
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dataplanes/{dataplaneId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dataplane
      effect: read
      questions:
      - How do I check the details of one dataplane?
      - Is a particular dataplane enabled?
      instructions:
      - text: Get dataplane {dataplaneId}.
        slots:
          dataplaneId: path.dataplaneId
      - text: Show me the details of dataplane {dataplaneId}.
        slots:
          dataplaneId: path.dataplaneId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dataplanes/{dataplaneId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dataplane
      effect: destructive
      questions:
      - How do I delete a dataplane I've decommissioned?
      - Can I remove a dataplane from its region?
      instructions:
      - text: Delete dataplane {dataplaneId}.
        slots:
          dataplaneId: path.dataplaneId
      - text: Remove the dataplane {dataplaneId}.
        slots:
          dataplaneId: path.dataplaneId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dataplanes/{dataplaneId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or enable/disable a dataplane
      effect: write
      questions:
      - How do I disable an existing dataplane without deleting it?
      - Can I rename a dataplane after it's created?
      instructions:
      - text: Disable dataplane {dataplaneId} by setting enabled to {enabled}.
        slots:
          dataplaneId: path.dataplaneId
          enabled: requestBody.enabled
      - text: Rename dataplane {dataplaneId} to {name}.
        slots:
          dataplaneId: path.dataplaneId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'