Airbyte · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for airbyte-api Public Tags API

6 actions 6 updates phrasing extends openapi/airbyte-public-tags-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['/tags'].get
$.paths['/tags'].post
$.paths['/tags/{tagId}'].get
$.paths['/tags/{tagId}'].delete
$.paths['/tags/{tagId}'].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 Tags API
  version: 1.0.0
extends: openapi/airbyte-public-tags-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['/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags
      effect: read
      questions:
      - What tags have been created for organizing connections?
      - How do I list the tags in a specific workspace?
      instructions:
      - text: List all tags.
      - text: List the tags in workspace {workspaceIds}.
        slots:
          workspaceIds: query.workspaceIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a colored tag to label my connections?
      - Can I pick a color for a new tag?
      instructions:
      - text: Create a tag named {name} with color {color} in workspace {workspaceId}.
        slots:
          name: requestBody.name
          color: requestBody.color
          workspaceId: requestBody.workspaceId
      - text: Add a {color} tag called {name} to workspace {workspaceId}.
        slots:
          color: requestBody.color
          name: requestBody.name
          workspaceId: requestBody.workspaceId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{tagId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag
      effect: read
      questions:
      - How do I look up a tag by its id?
      - What name and color does a given tag have?
      instructions:
      - text: Get tag {tagId}.
        slots:
          tagId: path.tagId
      - text: Show the details of tag {tagId}.
        slots:
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I delete a tag I don't use?
      - Can I remove a tag from my workspace?
      instructions:
      - text: Delete tag {tagId}.
        slots:
          tagId: path.tagId
      - text: Remove the tag {tagId}.
        slots:
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{tagId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or recolor a tag
      effect: write
      questions:
      - How do I change the color of an existing tag?
      - Can I rename a tag after creating it?
      instructions:
      - text: Update tag {tagId} to name {name} and color {color}.
        slots:
          tagId: path.tagId
          name: requestBody.name
          color: requestBody.color
      - text: Recolor tag {tagId} to {color}, keeping the name {name}.
        slots:
          tagId: path.tagId
          color: requestBody.color
          name: requestBody.name
      method: generated
      generated: '2026-09-26'