Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Tags API

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

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/api/tags'].get
$.paths['/api/tags'].post
$.paths['/api/tags/{id}'].get
$.paths['/api/tags/{id}'].put
$.paths['/api/tags/{id}'].delete

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 Kibana Tags API
  version: 1.0.0
extends: openapi/elk-stack-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['/api/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Kibana tags
      effect: read
      questions:
      - What tags have been created in Kibana?
      - Can I search tags by name and page through results?
      instructions:
      - text: List all tags.
      - text: Search tags for {query}.
        slots:
          query: query.query
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag for organizing dashboards?
      - Can I pick a color when making a tag?
      instructions:
      - text: Create a tag named {name}.
        slots:
          name: requestBody.name
      - text: Create tag {name} with color {color}.
        slots:
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag
      effect: read
      questions:
      - What name and color does a specific tag have?
      - Can I fetch one tag by its ID?
      instructions:
      - text: Show tag {id}.
        slots:
          id: path.id
      - text: Get the details of tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a tag by ID
      effect: write
      questions:
      - Can I rename or recolor a tag I already have?
      - Does upserting a tag create it if the ID doesn't exist?
      instructions:
      - text: Upsert tag {id} with name {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update tag {id} to name {name} and color {color}.
        slots:
          id: path.id
          name: requestBody.name
          color: requestBody.color
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/tags/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I remove a tag I no longer use?
      - Can a single tag be deleted by ID?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Remove the unused tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'