# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Priority schemes API
  version: 1.0.0
extends: openapi/jira-priority-schemes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/rest/api/3/priorityscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List priority schemes
      effect: read
      questions:
      - What priority schemes are configured in Jira?
      - Can I find which priority schemes include a specific priority?
      - Is there a way to list only the default priority scheme?
      instructions:
      - text: List all priority schemes.
      - text: Find priority schemes named {schemeName}.
        slots:
          schemeName: query.schemeName
      - text: Show priority schemes that contain priority {priorityId}.
        slots:
          priorityId: query.priorityId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a priority scheme
      effect: write
      questions:
      - How do I create a priority scheme with its own set of priorities?
      - Can I assign projects to a new priority scheme when creating it?
      instructions:
      - text: Create priority scheme {name} with priorities {priorityIds} and default {defaultPriorityId}.
        slots:
          name: requestBody.name
          priorityIds: requestBody.priorityIds
          defaultPriorityId: requestBody.defaultPriorityId
      - text: Create priority scheme {name} using priorities {priorityIds}, default {defaultPriorityId}, for projects {projectIds}.
        slots:
          name: requestBody.name
          priorityIds: requestBody.priorityIds
          defaultPriorityId: requestBody.defaultPriorityId
          projectIds: requestBody.projectIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview priorities that need remapping
      effect: read
      questions:
      - If I change a priority scheme, which priorities will need mapping to new ones?
      - Can I preview the remapping required before moving projects to another priority scheme?
      instructions:
      - text: Show which priorities would need mapping for scheme {schemeId} given priority changes {priorities}.
        slots:
          schemeId: requestBody.schemeId
          priorities: requestBody.priorities
      - text: Preview the priority mappings required if projects {projects} join scheme {schemeId}.
        slots:
          projects: requestBody.projects
          schemeId: requestBody.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/priorities/available'].get
  update:
    x-apievangelist-phrasing:
      intent: List priorities available to add to a scheme
      effect: read
      questions:
      - Which priorities can I still add to a priority scheme?
      - Can I search the priorities not yet in a scheme by name?
      instructions:
      - text: List priorities available to add to priority scheme {schemeId}.
        slots:
          schemeId: query.schemeId
      - text: Search priorities matching {query} that could be added to scheme {schemeId}.
        slots:
          query: query.query
          schemeId: query.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/{schemeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a priority scheme
      effect: write
      questions:
      - How can I change the default priority of an existing priority scheme?
      - Can I add or remove projects and priorities on a priority scheme in one update?
      instructions:
      - text: Rename priority scheme {schemeId} to {name}.
        slots:
          schemeId: path.schemeId
          name: requestBody.name
      - text: Set the default priority of scheme {schemeId} to {defaultPriorityId}.
        slots:
          schemeId: path.schemeId
          defaultPriorityId: requestBody.defaultPriorityId
      - text: Update the projects on priority scheme {schemeId} with {projects} using mappings {mappings}.
        slots:
          schemeId: path.schemeId
          projects: requestBody.projects
          mappings: requestBody.mappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/{schemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a priority scheme
      effect: destructive
      questions:
      - Can I delete a priority scheme that still has projects attached?
      - What is required before removing a priority scheme?
      instructions:
      - text: Delete priority scheme {schemeId}.
        slots:
          schemeId: path.schemeId
      - text: Remove the unused priority scheme {schemeId}.
        slots:
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/{schemeId}/priorities'].get
  update:
    x-apievangelist-phrasing:
      intent: List priorities in a priority scheme
      effect: read
      questions:
      - Which priorities are included in a given priority scheme?
      - Can I page through the priorities of one scheme?
      instructions:
      - text: List the priorities in priority scheme {schemeId}.
        slots:
          schemeId: path.schemeId
      - text: Show the first {maxResults} priorities of scheme {schemeId}.
        slots:
          maxResults: query.maxResults
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/priorityscheme/{schemeId}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects using a priority scheme
      effect: read
      questions:
      - Which projects use a particular priority scheme?
      - Can I search a priority scheme's projects by name?
      instructions:
      - text: List the projects on priority scheme {schemeId}.
        slots:
          schemeId: path.schemeId
      - text: Find projects matching {query} that use priority scheme {schemeId}.
        slots:
          query: query.query
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'