Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Visualizations API

6 actions 6 updates phrasing extends openapi/elk-stack-visualizations-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/visualizations'].get

$.paths['/api/visualizations'].post

$.paths['/api/visualizations/{id}'].get

$.paths['/api/visualizations/{id}'].put

$.paths['/api/visualizations/{id}'].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 Kibana Visualizations API
  version: 1.0.0
extends: openapi/elk-stack-visualizations-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/visualizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Search visualizations
      effect: read
      questions:
      - Which saved visualizations exist in Kibana?
      - Can I search my visualizations through the API?
      instructions:
      - text: Search my Kibana visualizations.
      - text: List the saved visualizations available.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/visualizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a visualization
      effect: write
      questions:
      - How do I create a new Kibana visualization programmatically?
      - Can I add a chart to Kibana without using the UI?
      instructions:
      - text: Create a new visualization.
      - text: Add a fresh chart visualization to Kibana.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/visualizations/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a visualization
      effect: read
      questions:
      - Where can I fetch the definition of one visualization?
      - What configuration is stored for a particular visualization?
      instructions:
      - text: Get the visualization by its ID.
      - text: Show the stored configuration of one specific visualization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/visualizations/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a visualization by ID
      effect: write
      questions:
      - Can I create or overwrite a visualization at a known ID in one call?
      - How do I update an existing visualization's definition?
      instructions:
      - text: Upsert the visualization with this ID.
      - text: Overwrite an existing visualization's definition, creating it if missing.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/visualizations/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a visualization
      effect: destructive
      questions:
      - Is there a way to delete a visualization I no longer need?
      - Can I remove a saved visualization through the API?
      instructions:
      - text: Delete the visualization with this ID.
      - text: Remove that saved visualization from Kibana.
      method: generated
      generated: '2026-09-26'