Ada · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for knowledge > tags API

4 actions 4 updates phrasing extends openapi/ada-knowledge-tags-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ada's API. It is a proposal applied on top of the contract, not a document Ada publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/v2/knowledge/tags/'].get
$.paths['/v2/knowledge/tags/{id}'].delete
$.paths['/v2/knowledge/bulk/tags/'].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 knowledge > tags API
  version: 1.0.0
extends: openapi/ada-knowledge-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: 3
- target: $.paths['/v2/knowledge/tags/'].get
  update:
    x-apievangelist-phrasing:
      intent: List article tags
      effect: read
      questions:
      - What tags are available for organizing knowledge articles?
      - Can I get all article tag ids to filter articles with?
      instructions:
      - text: List all article tags.
      - text: Show me every knowledge article tag and its id.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/knowledge/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an article tag
      effect: destructive
      questions:
      - How do I remove an article tag I no longer use?
      - Can I delete a single knowledge tag by its id?
      instructions:
      - text: Delete article tag {id}.
        slots:
          id: path.id
      - text: Remove tag {id} from my knowledge tags.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/knowledge/bulk/tags/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update article tags in bulk
      effect: write
      questions:
      - How do I create several article tags in one request?
      - Does sending a tag with an existing id rename it?
      instructions:
      - text: Upsert this list of article tags.
      - text: Create or update my knowledge tags from this batch.
      method: generated
      generated: '2026-09-26'