Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Users API

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

$.info

$.paths['/user'].get

$.paths['/user'].patch

$.paths['/users'].get

$.paths['/users'].post

$.paths['/users/{user_name}'].get

$.paths['/users/{user_name}'].delete

$.paths['/users/{user_name}'].patch

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 Users API
  version: 1.0.0
extends: openapi/elk-stack-users-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: 7
- target: $.paths['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own user information
      effect: read
      questions:
      - Which user am I logged in as, and what are my details?
      - Can I see my own account's profile and role information?
      instructions:
      - text: Show my current user information.
      - text: Fetch the details of the account I'm signed in with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update my own user profile
      effect: write
      questions:
      - How do I change my own full name or email?
      - Can I update my own account without admin access to other users?
      instructions:
      - text: Update my own user profile.
      - text: Change the details on the account I'm logged in as.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List all users
      effect: read
      questions:
      - Who has a user account on the platform?
      - Can I include disabled users when listing everyone?
      instructions:
      - text: List all users.
      - text: List every user, including disabled ones ({include_disabled}).
        slots:
          include_disabled: query.include_disabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new user
      effect: write
      questions:
      - How do I add a new user with a password and roles?
      - What security settings are required when creating a user account?
      instructions:
      - text: Create user {user_name} with security settings {security}.
        slots:
          user_name: requestBody.user_name
          security: requestBody.security
      - text: Add a new user {user_name} named {full_name} with email {email}.
        slots:
          user_name: requestBody.user_name
          full_name: requestBody.full_name
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single user by name
      effect: read
      questions:
      - What roles and details does a particular user have?
      - Can I look up one user account by its username?
      instructions:
      - text: Show user {user_name}.
        slots:
          user_name: path.user_name
      - text: Fetch the account details for {user_name}.
        slots:
          user_name: path.user_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove a user account permanently?
      - Can I delete someone else's user by username?
      instructions:
      - text: Delete user {user_name}.
        slots:
          user_name: path.user_name
      - text: Remove the account {user_name} from the platform.
        slots:
          user_name: path.user_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user_name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update another user's account
      effect: write
      questions:
      - How do I change the roles or email of another user?
      - Can I edit an existing user's account by username?
      instructions:
      - text: Update the user account {user_name}.
        slots:
          user_name: path.user_name
      - text: Edit the details of existing user {user_name}.
        slots:
          user_name: path.user_name
      method: generated
      generated: '2026-09-26'