API Evangelist conversational phrasing for Kibana saved objects API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kibana saved objects API
  version: 1.0.0
extends: openapi/elk-stack-saved-objects-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: 16
- target: $.paths['/api/encrypted_saved_objects/_rotate_key'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate the encryption key for saved objects
      effect: write
      questions:
      - How do I re-encrypt Kibana saved objects with the current primary key?
      - Can I limit encryption key rotation to one saved object type?
      - What batch size should I use when rotating keys on lots of saved objects?
      instructions:
      - text: Rotate the encryption key for all encrypted saved objects.
      - text: Rotate the encryption key only for saved objects of type {type} in batches of {batch_size}.
        slots:
          type: query.type
          batch_size: query.batch_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_bulk_create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many saved objects at once (legacy)
      effect: write
      questions:
      - How do I create several Kibana saved objects in a single request?
      - Can a bulk create overwrite objects that already have the same type and ID?
      instructions:
      - text: Bulk create these saved objects in Kibana using the legacy bulk create endpoint.
      - text: Bulk create saved objects with overwrite set to {overwrite}.
        slots:
          overwrite: query.overwrite
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_bulk_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete many saved objects at once (legacy)
      effect: destructive
      questions:
      - How do I delete a batch of Kibana saved objects in one call?
      - Can I force-delete multi-space saved objects from every space?
      instructions:
      - text: Bulk delete this list of saved objects.
      - text: Bulk delete saved objects from all spaces with force set to {force}.
        slots:
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_bulk_get'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch many saved objects by type and ID
      effect: read
      questions:
      - How do I fetch several saved objects by type and ID at once?
      - Can I retrieve a batch of dashboards and visualizations in one request?
      instructions:
      - text: Bulk get these saved objects by type and ID.
      - text: Fetch this batch of saved objects in one request.
      - text: Bulk get the listed saved objects, sending xsrf header {kbn-xsrf}.
        slots:
          kbn-xsrf: header.kbn-xsrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_bulk_resolve'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve many saved objects via legacy aliases
      effect: read
      questions:
      - How do I look up several saved objects whose IDs may have changed after an upgrade?
      - Can bulk resolve follow legacy URL aliases?
      instructions:
      - text: Bulk resolve these saved object IDs, following legacy URL aliases.
      - text: Resolve this batch of old saved object IDs to their current objects.
      - text: Bulk resolve the listed legacy saved object IDs with xsrf header {kbn-xsrf}.
        slots:
          kbn-xsrf: header.kbn-xsrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_bulk_update'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many saved objects at once (legacy)
      effect: write
      questions:
      - How do I update several saved objects in one request?
      - Is the bulk update endpoint for saved objects deprecated?
      instructions:
      - text: Bulk update these saved objects with their new attributes.
      - text: Apply attribute changes to this batch of saved objects in one call.
      - text: Run a legacy bulk update of the listed saved objects with xsrf header {kbn-xsrf}.
        slots:
          kbn-xsrf: header.kbn-xsrf
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export saved objects to a file
      effect: read
      questions:
      - How do I back up my Kibana dashboards to a file?
      - Can I include every referenced object when exporting saved objects?
      - Which saved object types can I export at once?
      instructions:
      - text: Export all saved objects of type {type}.
        slots:
          type: requestBody.type
      - text: Export saved objects {objects} including everything they reference.
        slots:
          objects: requestBody.objects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_find'].get
  update:
    x-apievangelist-phrasing:
      intent: Search saved objects
      effect: read
      questions:
      - How do I find saved objects of a given type by title?
      - Can I filter saved objects with a KQL query?
      - Is there a way to page through saved object search results?
      instructions:
      - text: Find saved objects of type {type} matching {search}.
        slots:
          type: query.type
          search: query.search
      - text: Search {type} saved objects with filter {filter}, {per_page} per page.
        slots:
          type: query.type
          filter: query.filter
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import saved objects from an export file
      effect: write
      questions:
      - How do I restore dashboards from an exported file?
      - Can I import saved objects as new copies instead of overwriting?
      - Which Kibana versions can I import saved objects into?
      instructions:
      - text: Import saved objects from file {file}.
        slots:
          file: requestBody.file
      - text: Import {file} and overwrite any existing saved objects.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/_resolve_import_errors'].post
  update:
    x-apievangelist-phrasing:
      intent: Resolve errors from a saved objects import
      effect: write
      questions:
      - How do I fix conflicts from a failed saved objects import?
      - Can I retry specific objects and remap references after an import error?
      instructions:
      - text: Resolve import errors for file {file} using retries {retries}.
        slots:
          file: requestBody.file
          retries: requestBody.retries
      - text: Retry the failed objects {retries} from import file {file}.
        slots:
          retries: requestBody.retries
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/{type}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved object with a generated ID
      effect: write
      questions:
      - How do I create a single saved object and let Kibana pick its ID?
      - Can I create a saved object directly into specific spaces?
      instructions:
      - text: Create a {type} saved object with attributes {attributes} and an auto-generated ID.
        slots:
          type: path.type
          attributes: requestBody.attributes
      - text: Create a new {type} object with {attributes} in spaces {initialNamespaces}.
        slots:
          type: path.type
          attributes: requestBody.attributes
          initialNamespaces: requestBody.initialNamespaces
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a saved object by type and ID
      effect: read
      questions:
      - How do I fetch one saved object when I know its type and ID?
      - Where can I read the attributes of a single dashboard?
      instructions:
      - text: Get the {type} saved object {id}.
        slots:
          type: path.type
          id: path.id
      - text: Show saved object {id} of type {type}.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/{type}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single saved object
      effect: write
      questions:
      - How do I change the attributes of one existing saved object?
      - Can an update create the object if it doesn't exist yet?
      instructions:
      - text: Update {type} saved object {id} with attributes {attributes}.
        slots:
          type: path.type
          id: path.id
          attributes: requestBody.attributes
      - text: Change saved object {id} of type {type} to {attributes}, upserting if missing.
        slots:
          id: path.id
          type: path.type
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/{type}/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a saved object with a chosen ID
      effect: write
      questions:
      - How do I create a saved object with an ID I choose myself?
      - Can I overwrite an existing object when creating one with a specific ID?
      instructions:
      - text: Create a {type} saved object with ID {id} and attributes {attributes}.
        slots:
          type: path.type
          id: path.id
          attributes: requestBody.attributes
      - text: Create {type} object {id} with {attributes}, overwriting any existing one.
        slots:
          type: path.type
          id: path.id
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/{type}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single saved object
      effect: destructive
      questions:
      - How do I delete one saved object by type and ID?
      - Can I remove a shared saved object from all spaces at once?
      instructions:
      - text: Delete the {type} saved object {id}.
        slots:
          type: path.type
          id: path.id
      - text: Force delete saved object {id} of type {type} from every space.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/saved_objects/resolve/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve one saved object via legacy alias
      effect: read
      questions:
      - How do I open a saved object whose ID changed after a Kibana upgrade?
      - Does resolving a saved object follow a legacy URL alias?
      instructions:
      - text: Resolve {type} saved object {id}, following any legacy URL alias.
        slots:
          type: path.type
          id: path.id
      - text: Find the current {type} object for old ID {id}.
        slots:
          type: path.type
          id: path.id
      method: generated
      generated: '2026-09-26'