Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform Configuration Instances API

6 actions 6 updates phrasing extends openapi/elk-stack-platformconfigurationinstances-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['/platform/configuration/instances'].get
$.paths['/platform/configuration/instances'].post
$.paths['/platform/configuration/instances/{id}'].get
$.paths['/platform/configuration/instances/{id}'].put
$.paths['/platform/configuration/instances/{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 Platform Configuration Instances API
  version: 1.0.0
extends: openapi/elk-stack-platformconfigurationinstances-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['/platform/configuration/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List instance configurations
      effect: read
      questions:
      - What instance configurations are available on my Elastic platform?
      - Can I include deleted instance configurations in the list?
      instructions:
      - text: List all instance configurations.
      - text: List instance configurations with show_deleted set to {show_deleted}.
        slots:
          show_deleted: query.show_deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an instance configuration
      effect: write
      questions:
      - How do I define a new instance configuration with its allowed sizes?
      - Can I restrict a new instance configuration to certain allocators?
      instructions:
      - text: Create instance configuration {name} with discrete sizes {discrete_sizes}.
        slots:
          name: requestBody.name
          discrete_sizes: requestBody.discrete_sizes
      - text: Add a new {instance_type} instance configuration {name} sized {discrete_sizes} with allocator filter {allocator_filter}.
        slots:
          instance_type: requestBody.instance_type
          name: requestBody.name
          discrete_sizes: requestBody.discrete_sizes
          allocator_filter: requestBody.allocator_filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/instances/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an instance configuration
      effect: read
      questions:
      - What sizes and node types does a specific instance configuration allow?
      - Can I fetch a particular version of an instance configuration?
      instructions:
      - text: Get instance configuration {id}.
        slots:
          id: path.id
      - text: Show version {config_version} of instance configuration {id}.
        slots:
          config_version: query.config_version
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/instances/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or replace an instance configuration by ID
      effect: write
      questions:
      - How do I overwrite an existing instance configuration with a known ID?
      - Can I test an instance configuration change before it goes live?
      instructions:
      - text: Set instance configuration {id} to name {name} with discrete sizes {discrete_sizes}.
        slots:
          id: path.id
          name: requestBody.name
          discrete_sizes: requestBody.discrete_sizes
      - text: Save instance configuration {id} as a test config ({test_config}) named {name}, sized {discrete_sizes}.
        slots:
          id: path.id
          test_config: query.test_config
          name: requestBody.name
          discrete_sizes: requestBody.discrete_sizes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/instances/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an instance configuration
      effect: destructive
      questions:
      - How do I delete an instance configuration I no longer use?
      - Can I delete only the test version of an instance configuration?
      instructions:
      - text: Delete instance configuration {id}.
        slots:
          id: path.id
      - text: Remove only the test version of instance configuration {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'