API Evangelist enrichment overlay for The Jira Cloud platform REST API

overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for The Jira Cloud platform REST API
  version: '1.0.0'
extends: openapi/atlassian-jira-platform-openapi.json
x-provenance:
  generated: '2026-09-06'
  method: generated
  source: |
    Generated by the API Evangelist enrichment pipeline against the first-party Atlassian OpenAPI
    definition harvested verbatim from https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json on 2026-09-06.
    This overlay records API Evangelist enrichments only; the original specification is never mutated.
  base_operations: 617
  base_deprecated_operations: 29
actions:
- target: $.info
  description: Record provenance of the harvested definition and the artifacts derived from it.
  update:
    x-apievangelist-provider: atlassian-jira
    x-apievangelist-harvested: '2026-09-06'
    x-apievangelist-source: https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
    x-apievangelist-artifacts:
      authentication: authentication/atlassian-jira-authentication.yml
      scopes: scopes/atlassian-jira-scopes.yml
      errors: errors/atlassian-jira-problem-types.yml
      conventions: conventions/atlassian-jira-conventions.yml
      lifecycle: lifecycle/atlassian-jira-lifecycle.yml
      rate_limits: rate-limits/atlassian-jira-rate-limits.yml
      data_model: data-model/atlassian-jira-data-model.yml
      tool_crosswalk: mcp/atlassian-jira-tool-crosswalk.yml
- target: $.info
  description: Cross-link the runtime rate-limit contract that is documented outside the specification.
  update:
    x-rate-limit-docs: https://developer.atlassian.com/cloud/jira/platform/rate-limiting/
    x-rate-limit-status: 429
    x-rate-limit-headers:
    - X-RateLimit-Limit
    - X-RateLimit-Remaining
    - X-RateLimit-Reset
    - X-RateLimit-NearLimit
    - RateLimit-Reason
    - Retry-After
- target: $.info
  description: Record the Atlassian REST API deprecation policy that governs every operation in this document.
  update:
    x-deprecation-policy: https://developer.atlassian.com/platform/marketplace/atlassian-rest-api-policy/
    x-deprecation-notice-period: P6M
    x-changelog: https://developer.atlassian.com/changelog/
- target: $.servers
  description: |
    Note the second, non-templated calling host. The specification's own server is the tenant site
    (https://your-domain.atlassian.net); an OAuth 2.0 (3LO) app calls the identical paths through the
    Atlassian gateway at https://api.atlassian.com/ex/jira/{cloudId} instead.
  update:
    x-alternate-oauth-host: https://api.atlassian.com/ex/jira/{cloudId}
    x-cloudid-discovery: https://api.atlassian.com/oauth/token/accessible-resources