Elastic Stack · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform Infrastructure API
84 actions
84 updates
phrasing
extends
openapi/elk-stack-platforminfrastructure-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.
What the actions change
x-apievangelist-phrasing
Targets 84 · first 16 shown; the file carries all of them
$.info
$.paths['/platform/configuration/api_base_url'].get
$.paths['/platform/configuration/api_base_url'].put
$.paths['/platform/configuration/store'].get
$.paths['/platform/configuration/store/{config_option_id}'].get
$.paths['/platform/configuration/store/{config_option_id}'].put
$.paths['/platform/configuration/store/{config_option_id}'].post
$.paths['/platform/configuration/store/{config_option_id}'].delete
$.paths['/platform/infrastructure/adminconsoles'].get
$.paths['/platform/infrastructure/adminconsoles/_reindex'].post
$.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].get
$.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].put
$.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].delete
$.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].patch
$.paths['/platform/infrastructure/allocators'].get
$.paths['/platform/infrastructure/allocators/_resync'].post
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 Elastic Cloud Enterprise Platform Infrastructure API
version: 1.0.0
extends: openapi/elk-stack-platforminfrastructure-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: 83
- target: $.paths['/platform/configuration/api_base_url'].get
update:
x-apievangelist-phrasing:
intent: Get the platform API base URL
effect: read
questions:
- What API base URL is configured for my Elastic Cloud Enterprise platform?
- Where can I check the base URL the platform advertises for its API?
instructions:
- text: Show the configured API base URL.
- text: Tell me what the platform's API base URL is set to.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/api_base_url'].put
update:
x-apievangelist-phrasing:
intent: Set the platform API base URL
effect: write
questions:
- How do I change the API base URL for my ECE installation?
- Can I update the base URL without re-provisioning the Security cluster?
instructions:
- text: Set the API base URL to {value}.
slots:
value: requestBody.value
- text: Change the platform API base URL to {value} with skip_cascading_operations {skip_cascading_operations}.
slots:
value: requestBody.value
skip_cascading_operations: query.skip_cascading_operations
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/store'].get
update:
x-apievangelist-phrasing:
intent: List Config Store options
effect: read
questions:
- What options are stored in the platform Config Store?
- How do I see every Config Store setting currently defined?
instructions:
- text: List all Config Store options.
- text: Show everything saved in the platform configuration store.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/store/{config_option_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Config Store option by name
effect: read
questions:
- How do I read the value of one Config Store option?
- Can I look up a single configuration store entry by its name?
instructions:
- text: Get Config Store option {config_option_id}.
slots:
config_option_id: path.config_option_id
- text: Read the value held by store option {config_option_id}.
slots:
config_option_id: path.config_option_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/store/{config_option_id}'].put
update:
x-apievangelist-phrasing:
intent: Update an existing Config Store option
effect: write
questions:
- How do I change the value of a Config Store option that already exists?
- Can I guard a Config Store update against conflicting edits with a version?
instructions:
- text: Update Config Store option {config_option_id} to {value}.
slots:
config_option_id: path.config_option_id
value: requestBody.value
- text: Change existing store option {config_option_id} to {value} only if it is at version {version}.
slots:
config_option_id: path.config_option_id
value: requestBody.value
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/store/{config_option_id}'].post
update:
x-apievangelist-phrasing:
intent: Create a new Config Store option
effect: write
questions:
- How do I add a brand-new option to the platform Config Store?
- Can I insert a Config Store entry under a name I choose?
instructions:
- text: Create Config Store option {config_option_id} with value {value}.
slots:
config_option_id: path.config_option_id
value: requestBody.value
- text: Insert a new store entry named {config_option_id} set to {value}.
slots:
config_option_id: path.config_option_id
value: requestBody.value
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/configuration/store/{config_option_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Config Store option
effect: destructive
questions:
- How do I remove an option from the Config Store?
- Can I delete a configuration store entry by its name?
instructions:
- text: Delete Config Store option {config_option_id}.
slots:
config_option_id: path.config_option_id
- text: Remove the {config_option_id} entry from the configuration store.
slots:
config_option_id: path.config_option_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles'].get
update:
x-apievangelist-phrasing:
intent: List adminconsoles
effect: read
questions:
- What adminconsole instances are running in my ECE installation?
- How do I get an overview of all adminconsoles?
instructions:
- text: List all adminconsoles.
- text: Give me an overview of every adminconsole instance.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles/_reindex'].post
update:
x-apievangelist-phrasing:
intent: Reindex regional indices
effect: write
questions:
- How do I kick off a reindex of all the regional indices?
- Can I rebuild the region indices from the adminconsole?
instructions:
- text: Start a reindex of all regional indices.
- text: Rebuild every region index now.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].get
update:
x-apievangelist-phrasing:
intent: Get an adminconsole's logging settings
effect: read
questions:
- What log levels is a particular adminconsole instance using?
- How do I check the logging configuration of one adminconsole?
instructions:
- text: Show the logging settings for adminconsole {adminconsole_id}.
slots:
adminconsole_id: path.adminconsole_id
- text: Tell me the log levels in effect on adminconsole {adminconsole_id}.
slots:
adminconsole_id: path.adminconsole_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].put
update:
x-apievangelist-phrasing:
intent: Set an adminconsole's logging levels
effect: write
questions:
- How do I override the log levels on an adminconsole instance?
- Can I turn adminconsole logging up to DEBUG for troubleshooting?
instructions:
- text: Set the logging levels of adminconsole {adminconsole_id} to {logging_levels}.
slots:
adminconsole_id: path.adminconsole_id
logging_levels: requestBody.logging_levels
- text: Override adminconsole {adminconsole_id} log levels with {logging_levels}, replacing what is there.
slots:
adminconsole_id: path.adminconsole_id
logging_levels: requestBody.logging_levels
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].delete
update:
x-apievangelist-phrasing:
intent: Reset an adminconsole's logging to defaults
effect: destructive
questions:
- How do I put an adminconsole's logging back to the default levels?
- Can I clear the log level overrides on an adminconsole?
instructions:
- text: Reset adminconsole {adminconsole_id} logging to defaults.
slots:
adminconsole_id: path.adminconsole_id
- text: Clear the log level overrides on adminconsole {adminconsole_id}.
slots:
adminconsole_id: path.adminconsole_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings'].patch
update:
x-apievangelist-phrasing:
intent: Patch an adminconsole's logging settings
effect: write
questions:
- Can I change just one log level on an adminconsole without resetting the rest?
- How does a merge-patch of adminconsole logging handle null values?
instructions:
- text: Patch the logging settings of adminconsole {adminconsole_id}.
slots:
adminconsole_id: path.adminconsole_id
- text: Merge-patch a single log level change into adminconsole {adminconsole_id}.
slots:
adminconsole_id: path.adminconsole_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators'].get
update:
x-apievangelist-phrasing:
intent: List allocators
effect: read
questions:
- How do I see all the allocators in my ECE platform?
- Can I filter the allocator list with a query and page through it?
instructions:
- text: List all allocators.
- text: List allocators matching {q}, {size} at a time.
slots:
q: query.q
size: query.size
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/_resync'].post
update:
x-apievangelist-phrasing:
intent: Resynchronize all allocators in the index
effect: write
questions:
- How do I resync every allocator's information into the search index?
- Can I skip reindexing allocators whose version already matches?
instructions:
- text: Resynchronize all allocators in the background.
- text: Resync every allocator, skipping matching versions when skip_matching_version is {skip_matching_version}.
slots:
skip_matching_version: query.skip_matching_version
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/_search'].post
update:
x-apievangelist-phrasing:
intent: Search allocators with a query
effect: read
questions:
- Which allocators match an Elasticsearch query I write?
- Can I page through allocator search results with a cursor?
instructions:
- text: Search allocators with query {query}.
slots:
query: requestBody.query
- text: Get the next page of allocator search hits from cursor {cursor}.
slots:
cursor: requestBody.cursor
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}'].get
update:
x-apievangelist-phrasing:
intent: Get an allocator
effect: read
questions:
- How do I look up one allocator's details by ID?
- What capacity and instances does a specific allocator have?
instructions:
- text: Get allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Show me the details of allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an allocator
effect: destructive
questions:
- How do I remove an allocator from the platform?
- Can I delete an allocator and remove the instances on it at the same time?
instructions:
- text: Delete allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Delete allocator {allocator_id} and remove its instances, with remove_instances {remove_instances}.
slots:
allocator_id: path.allocator_id
remove_instances: query.remove_instances
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/_resync'].post
update:
x-apievangelist-phrasing:
intent: Resynchronize one allocator
effect: write
questions:
- How do I refresh a single allocator in the search index and caches immediately?
- Can I force one allocator's index entry to sync right away?
instructions:
- text: Resync allocator {allocator_id} now.
slots:
allocator_id: path.allocator_id
- text: Refresh the index and cache entry for allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/clusters/_move'].post
update:
x-apievangelist-phrasing:
intent: Move clusters off an allocator
effect: write
questions:
- How do I move clusters off an allocator before maintenance?
- Can I validate a cluster move plan without actually moving anything?
- What happens when I treat an allocator as permanently down during a move?
instructions:
- text: Move all clusters off allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Move Elasticsearch clusters {elasticsearch_clusters} off allocator {allocator_id}.
slots:
elasticsearch_clusters: requestBody.elasticsearch_clusters
allocator_id: path.allocator_id
- text: Dry-run a move off {allocator_id} with validate_only {validate_only}.
slots:
allocator_id: path.allocator_id
validate_only: query.validate_only
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/clusters/{cluster_type}/_move'].post
update:
x-apievangelist-phrasing:
intent: Move clusters of one type off an allocator
effect: write
questions:
- Can I move only the Kibana clusters off an allocator and leave the rest?
- How do I vacate a single cluster type from an allocator?
instructions:
- text: Move the {cluster_type} clusters off allocator {allocator_id}.
slots:
cluster_type: path.cluster_type
allocator_id: path.allocator_id
- text: Vacate only {cluster_type} clusters from {allocator_id}, moving data at file-system level with force_move {force_move}.
slots:
cluster_type: path.cluster_type
allocator_id: path.allocator_id
force_move: query.force_move
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/logging_settings'].get
update:
x-apievangelist-phrasing:
intent: Get an allocator's logging settings
effect: read
questions:
- What log levels is a specific allocator running with?
- How do I inspect the logging configuration on one allocator?
instructions:
- text: Show the logging settings for allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Tell me the log levels configured on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/logging_settings'].put
update:
x-apievangelist-phrasing:
intent: Set an allocator's logging levels
effect: write
questions:
- How do I override the log levels on an allocator?
- Can I raise an allocator's logging to DEBUG while I troubleshoot?
instructions:
- text: Set allocator {allocator_id} logging levels to {logging_levels}.
slots:
allocator_id: path.allocator_id
logging_levels: requestBody.logging_levels
- text: Replace the log level overrides on allocator {allocator_id} with {logging_levels}.
slots:
allocator_id: path.allocator_id
logging_levels: requestBody.logging_levels
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/logging_settings'].delete
update:
x-apievangelist-phrasing:
intent: Reset an allocator's logging to defaults
effect: destructive
questions:
- How do I restore the default logging on an allocator?
- Can I drop the custom log levels I set on an allocator?
instructions:
- text: Reset allocator {allocator_id} logging to defaults.
slots:
allocator_id: path.allocator_id
- text: Drop the custom log levels on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/logging_settings'].patch
update:
x-apievangelist-phrasing:
intent: Patch an allocator's logging settings
effect: write
questions:
- Can I tweak one log level on an allocator without overwriting the others?
- How do I merge-patch logging changes into an allocator?
instructions:
- text: Patch the logging settings of allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Merge a partial log level change into allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_start'].post
update:
x-apievangelist-phrasing:
intent: Put an allocator into maintenance mode
effect: write
questions:
- How do I put an allocator into maintenance mode?
- Can I record a reason when I start allocator maintenance?
instructions:
- text: Start maintenance mode on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Put allocator {allocator_id} into maintenance with reason {reason}.
slots:
allocator_id: path.allocator_id
reason: query.reason
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/maintenance-mode/_stop'].post
update:
x-apievangelist-phrasing:
intent: Take an allocator out of maintenance mode
effect: write
questions:
- How do I bring an allocator back out of maintenance mode?
- Can I note why allocator maintenance ended?
instructions:
- text: Stop maintenance mode on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: End maintenance on allocator {allocator_id}, noting reason {reason}.
slots:
allocator_id: path.allocator_id
reason: query.reason
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/metadata'].get
update:
x-apievangelist-phrasing:
intent: Get an allocator's metadata
effect: read
questions:
- What metadata tags are attached to an allocator?
- How do I read the key-value metadata on one allocator?
instructions:
- text: Get the metadata for allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: List the metadata items on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/metadata'].put
update:
x-apievangelist-phrasing:
intent: Replace all metadata on an allocator
effect: write
questions:
- How do I set the full collection of metadata on an allocator?
- Can I replace an allocator's metadata only if it hasn't changed since I read it?
instructions:
- text: Set allocator {allocator_id} metadata to {items}.
slots:
allocator_id: path.allocator_id
items: requestBody.items
- text: Replace every metadata item on {allocator_id} with {items} at version {version}.
slots:
allocator_id: path.allocator_id
items: requestBody.items
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/metadata/{key}'].put
update:
x-apievangelist-phrasing:
intent: Add or update one allocator metadata item
effect: write
questions:
- Can I change a single metadata key on an allocator without touching the others?
- How do I tag an allocator with one new metadata value?
instructions:
- text: Set metadata key {key} on allocator {allocator_id} to {value}.
slots:
key: path.key
allocator_id: path.allocator_id
value: requestBody.value
- text: Tag allocator {allocator_id} with {key}={value}.
slots:
allocator_id: path.allocator_id
key: path.key
value: requestBody.value
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/metadata/{key}'].delete
update:
x-apievangelist-phrasing:
intent: Remove one allocator metadata item
effect: destructive
questions:
- How do I delete a single metadata key from an allocator?
- Can I untag an allocator by removing one metadata entry?
instructions:
- text: Remove metadata key {key} from allocator {allocator_id}.
slots:
key: path.key
allocator_id: path.allocator_id
- text: Untag {allocator_id} by deleting its {key} metadata item.
slots:
allocator_id: path.allocator_id
key: path.key
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/settings'].get
update:
x-apievangelist-phrasing:
intent: Get an allocator's override settings
effect: read
questions:
- What capacity override is set on an allocator?
- How do I view the override settings of one allocator?
instructions:
- text: Get the override settings for allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Show the capacity override on allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/settings'].put
update:
x-apievangelist-phrasing:
intent: Overwrite an allocator's settings
effect: write
questions:
- How do I override an allocator's memory capacity from what was set at install?
- Does replacing allocator settings delete fields I leave out?
instructions:
- text: Set allocator {allocator_id} capacity to {capacity} MB.
slots:
allocator_id: path.allocator_id
capacity: requestBody.capacity
- text: Overwrite all settings on allocator {allocator_id} with capacity {capacity}.
slots:
allocator_id: path.allocator_id
capacity: requestBody.capacity
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/allocators/{allocator_id}/settings'].patch
update:
x-apievangelist-phrasing:
intent: Patch an allocator's settings
effect: write
questions:
- Can I change only some allocator settings and leave the others as they are?
- How do I apply a partial settings update to an allocator?
instructions:
- text: Patch the settings of allocator {allocator_id}.
slots:
allocator_id: path.allocator_id
- text: Apply a partial settings change to allocator {allocator_id} at version {version}.
slots:
allocator_id: path.allocator_id
version: query.version
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles'].get
update:
x-apievangelist-phrasing:
intent: List Blueprinter roles
effect: read
questions:
- Which Blueprinter roles are defined on my platform?
- How do I see all persisted runner roles?
instructions:
- text: List all Blueprinter roles.
- text: Show every persisted runner role.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles'].post
update:
x-apievangelist-phrasing:
intent: Create a Blueprinter role
effect: write
questions:
- How do I define a new Blueprinter role for runners?
- Can I bless specific runners when I create a role?
instructions:
- text: Create Blueprinter role {role}.
slots:
role: requestBody.role
- text: Create role {role} with runner blessings {blessings}.
slots:
role: requestBody.role
blessings: requestBody.blessings
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Blueprinter role
effect: read
questions:
- How do I look up one Blueprinter role and its containers?
- Which runners are blessed for a particular role?
instructions:
- text: Get Blueprinter role {blueprinter_role_id}.
slots:
blueprinter_role_id: path.blueprinter_role_id
- text: Show the containers and blessings of role {blueprinter_role_id}.
slots:
blueprinter_role_id: path.blueprinter_role_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a Blueprinter role
effect: write
questions:
- How do I change the containers that make up a Blueprinter role?
- Can I make a role auto-blessed so any runner can take its containers?
instructions:
- text: Update role {blueprinter_role_id} with id {id}, containers {containers} and auto_blessed {auto_blessed}.
slots:
blueprinter_role_id: path.blueprinter_role_id
id: requestBody.id
containers: requestBody.containers
auto_blessed: requestBody.auto_blessed
- text: Replace the containers of Blueprinter role {blueprinter_role_id} with {containers}.
slots:
blueprinter_role_id: path.blueprinter_role_id
containers: requestBody.containers
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Blueprinter role
effect: destructive
questions:
- How do I delete a Blueprinter role?
- Can I delete a role even when validation would block it?
instructions:
- text: Delete Blueprinter role {blueprinter_role_id}.
slots:
blueprinter_role_id: path.blueprinter_role_id
- text: Delete role {blueprinter_role_id} ignoring validation errors with skip_validations {skip_validations}.
slots:
blueprinter_role_id: path.blueprinter_role_id
skip_validations: query.skip_validations
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings'].put
update:
x-apievangelist-phrasing:
intent: Set all runner blessings for a role
effect: write
questions:
- How do I set which runners are allowed to run a Blueprinter role?
- Can I replace the whole runner blessing map on a role at once?
instructions:
- text: Set the blessings for role {blueprinter_role_id} to {runner_ids_to_blessing}.
slots:
blueprinter_role_id: path.blueprinter_role_id
runner_ids_to_blessing: requestBody.runner_ids_to_blessing
- text: Replace the runner blessing map on {blueprinter_role_id} with {runner_ids_to_blessing}.
slots:
blueprinter_role_id: path.blueprinter_role_id
runner_ids_to_blessing: requestBody.runner_ids_to_blessing
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/blueprinter/roles/{blueprinter_role_id}/blessings/{runner_id}'].put
update:
x-apievangelist-phrasing:
intent: Bless one runner for a role
effect: write
questions:
- Can I bless a single runner for a role without resending all blessings?
- How do I allow one more runner to run a Blueprinter role?
instructions:
- text: Bless runner {runner_id} for role {blueprinter_role_id} with value {value}.
slots:
runner_id: path.runner_id
blueprinter_role_id: path.blueprinter_role_id
value: requestBody.value
- text: Allow runner {runner_id} to run role {blueprinter_role_id}, blessing set to {value}.
slots:
runner_id: path.runner_id
blueprinter_role_id: path.blueprinter_role_id
value: requestBody.value
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/constructors'].get
update:
x-apievangelist-phrasing:
intent: List constructors
effect: read
questions:
- What constructors are part of my ECE installation?
- How do I get an overview of all constructors?
instructions:
- text: List all constructors.
- text: Give me an overview of every constructor in the installation.
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/constructors/_resync'].post
update:
x-apievangelist-phrasing:
intent: Resynchronize all constructors in the index
effect: write
questions:
- How do I resync every constructor's information into the search index?
- Can a bulk constructor resync skip documents whose version already matches?
instructions:
- text: Resynchronize all constructors in the background.
- text: Resync every constructor with skip_matching_version {skip_matching_version}.
slots:
skip_matching_version: query.skip_matching_version
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/constructors/{constructor_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a constructor
effect: read
questions:
- How do I look up one constructor by its ID?
- Is a particular constructor in maintenance mode?
instructions:
- text: Get constructor {constructor_id}.
slots:
constructor_id: path.constructor_id
- text: Show the details of constructor {constructor_id}.
slots:
constructor_id: path.constructor_id
method: generated
generated: '2026-09-26'
- target: $.paths['/platform/infrastructure/constructors/{constructor_id}/_resync'].post
update:
x-apievangelist-phrasing:
intent: Resynchronize one constructor
effect: write
questions:
- How do I immediately refresh one constructor's search index and cache entry?
- Can I resync a single constructor rather than all of them?
instructions:
- text: Resync constructor {constructor_id} now.
slots:
constructor_id: path.constructor_id
- text: Refresh the index and cache for constructor {constructor_id}.
slots:
constructor_id: path.constructor_id
method: generated
generated: '2026-09-26'
# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/overlays/elk-stack-platforminfrastructure-api-phrasing-overlay.yaml