Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Elastic Cloud Enterprise Billing Costs Analysis API

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

$.info
$.paths['/billing/costs/{organization_id}'].get
$.paths['/billing/costs/{organization_id}/charts'].get
$.paths['/billing/costs/{organization_id}/deployments'].get
$.paths['/billing/costs/{organization_id}/deployments/{deployment_id}/charts'].get
$.paths['/billing/costs/{organization_id}/deployments/{deployment_id}/items'].get
$.paths['/billing/costs/{organization_id}/items'].get

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 Billing Costs Analysis API
  version: 1.0.0
extends: openapi/elk-stack-billingcostsanalysis-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: 6
- target: $.paths['/billing/costs/{organization_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's cost overview
      effect: read
      questions:
      - How much has my Elastic Cloud organization spent so far?
      - Can I see total organization costs for a specific date range?
      instructions:
      - text: Get the cost overview for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Summarize org {organization_id} spend from {from} to {to}.
        slots:
          organization_id: path.organization_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/costs/{organization_id}/charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's usage charts
      effect: read
      questions:
      - What does our organization-wide usage look like over time?
      - Can I bucket organization usage charts by day or month?
      instructions:
      - text: Get usage charts for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Chart org {organization_id} usage from {from} to {to} bucketed by {bucketing_strategy}.
        slots:
          organization_id: path.organization_id
          from: query.from
          to: query.to
          bucketing_strategy: query.bucketing_strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/costs/{organization_id}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: Get costs broken down by deployment
      effect: read
      questions:
      - Which of our deployments costs the most?
      - Can I get per-deployment costs for the organization as CSV?
      instructions:
      - text: List the costs of every deployment in organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Break down org {organization_id} spend per deployment between {from} and {to}.
        slots:
          organization_id: path.organization_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/costs/{organization_id}/deployments/{deployment_id}/charts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get usage charts for one deployment
      effect: read
      questions:
      - How has usage for a single deployment trended over time?
      - Can I chart one deployment's consumption by a chosen bucketing strategy?
      instructions:
      - text: Get usage charts for deployment {deployment_id} in organization {organization_id}.
        slots:
          deployment_id: path.deployment_id
          organization_id: path.organization_id
      - text: Chart deployment {deployment_id} of org {organization_id} from {from} to {to} bucketed by {bucketing_strategy}.
        slots:
          deployment_id: path.deployment_id
          organization_id: path.organization_id
          from: query.from
          to: query.to
          bucketing_strategy: query.bucketing_strategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/costs/{organization_id}/deployments/{deployment_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: Get itemized costs for one deployment
      effect: read
      questions:
      - What line items make up the bill for one deployment?
      - Can I see itemized charges for a single deployment over a date range?
      instructions:
      - text: Get itemized costs for deployment {deployment_id} in organization {organization_id}.
        slots:
          deployment_id: path.deployment_id
          organization_id: path.organization_id
      - text: List the line-item charges of deployment {deployment_id} (org {organization_id}) from {from} to {to}.
        slots:
          deployment_id: path.deployment_id
          organization_id: path.organization_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/billing/costs/{organization_id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: Get itemized costs for an organization
      effect: read
      questions:
      - What individual line items make up our organization's bill?
      - Can I get organization-wide itemized costs for last month?
      instructions:
      - text: Get the itemized costs for organization {organization_id}.
        slots:
          organization_id: path.organization_id
      - text: Show org {organization_id} line items across all deployments from {from} to {to}.
        slots:
          organization_id: path.organization_id
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'