Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Accounts API

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

$.info
$.paths['/account'].get
$.paths['/account'].put
$.paths['/account'].patch

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 Accounts API
  version: 1.0.0
extends: openapi/elk-stack-accounts-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: 3
- target: $.paths['/account'].get
  update:
    x-apievangelist-phrasing:
      intent: View the current Elastic Cloud account
      effect: read
      questions:
      - How do I see the details of the account I'm signed in to on Elastic Cloud Enterprise?
      - What trust settings are configured on my current account?
      instructions:
      - text: Show me my current account information.
      - text: Fetch the account details, including its cluster trust settings.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the current account's trust settings
      effect: write
      questions:
      - Can I change which clusters my account trusts by sending a full account update?
      - Where do I set the cluster trust level for my whole account?
      instructions:
      - text: Update my account with the trust settings {trust}.
        slots:
          trust: requestBody.trust
      - text: Overwrite the account-level cluster trust configuration with {trust}.
        slots:
          trust: requestBody.trust
      method: generated
      generated: '2026-09-26'
- target: $.paths['/account'].patch
  update:
    x-apievangelist-phrasing:
      intent: Partially update the current account
      effect: write
      questions:
      - Is there a way to patch just part of my account settings rather than replacing them?
      - Can I send a partial change to my current account without resending everything?
      instructions:
      - text: Patch my current account with only the fields I've changed.
      - text: Apply a partial update to the account I'm signed in to.
      method: generated
      generated: '2026-09-26'