Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Applications API

6 actions 6 updates phrasing extends openapi/airbyte-public-applications-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['/applications'].get
$.paths['/applications'].post
$.paths['/applications/{applicationId}'].get
$.paths['/applications/{applicationId}'].delete
$.paths['/applications/token'].post

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 Applications API
  version: 1.0.0
extends: openapi/airbyte-public-applications-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['/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API applications
      effect: read
      questions:
      - What API applications have I created in Airbyte?
      - Where can I see all the applications that hold my client credentials?
      instructions:
      - text: List all of my API applications.
      - text: Show every application I've registered for API access.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an API application
      effect: write
      questions:
      - How do I create an application to get a client id and secret for the Airbyte API?
      - Can I set up a new named application for a script that calls the API?
      instructions:
      - text: Create an application named {name}.
        slots:
          name: requestBody.name
      - text: Register a new API application called {name} so I get client credentials.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{applicationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's details
      effect: read
      questions:
      - How do I look up the details of one API application?
      - What does a single application record show about its credentials?
      instructions:
      - text: Get the details of application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Show me application {applicationId}.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/{applicationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an API application
      effect: destructive
      questions:
      - How do I delete an application I no longer use?
      - Can I remove an API application so its client credentials stop working?
      instructions:
      - text: Delete application {applicationId}.
        slots:
          applicationId: path.applicationId
      - text: Remove the API application {applicationId} and its credentials.
        slots:
          applicationId: path.applicationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/applications/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange client credentials for an access token
      effect: write
      questions:
      - How do I get an access token from my application's client id and secret?
      - What grant type does the token endpoint use for client credentials?
      instructions:
      - text: Get an access token using client id {client_id} and client secret {client_secret}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      - text: Request a bearer token for application client {client_id} with secret {client_secret}.
        slots:
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      method: generated
      generated: '2026-09-26'