Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Platform API

6 actions 6 updates phrasing extends openapi/elk-stack-platform-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'].get

$.paths['/platform/configuration/security/extra_certs'].get

$.paths['/platform/configuration/security/extra_certs/{cert_id}'].get

$.paths['/platform/configuration/security/extra_certs/{cert_id}'].put

$.paths['/platform/configuration/security/extra_certs/{cert_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 Elastic Cloud Enterprise Platform API
  version: 1.0.0
extends: openapi/elk-stack-platform-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'].get
  update:
    x-apievangelist-phrasing:
      intent: Get platform information
      effect: read
      questions:
      - What version and details does my Elastic platform installation report?
      - Can I get information about the active platform?
      instructions:
      - text: Show information about the active platform.
      - text: Get the current platform details.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/security/extra_certs'].get
  update:
    x-apievangelist-phrasing:
      intent: List extra trusted certificates
      effect: read
      questions:
      - Which extra certificates are configured on the platform?
      - Can I see all the custom CA certificates the platform trusts?
      instructions:
      - text: List all extra certificates.
      - text: Show every extra certificate in the platform security configuration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/security/extra_certs/{cert_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one extra certificate
      effect: read
      questions:
      - How do I view a specific extra certificate?
      - What does one configured extra certificate contain?
      instructions:
      - text: Get extra certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      - text: Show the contents of certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/security/extra_certs/{cert_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add or update an extra certificate
      effect: write
      questions:
      - How do I add a custom certificate to the platform's trust configuration?
      - Can I replace an existing extra certificate?
      instructions:
      - text: Add or update extra certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      - text: Upload a new version of certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/platform/configuration/security/extra_certs/{cert_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an extra certificate
      effect: destructive
      questions:
      - How do I remove an extra certificate from the platform?
      - Is removing an extra certificate permanent?
      instructions:
      - text: Delete extra certificate {cert_id}.
        slots:
          cert_id: path.cert_id
      - text: Remove certificate {cert_id} from the platform.
        slots:
          cert_id: path.cert_id
      method: generated
      generated: '2026-09-26'