Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Entitlement Rest Controller API

2 actions 2 updates phrasing extends openapi/atlassian-compass-entitlement-rest-controller-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/entitlements'].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 Entitlement Rest Controller API
  version: 1.0.0
extends: openapi/atlassian-compass-entitlement-rest-controller-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/entitlements'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a user's Compass entitlements on a site
      effect: read
      questions:
      - Which Compass entitlements does a given user have on our site?
      - Can I evaluate several entitlements for a user and site in one call?
      - Is this user entitled to a particular Compass feature?
      instructions:
      - text: Evaluate entitlements {entitlements} for the user on this site.
        slots:
          entitlements: requestBody.entitlements
      - text: Check whether the user and site are granted {entitlements} in Compass.
        slots:
          entitlements: requestBody.entitlements
      method: generated
      generated: '2026-09-26'