Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Admin Policies API

4 actions 4 updates phrasing extends openapi/atlassian-policies-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['/v1/orgs/{orgId}/policies'].get

$.paths['/v1/orgs/{orgId}/policies/{policyId}'].get

$.paths['/v1/orgs/{orgId}/policies/{policyId}'].put

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 Policies API
  version: 1.0.0
extends: openapi/atlassian-policies-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['/v1/orgs/{orgId}/policies'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's policies
      effect: read
      questions:
      - Which security and data residency policies are set up for my Atlassian organization?
      - Can I filter my org's policies by type?
      instructions:
      - text: List the policies for organization {orgId}.
        slots:
          orgId: path.orgId
      - text: Show org {orgId} policies of type {type}.
        slots:
          orgId: path.orgId
          type: query.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{orgId}/policies/{policyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization policy
      effect: read
      questions:
      - How do I see the details of a single org policy?
      - What attributes and status does this policy have?
      instructions:
      - text: Get policy {policyId} in organization {orgId}.
        slots:
          policyId: path.policyId
          orgId: path.orgId
      - text: Show me the configuration of org policy {policyId}.
        slots:
          policyId: path.policyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/orgs/{orgId}/policies/{policyId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an organization policy
      effect: write
      questions:
      - How do I disable or rename an existing org policy?
      - Can I change a policy's attributes after it's created?
      instructions:
      - text: Set policy {policyId} in org {orgId} to status {status}.
        slots:
          policyId: path.policyId
          orgId: path.orgId
          status: requestBody.status
      - text: Rename org policy {policyId} to {name}.
        slots:
          policyId: path.policyId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'