Elastic Stack · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kibana APM sourcemaps API

4 actions 4 updates phrasing extends openapi/elk-stack-apm-sourcemaps-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['/api/apm/sourcemaps'].get

$.paths['/api/apm/sourcemaps'].post

$.paths['/api/apm/sourcemaps/{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 Kibana APM sourcemaps API
  version: 1.0.0
extends: openapi/elk-stack-apm-sourcemaps-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['/api/apm/sourcemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded APM source maps
      effect: read
      questions:
      - Which source maps have I already uploaded to APM?
      - Can I page through my APM source map uploads a few at a time?
      instructions:
      - text: List the source maps uploaded to APM.
      - text: Show page {page} of my APM source maps with {perPage} per page.
        slots:
          page: query.page
          perPage: query.perPage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/apm/sourcemaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a source map for a service version
      effect: write
      questions:
      - How do I upload a JavaScript source map so APM can un-minify my RUM stack traces?
      - What is the maximum size of a source map I can upload to Elastic APM?
      - Do I need to give the service name and version when uploading a source map?
      instructions:
      - text: Upload a source map for service {service_name} version {service_version} covering bundle {bundle_filepath}.
        slots:
          service_name: requestBody.service_name
          service_version: requestBody.service_version
          bundle_filepath: requestBody.bundle_filepath
      - text: Send the source map file {sourcemap} to APM for {service_name} {service_version}, bundle path {bundle_filepath}.
        slots:
          sourcemap: requestBody.sourcemap
          service_name: requestBody.service_name
          service_version: requestBody.service_version
          bundle_filepath: requestBody.bundle_filepath
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/apm/sourcemaps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an uploaded source map
      effect: destructive
      questions:
      - How do I remove a source map I uploaded to APM by mistake?
      - Can I delete an old APM source map once a release is retired?
      instructions:
      - text: Delete APM source map {id}.
        slots:
          id: path.id
      - text: Remove the previously uploaded source map with ID {id} from APM.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'