Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elk Stack Index API

5 actions 5 updates phrasing extends openapi/elk-stack-index-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 5

$.info

$.paths['/{index}'].put

$.paths['/{index}'].delete

$.paths['/{index}/_mapping'].get

$.paths['/{index}/_settings'].put

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 Elk Stack Index API
  version: 1.0.0
extends: openapi/elk-stack-index-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: 4
- target: $.paths['/{index}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an index
      effect: write
      questions:
      - How do I create a new Elasticsearch index?
      - Can I create an index before sending any documents to it?
      instructions:
      - text: Create the index {index}.
        slots:
          index: path.index
      - text: Make a new empty index named {index}.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an index
      effect: destructive
      questions:
      - What removes an index along with all its documents?
      - Is deleting an index permanent?
      instructions:
      - text: Delete the index {index}.
        slots:
          index: path.index
      - text: Permanently drop index {index} and its data.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an index's field mappings
      effect: read
      questions:
      - What fields and types are mapped in an index?
      - Can I see how a particular index maps its documents?
      instructions:
      - text: Get the mappings for index {index}.
        slots:
          index: path.index
      - text: Show the field types defined on {index}.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{index}/_settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an index's settings
      effect: write
      questions:
      - Can I change settings like the replica count on an existing index?
      - Can index settings be updated without recreating the index?
      instructions:
      - text: Update the settings of index {index}.
        slots:
          index: path.index
      - text: Apply new dynamic settings to {index}.
        slots:
          index: path.index
      method: generated
      generated: '2026-09-26'