Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Priorities API

9 actions 9 updates phrasing extends openapi/atlassian-issue-priorities-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 9

$.info
$.paths['/rest/api/3/priority'].get
$.paths['/rest/api/3/priority'].post
$.paths['/rest/api/3/priority/default'].put
$.paths['/rest/api/3/priority/move'].put
$.paths['/rest/api/3/priority/search'].get
$.paths['/rest/api/3/priority/{id}'].get
$.paths['/rest/api/3/priority/{id}'].put
$.paths['/rest/api/3/priority/{id}'].delete

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 Issue Priorities API
  version: 1.0.0
extends: openapi/atlassian-issue-priorities-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: 8
- target: $.paths['/rest/api/3/priority'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Jira issue priorities
      effect: read
      questions:
      - What issue priorities are available in our Jira site?
      - Can I get the full unpaginated list of priorities?
      instructions:
      - text: List every issue priority in Jira.
      - text: Show me all priority levels configured on the site.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue priority
      effect: write
      questions:
      - How do I add a new priority level like Urgent to Jira?
      - Which fields are required to create a priority — name and color?
      instructions:
      - text: Create a priority named {name} with status color {statusColor}.
        slots:
          name: requestBody.name
          statusColor: requestBody.statusColor
      - text: Add priority {name}, color {statusColor}, described as {description}.
        slots:
          name: requestBody.name
          statusColor: requestBody.statusColor
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default issue priority
      effect: write
      questions:
      - Which priority do new issues get by default, and can I change it?
      - How do I make Medium the default priority?
      instructions:
      - text: Make priority {id} the default for new issues.
        slots:
          id: requestBody.id
      - text: Set the site default priority to {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/move'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder issue priorities
      effect: write
      questions:
      - Can I change the order priorities appear in?
      - Is it possible to move a priority to the top or after another one?
      instructions:
      - text: Move priorities {ids} to position {position}.
        slots:
          ids: requestBody.ids
          position: requestBody.position
      - text: Reorder priorities {ids} to sit after priority {after}.
        slots:
          ids: requestBody.ids
          after: requestBody.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search priorities by name, ID or project
      effect: read
      questions:
      - Which priorities are used by a specific project?
      - Can I search priorities by name or return only the default one?
      instructions:
      - text: Search priorities named {priorityName}.
        slots:
          priorityName: query.priorityName
      - text: Find the priorities available in project {projectId}.
        slots:
          projectId: query.projectId
      - text: 'Return only the default priority: {onlyDefault}.'
        slots:
          onlyDefault: query.onlyDefault
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue priority
      effect: read
      questions:
      - What color and icon does a specific priority use?
      - Can I look up one priority by its ID?
      instructions:
      - text: Get priority {id}.
        slots:
          id: path.id
      - text: Show the details of issue priority {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue priority
      effect: write
      questions:
      - How do I rename an existing priority or change its color?
      - Can a priority's icon be swapped after it's created?
      instructions:
      - text: Rename priority {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the status color of priority {id} to {statusColor}.
        slots:
          id: path.id
          statusColor: requestBody.statusColor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/priority/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a priority and reassign its issues
      effect: destructive
      questions:
      - What happens to issues using a priority when I delete it?
      - Is deleting a priority synchronous or does it run as a task?
      instructions:
      - text: Delete priority {id} and move its issues to priority {replaceWith}.
        slots:
          id: path.id
          replaceWith: query.replaceWith
      - text: Remove issue priority {id}, replacing it with {replaceWith}.
        slots:
          id: path.id
          replaceWith: query.replaceWith
      method: generated
      generated: '2026-10-01'