Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Admin Organizations API

3 actions 3 updates phrasing extends openapi/atlassian-organizations-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 3

$.info

$.paths['/v1/orgs'].get

$.paths['/v1/orgs/{orgId}'].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 Admin Organizations API
  version: 1.0.0
extends: openapi/atlassian-organizations-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: 2
- target: $.paths['/v1/orgs'].get
  update:
    x-apievangelist-phrasing:
      intent: List organizations my API key can access
      effect: read
      questions:
      - Which Atlassian organizations can my admin API key reach?
      - Can I page through organizations with a cursor?
      instructions:
      - text: List the organizations my API key can access.
      - text: Get the next page of organizations after cursor {cursor}.
        slots:
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{orgId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization's details
      effect: read
      questions:
      - What information is available about a single organization?
      - Can I look up an org by its ID?
      instructions:
      - text: Get organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Show details for org {orgId}.
        slots:
          orgId: path.orgId
      method: generated
      generated: '2026-10-01'