Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Organizations API

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

$.info

$.paths['/organizations'].get

$.paths['/organizations/{organizationId}/oauthCredentials'].put

$.paths['/organizations/{organizationId}/oauthCredentials/{actorType}/{name}'].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 Organizations API
  version: 1.0.0
extends: openapi/airbyte-public-organizations-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: 3
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the organizations I belong to
      effect: read
      questions:
      - Which organizations does my user belong to?
      - How do I find my organization ids?
      instructions:
      - text: List all organizations for my user.
      - text: Show the organizations I'm a member of.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/oauthCredentials'].put
  update:
    x-apievangelist-phrasing:
      intent: Set org-wide OAuth override credentials for a connector
      effect: write
      questions:
      - How do I use my own OAuth app credentials for a connector across my whole organization?
      - Can I override the default OAuth credentials for a destination at the organization level?
      instructions:
      - text: Set OAuth override credentials for {actorType} {name} in organization {organizationId} to {configuration}.
        slots:
          actorType: requestBody.actorType
          name: requestBody.name
          organizationId: path.organizationId
          configuration: requestBody.configuration
      - text: Use my own OAuth app {configuration} for {actorType} connector {name} across organization {organizationId}.
        slots:
          configuration: requestBody.configuration
          actorType: requestBody.actorType
          name: requestBody.name
          organizationId: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizations/{organizationId}/oauthCredentials/{actorType}/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove org-wide OAuth override credentials
      effect: destructive
      questions:
      - How do I go back to the default OAuth credentials for a connector in my organization?
      - Can I delete an organization's OAuth override for a source?
      instructions:
      - text: Delete the OAuth override for {actorType} {name} in organization {organizationId}.
        slots:
          actorType: path.actorType
          name: path.name
          organizationId: path.organizationId
      - text: Remove organization {organizationId}'s custom OAuth credentials for {actorType} connector {name}.
        slots:
          organizationId: path.organizationId
          actorType: path.actorType
          name: path.name
      method: generated
      generated: '2026-09-26'