Atlassian · OpenAPI Overlay 1.0.0

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

8 actions 8 updates phrasing extends openapi/atlassian-myself-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 8

$.info
$.paths['/rest/api/3/mypreferences'].get
$.paths['/rest/api/3/mypreferences'].put
$.paths['/rest/api/3/mypreferences'].delete
$.paths['/rest/api/3/mypreferences/locale'].get
$.paths['/rest/api/3/mypreferences/locale'].put
$.paths['/rest/api/3/mypreferences/locale'].delete
$.paths['/rest/api/3/myself'].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 The Jira Cloud platform REST Myself API
  version: 1.0.0
extends: openapi/atlassian-myself-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: 7
- target: $.paths['/rest/api/3/mypreferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one of my Jira preferences
      effect: read
      questions:
      - How do I read the value of one of my Jira user preferences?
      - Can I check a custom preference key I stored for myself?
      instructions:
      - text: Get my preference {key}.
        slots:
          key: query.key
      - text: Read the value of my user setting {key}.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/mypreferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one of my Jira preferences
      effect: write
      questions:
      - How do I create or change a personal preference in Jira?
      - How long can a custom preference value be?
      instructions:
      - text: Set my preference {key}.
        slots:
          key: query.key
      - text: Create or update my user setting {key} with a new value.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/mypreferences'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of my Jira preferences
      effect: destructive
      questions:
      - How do I reset a Jira preference back to its default?
      - Can I remove a custom preference I stored?
      instructions:
      - text: Delete my preference {key}.
        slots:
          key: query.key
      - text: Reset user setting {key} to its default.
        slots:
          key: query.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/mypreferences/locale'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Jira locale
      effect: read
      questions:
      - What language and locale is Jira using for me?
      - Which locale is returned if I never set a language preference?
      instructions:
      - text: Get my Jira locale.
      - text: Show which locale Jira uses for me.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/mypreferences/locale'].put
  update:
    x-apievangelist-phrasing:
      intent: Set my Jira locale (deprecated)
      effect: write
      questions:
      - How do I change my Jira language through the older locale endpoint?
      - Can I set my locale to any language, or only ones the site supports?
      instructions:
      - text: Set my Jira locale to {locale}.
        slots:
          locale: requestBody.locale
      - text: Change my language to {locale} via the deprecated locale call.
        slots:
          locale: requestBody.locale
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/mypreferences/locale'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset my Jira locale (deprecated)
      effect: destructive
      questions:
      - How do I clear my Jira locale so it falls back to the default?
      - Can I remove my language setting with the old locale endpoint?
      instructions:
      - text: Clear my Jira locale setting.
      - text: Reset my language to the instance default.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/myself'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my Jira user profile
      effect: read
      questions:
      - How do I find out who I'm authenticated as in Jira?
      - Can I get my own groups and application roles along with my profile?
      instructions:
      - text: Show my current Jira user details.
      - text: Get my profile expanded with {expand}.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-10-01'