Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST License Metrics API

4 actions 4 updates phrasing extends openapi/atlassian-license-metrics-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/rest/api/3/instance/license'].get

$.paths['/rest/api/3/license/approximateLicenseCount'].get

$.paths['/rest/api/3/license/approximateLicenseCount/product/{applicationKey}'].get

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 Atlassian The Jira Cloud platform REST License Metrics API
  version: 1.0.0
extends: openapi/atlassian-license-metrics-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/rest/api/3/instance/license'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Jira instance's licensing details
      effect: read
      questions:
      - Which Jira products is our site licensed for?
      - What licensing information does this Jira instance report?
      instructions:
      - text: Show the license information for this Jira instance.
      - text: List the licensed applications on our site.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/license/approximateLicenseCount'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the approximate user count across all licenses
      effect: read
      questions:
      - Roughly how many user accounts are counted against all of our Jira licenses?
      - How fresh is the approximate license user count?
      instructions:
      - text: Show the approximate number of licensed users across all products.
      - text: Give me the total approximate license seat count for the site.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/license/approximateLicenseCount/product/{applicationKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the approximate user count for one product license
      effect: read
      questions:
      - How many users count against our Jira Service Management license specifically?
      - Can I get the seat count for a single product rather than the whole site?
      instructions:
      - text: Show the approximate user count for application {applicationKey}.
        slots:
          applicationKey: path.applicationKey
      - text: Report how many seats are used on the {applicationKey} license.
        slots:
          applicationKey: path.applicationKey
      method: generated
      generated: '2026-10-01'