Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Jira Settings API

5 actions 5 updates phrasing extends openapi/atlassian-jira-settings-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 5

$.info

$.paths['/rest/api/3/application-properties'].get

$.paths['/rest/api/3/application-properties/advanced-settings'].get

$.paths['/rest/api/3/application-properties/{id}'].put

$.paths['/rest/api/3/configuration'].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 Jira Settings API
  version: 1.0.0
extends: openapi/atlassian-jira-settings-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: 4
- target: $.paths['/rest/api/3/application-properties'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Jira application properties
      effect: read
      questions:
      - What value is a particular Jira application property set to?
      - Can I filter application properties by key prefix or permission level?
      instructions:
      - text: Get the Jira application property {key}.
        slots:
          key: query.key
      - text: List application properties whose keys match {keyFilter}.
        slots:
          keyFilter: query.keyFilter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/application-properties/advanced-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List Jira Advanced Settings
      effect: read
      questions:
      - Which properties appear on Jira's Advanced Settings page?
      - Can I read the Advanced Settings values without opening the admin UI?
      instructions:
      - text: List the properties on Jira's Advanced Settings page.
      - text: Show the current Advanced Settings values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/application-properties/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a Jira application property
      effect: write
      questions:
      - How do I change the clone prefix Jira adds to cloned issues?
      - Can I update an Advanced Settings value through the API?
      instructions:
      - text: Set Jira application property {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Change advanced setting {id} to value {value}.
        slots:
          id: path.id
          value: requestBody.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Jira global feature settings
      effect: read
      questions:
      - Are subtasks and time tracking turned on in our Jira?
      - Which optional global features are enabled on this site?
      instructions:
      - text: Show Jira's global settings for optional features.
      - text: Check whether time tracking, voting and subtasks are enabled site-wide.
      method: generated
      generated: '2026-10-01'