Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Deployment Templates API

6 actions 6 updates phrasing extends openapi/elk-stack-deploymenttemplates-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['/deployments/templates'].get
$.paths['/deployments/templates'].post
$.paths['/deployments/templates/{template_id}'].get
$.paths['/deployments/templates/{template_id}'].put
$.paths['/deployments/templates/{template_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 Elastic Cloud Enterprise Deployment Templates API
  version: 1.0.0
extends: openapi/elk-stack-deploymenttemplates-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['/deployments/templates'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment templates in a region
      effect: read
      questions:
      - What deployment templates are available in a region?
      - Can I hide deprecated templates from the list?
      instructions:
      - text: List deployment templates in region {region}.
        slots:
          region: query.region
      - text: List templates in {region} compatible with stack version {stack_version}.
        slots:
          region: query.region
          stack_version: query.stack_version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/templates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a deployment template
      effect: write
      questions:
      - How do I create a new deployment template?
      - Can I validate a template without saving it?
      instructions:
      - text: Create deployment template {name} in {region} with definition {deployment_template}.
        slots:
          name: requestBody.name
          region: query.region
          deployment_template: requestBody.deployment_template
      - text: Validate only a new template {name} in {region} using {deployment_template}.
        slots:
          name: requestBody.name
          region: query.region
          deployment_template: requestBody.deployment_template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/templates/{template_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deployment template
      effect: read
      questions:
      - What does a particular deployment template define?
      - Can I see the instance configurations used by one template?
      instructions:
      - text: Show deployment template {template_id} in {region}.
        slots:
          template_id: path.template_id
          region: query.region
      - text: Get template {template_id} in {region} with instance configurations.
        slots:
          template_id: path.template_id
          region: query.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/templates/{template_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a deployment template by ID
      effect: write
      questions:
      - Can I overwrite an existing deployment template by its ID?
      - Is there a way to only create the template if the ID isn't taken?
      instructions:
      - text: Set template {template_id} in {region} to {name} with definition {deployment_template}.
        slots:
          template_id: path.template_id
          region: query.region
          name: requestBody.name
          deployment_template: requestBody.deployment_template
      - text: Update existing template {template_id} in {region} named {name} at version {version} to {deployment_template}.
        slots:
          template_id: path.template_id
          region: query.region
          name: requestBody.name
          version: query.version
          deployment_template: requestBody.deployment_template
      method: generated
      generated: '2026-09-26'
- target: $.paths['/deployments/templates/{template_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deployment template
      effect: destructive
      questions:
      - How do I remove a deployment template I no longer offer?
      - What's needed to delete a template in a given region?
      instructions:
      - text: Delete deployment template {template_id} in {region}.
        slots:
          template_id: path.template_id
          region: query.region
      - text: Remove template {template_id} from region {region}.
        slots:
          template_id: path.template_id
          region: query.region
      method: generated
      generated: '2026-09-26'