Elastic Stack · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/elk-stack-platformconfigurationsnapshots-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 5

$.info
$.paths['/platform/configuration/snapshots/repositories'].get
$.paths['/platform/configuration/snapshots/repositories/{repository_name}'].get
$.paths['/platform/configuration/snapshots/repositories/{repository_name}'].put
$.paths['/platform/configuration/snapshots/repositories/{repository_name}'].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 Snapshots API
  version: 1.0.0
extends: openapi/elk-stack-platformconfigurationsnapshots-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: 4
- target: $.paths['/platform/configuration/snapshots/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List snapshot repository configurations
      effect: read
      questions:
      - Which snapshot repositories are configured for the platform?
      - Can I see all the snapshot repository configurations available to deployments?
      instructions:
      - text: List all platform snapshot repositories.
      - text: Show every snapshot repository configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/snapshots/repositories/{repository_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a snapshot repository configuration
      effect: read
      questions:
      - What type and settings does a particular snapshot repository have?
      - Do I need privileged permissions to see a snapshot repository's configuration contents?
      instructions:
      - text: Show the snapshot repository {repository_name}.
        slots:
          repository_name: path.repository_name
      - text: Get the configuration of snapshot repository {repository_name}.
        slots:
          repository_name: path.repository_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/snapshots/repositories/{repository_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a snapshot repository
      effect: write
      questions:
      - How do I add an S3 snapshot repository to the platform?
      - Can I update an existing snapshot repository's settings safely using its version?
      instructions:
      - text: Create snapshot repository {repository_name} of type {type} with settings {settings}.
        slots:
          repository_name: path.repository_name
          type: requestBody.type
          settings: requestBody.settings
      - text: Update snapshot repository {repository_name} at version {version} with settings {settings}.
        slots:
          repository_name: path.repository_name
          version: query.version
          settings: requestBody.settings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/snapshots/repositories/{repository_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a snapshot repository configuration
      effect: destructive
      questions:
      - How do I remove a snapshot repository from the platform?
      - Can I also clean up the deployments that use a snapshot repository when deleting it?
      instructions:
      - text: Delete snapshot repository {repository_name}.
        slots:
          repository_name: path.repository_name
      - text: Delete snapshot repository {repository_name} and clean up deployments using it ({cleanup_deployments}).
        slots:
          repository_name: path.repository_name
          cleanup_deployments: query.cleanup_deployments
      method: generated
      generated: '2026-09-26'