Atlassian · OpenAPI Overlay 1.0.0

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

9 actions 9 updates phrasing extends openapi/atlassian-issue-resolutions-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/resolution'].get
$.paths['/rest/api/3/resolution'].post
$.paths['/rest/api/3/resolution/default'].put
$.paths['/rest/api/3/resolution/move'].put
$.paths['/rest/api/3/resolution/search'].get
$.paths['/rest/api/3/resolution/{id}'].get
$.paths['/rest/api/3/resolution/{id}'].put
$.paths['/rest/api/3/resolution/{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 Resolutions API
  version: 1.0.0
extends: openapi/atlassian-issue-resolutions-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/resolution'].get
  update:
    x-apievangelist-phrasing:
      intent: List all Jira issue resolutions
      effect: read
      questions:
      - What resolution values can a Jira issue be closed with?
      - Can I get every resolution, like Done or Won't Do, in one call?
      instructions:
      - text: List all issue resolutions in Jira.
      - text: Show me every resolution value available.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Jira issue resolution
      effect: write
      questions:
      - How do I add a new resolution such as Duplicate to Jira?
      - Can I give a new resolution a description when creating it?
      instructions:
      - text: Create a resolution named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      - text: Add issue resolution {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default issue resolution
      effect: write
      questions:
      - Can I change which resolution Jira applies by default?
      - Which resolution gets used automatically when none is chosen?
      instructions:
      - text: Make resolution {id} the default.
        slots:
          id: requestBody.id
      - text: Set Jira's default issue resolution to {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/move'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder Jira issue resolutions
      effect: write
      questions:
      - Can I change the order resolutions appear in?
      - Is it possible to move some resolutions to the top or after a specific one?
      instructions:
      - text: Move resolutions {ids} to position {position}.
        slots:
          ids: requestBody.ids
          position: requestBody.position
      - text: Reorder resolutions {ids} to come after resolution {after}.
        slots:
          ids: requestBody.ids
          after: requestBody.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search and page through resolutions
      effect: read
      questions:
      - Can I filter resolutions to only the default one?
      - Which resolutions match a given set of IDs, paginated?
      instructions:
      - text: Search resolutions with IDs {id}.
        slots:
          id: query.id
      - text: Find only the default resolution, onlyDefault {onlyDefault}.
        slots:
          onlyDefault: query.onlyDefault
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Jira resolution
      effect: read
      questions:
      - What's the name and description of a particular resolution ID?
      - Can I look up a single resolution by its ID?
      instructions:
      - text: Get Jira resolution {id}.
        slots:
          id: path.id
      - text: Show me the details of resolution {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or describe a resolution
      effect: write
      questions:
      - Can I rename an existing Jira resolution?
      - Is it possible to edit a resolution's description?
      instructions:
      - text: Rename resolution {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update resolution {id} with name {name} and description {description}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/resolution/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resolution and reassign issues
      effect: destructive
      questions:
      - What happens to issues using a resolution when I delete it?
      - Is deleting a resolution an async task I have to track?
      instructions:
      - text: Delete resolution {id} and replace it on issues with {replaceWith}.
        slots:
          id: path.id
          replaceWith: query.replaceWith
      - text: Remove Jira resolution {id}, moving its issues to resolution {replaceWith}.
        slots:
          id: path.id
          replaceWith: query.replaceWith
      method: generated
      generated: '2026-10-01'