Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana Dashboards API

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

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

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

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

$.paths['/api/dashboards/{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 Dashboards API
  version: 1.0.0
extends: openapi/elk-stack-dashboards-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/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Kibana dashboards
      effect: read
      questions:
      - What dashboards do I have in Kibana?
      - Can I search through my dashboards to find the right one?
      instructions:
      - text: Search my Kibana dashboards.
      - text: List the dashboards available in this space.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/dashboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new dashboard
      effect: write
      questions:
      - How do I create a new Kibana dashboard through the API?
      - Can I build a dashboard programmatically and let Kibana assign its ID?
      instructions:
      - text: Create a new Kibana dashboard.
      - text: Make a fresh dashboard with an auto-assigned ID.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/dashboards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dashboard
      effect: read
      questions:
      - How do I fetch the definition of a single dashboard?
      - Where can I read the panels of a specific dashboard?
      instructions:
      - text: Get a specific dashboard by its ID.
      - text: Show me the full definition of one dashboard.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/dashboards/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace a dashboard by ID
      effect: write
      questions:
      - How do I update an existing dashboard or create it if the ID is new?
      - Can I save a dashboard under an ID I choose?
      instructions:
      - text: Upsert the dashboard with the ID I give you.
      - text: Save changes to a dashboard by ID, creating it if it doesn't exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/dashboards/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dashboard
      effect: destructive
      questions:
      - How do I delete a dashboard I no longer need?
      - Can I remove a specific dashboard by its ID?
      instructions:
      - text: Delete the dashboard with the ID I specify.
      - text: Permanently remove one dashboard by its ID.
      method: generated
      generated: '2026-09-26'