Elastic Stack · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Kibana Spaces API
11 actions
11 updates
phrasing
extends
openapi/elk-stack-spaces-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 11
$.info
$.paths['/api/spaces/_resolve_copy_saved_objects_errors'].post
$.paths['/api/spaces/_copy_saved_objects'].post
$.paths['/api/spaces/_disable_legacy_url_aliases'].post
$.paths['/api/spaces/_get_shareable_references'].post
$.paths['/api/spaces/_update_objects_spaces'].post
$.paths['/api/spaces/space'].get
$.paths['/api/spaces/space'].post
$.paths['/api/spaces/space/{id}'].get
$.paths['/api/spaces/space/{id}'].put
$.paths['/api/spaces/space/{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 Spaces API
version: 1.0.0
extends: openapi/elk-stack-spaces-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: 10
- target: $.paths['/api/spaces/_resolve_copy_saved_objects_errors'].post
update:
x-apievangelist-phrasing:
intent: Resolve conflicts from copying saved objects
effect: write
questions:
- What do I do when copying a dashboard to another space fails with conflicts?
- Can I overwrite only the objects that errored during a space copy?
instructions:
- text: Retry copying {objects} with these conflict resolutions {retries}.
slots:
objects: requestBody.objects
retries: requestBody.retries
- text: Resolve copy errors for {objects} by applying retries {retries} and including references.
slots:
objects: requestBody.objects
retries: requestBody.retries
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/_copy_saved_objects'].post
update:
x-apievangelist-phrasing:
intent: Copy saved objects to other spaces
effect: write
questions:
- How do I copy a Kibana dashboard into another space?
- Will its visualizations and data views come along when I copy it?
- Can I overwrite objects that already exist in the target space?
instructions:
- text: Copy {objects} to spaces {spaces}.
slots:
objects: requestBody.objects
spaces: requestBody.spaces
- text: 'Copy {objects} into {spaces}, overwriting existing ones: {overwrite}.'
slots:
objects: requestBody.objects
spaces: requestBody.spaces
overwrite: requestBody.overwrite
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/_disable_legacy_url_aliases'].post
update:
x-apievangelist-phrasing:
intent: Disable legacy URL aliases
effect: write
questions:
- Can I stop old saved object URLs from redirecting to their new targets?
- What turns off a legacy URL alias in Kibana?
instructions:
- text: Disable legacy URL aliases {aliases}.
slots:
aliases: requestBody.aliases
- text: Stop these old aliases {aliases} from resolving.
slots:
aliases: requestBody.aliases
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/_get_shareable_references'].post
update:
x-apievangelist-phrasing:
intent: Collect shareable references for saved objects
effect: read
questions:
- Which related objects and spaces would be involved if I share a saved object?
- Can I see a saved object's references before sharing it across spaces?
instructions:
- text: Get shareable references for {objects}.
slots:
objects: requestBody.objects
- text: Show the references and space contexts of {objects}.
slots:
objects: requestBody.objects
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/_update_objects_spaces'].post
update:
x-apievangelist-phrasing:
intent: Share or unshare saved objects across spaces
effect: write
questions:
- Can I share one saved object into multiple spaces without copying it?
- How do I remove a shared object from a space?
instructions:
- text: Add {objects} to spaces {spacesToAdd} and remove from {spacesToRemove}.
slots:
objects: requestBody.objects
spacesToAdd: requestBody.spacesToAdd
spacesToRemove: requestBody.spacesToRemove
- text: Share {objects} into {spacesToAdd}, removing none ({spacesToRemove}).
slots:
objects: requestBody.objects
spacesToAdd: requestBody.spacesToAdd
spacesToRemove: requestBody.spacesToRemove
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/space'].get
update:
x-apievangelist-phrasing:
intent: List Kibana spaces
effect: read
questions:
- Which Kibana spaces can I access?
- Can I list only spaces I'm authorized to copy objects into?
instructions:
- text: List all my Kibana spaces.
- text: List spaces for purpose {purpose}.
slots:
purpose: query.purpose
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/space'].post
update:
x-apievangelist-phrasing:
intent: Create a Kibana space
effect: write
questions:
- How do I create a new Kibana space for my team?
- Can I hide certain features in a space when I create it?
instructions:
- text: Create space {id} named {name}.
slots:
id: requestBody.id
name: requestBody.name
- text: Create a new space {id} called {name} with color {color}.
slots:
id: requestBody.id
name: requestBody.name
color: requestBody.color
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/space/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Kibana space
effect: read
questions:
- What features are disabled in a particular space?
- Can I look up one Kibana space by its identifier?
instructions:
- text: Show space {id}.
slots:
id: path.id
- text: Get details of the {id} space.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/space/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a Kibana space
effect: write
questions:
- Can I rename a space or change its color after it's created?
- Which features can I turn off in an existing space?
instructions:
- text: Rename existing space {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Update space {id} ({name}) to disable features {disabledFeatures}.
slots:
id: path.id
name: requestBody.name
disabledFeatures: requestBody.disabledFeatures
method: generated
generated: '2026-09-26'
- target: $.paths['/api/spaces/space/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Kibana space
effect: destructive
questions:
- Does deleting a space also delete its dashboards and other saved objects?
- Can a deleted Kibana space be recovered?
instructions:
- text: Delete space {id}.
slots:
id: path.id
- text: Permanently remove the {id} space and everything in it.
slots:
id: path.id
method: generated
generated: '2026-09-26'