Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Admin Domains API

3 actions 3 updates phrasing extends openapi/atlassian-domains-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/{orgId}/domains'].get
$.paths['/v1/orgs/{orgId}/domains/{domainId}'].get

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 Atlassian Admin Domains API
  version: 1.0.0
extends: openapi/atlassian-domains-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/{orgId}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's claimed domains
      effect: read
      questions:
      - Which email domains has our Atlassian organization claimed?
      - What domains are verified for an organization?
      instructions:
      - text: List the domains for organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Show the next page of domains for {orgId} after cursor {cursor}.
        slots:
          orgId: path.orgId
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{orgId}/domains/{domainId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one organization domain
      effect: read
      questions:
      - What is the verification status of a specific domain in our org?
      - Can I look up a single claimed domain by its ID?
      instructions:
      - text: Get domain {domainId} in organization {orgId}.
        slots:
          domainId: path.domainId
          orgId: path.orgId
      - text: Show the details of domain {domainId} for {orgId}.
        slots:
          domainId: path.domainId
          orgId: path.orgId
      method: generated
      generated: '2026-10-01'