Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Metrics API

2 actions 2 updates phrasing extends openapi/atlassian-compass-metrics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian Compass's API. It is a proposal applied on top of the contract, not a document Atlassian Compass publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/compass/v1/metrics'].post

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 Compass REST Metrics API
  version: 1.0.0
extends: openapi/atlassian-compass-metrics-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: 1
- target: $.paths['/compass/v1/metrics'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a metric value for a component
      effect: write
      questions:
      - Can I push a new metric value into a component's metric source in Compass?
      - How many metric values per minute am I allowed to send?
      instructions:
      - text: Send the latest metric value to our component's metric source.
      - text: Push this new reading into the metric source it belongs to.
      method: generated
      generated: '2026-09-26'