Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Events API

2 actions 2 updates phrasing extends openapi/atlassian-compass-events-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/events'].post

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 Compass REST Events API
  version: 1.0.0
extends: openapi/atlassian-compass-events-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/events'].post
  update:
    x-apievangelist-phrasing:
      intent: Send an event into a Compass event source
      effect: write
      questions:
      - Can I push a deployment or build event into a Compass event source?
      - What is the rate limit when sending events to Compass?
      - Does an event have to be tied to a specific component?
      instructions:
      - text: Send event {event} to Compass site {cloudId}.
        slots:
          event: requestBody.event
          cloudId: requestBody.cloudId
      - text: Record event {event} for component {componentId} on site {cloudId}.
        slots:
          event: requestBody.event
          componentId: requestBody.componentId
          cloudId: requestBody.cloudId
      method: generated
      generated: '2026-09-26'