Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Type Screen…

12 actions 12 updates phrasing extends openapi/atlassian-issue-type-screen-schemes-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 12

$.info
$.paths['/rest/api/3/issuetypescreenscheme'].get
$.paths['/rest/api/3/issuetypescreenscheme'].post
$.paths['/rest/api/3/issuetypescreenscheme/mapping'].get
$.paths['/rest/api/3/issuetypescreenscheme/project'].get
$.paths['/rest/api/3/issuetypescreenscheme/project'].put
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}'].put
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}'].delete
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping'].put
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default'].put
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove'].post
$.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project'].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 Issue Type Screen…
  version: 1.0.0
extends: openapi/atlassian-issue-type-screen-schemes-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: 11
- target: $.paths['/rest/api/3/issuetypescreenscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type screen schemes
      effect: read
      questions:
      - Which issue type screen schemes exist in my Jira site?
      - Can I search issue type screen schemes by name?
      instructions:
      - text: List all issue type screen schemes.
      - text: Find issue type screen schemes whose name contains {queryString}.
        slots:
          queryString: query.queryString
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue type screen scheme
      effect: write
      questions:
      - How do I create a new issue type screen scheme in Jira?
      - What mappings are required to set up an issue type screen scheme?
      instructions:
      - text: Create issue type screen scheme {name} with mappings {issueTypeMappings}.
        slots:
          name: requestBody.name
          issueTypeMappings: requestBody.issueTypeMappings
      - text: Set up a new issue type screen scheme named {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type to screen scheme mappings
      effect: read
      questions:
      - Which screen scheme is mapped to each issue type?
      - Can I see the items inside a particular issue type screen scheme?
      instructions:
      - text: List the issue type mappings in screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: query.issueTypeScreenSchemeId
      - text: Show every issue type screen scheme item.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which issue type screen scheme a project uses
      effect: read
      questions:
      - Which issue type screen scheme does my project use?
      - Can I look up issue type screen schemes for several projects at once?
      instructions:
      - text: Get the issue type screen scheme used by project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show which screen scheme each of projects {projectId} is on.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign an issue type screen scheme to a project
      effect: write
      questions:
      - How do I switch a classic project to a different issue type screen scheme?
      - Can issue type screen schemes be assigned to team-managed projects?
      instructions:
      - text: Assign issue type screen scheme {issueTypeScreenSchemeId} to project {projectId}.
        slots:
          issueTypeScreenSchemeId: requestBody.issueTypeScreenSchemeId
          projectId: requestBody.projectId
      - text: Put project {projectId} on screen scheme {issueTypeScreenSchemeId}.
        slots:
          projectId: requestBody.projectId
          issueTypeScreenSchemeId: requestBody.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe an issue type screen scheme
      effect: write
      questions:
      - How do I rename an issue type screen scheme?
      - Can I update the description of an existing issue type screen scheme?
      instructions:
      - text: Rename issue type screen scheme {issueTypeScreenSchemeId} to {name}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          name: requestBody.name
      - text: Change the description of screen scheme {issueTypeScreenSchemeId} to {description}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type screen scheme
      effect: destructive
      questions:
      - How do I delete an unused issue type screen scheme?
      - Can I remove an issue type screen scheme permanently?
      instructions:
      - text: Delete issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Remove the obsolete issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping'].put
  update:
    x-apievangelist-phrasing:
      intent: Add issue type mappings to a screen scheme
      effect: write
      questions:
      - How do I map an additional issue type to a screen scheme?
      - Can I append new issue type mappings without replacing the existing ones?
      instructions:
      - text: Append mappings {issueTypeMappings} to issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeMappings: requestBody.issueTypeMappings
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Add issue type to screen scheme mappings on {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the default screen scheme for unmapped issue types
      effect: write
      questions:
      - Which screen scheme do unmapped issue types fall back to, and how do I change it?
      - How do I update the default screen scheme of an issue type screen scheme?
      instructions:
      - text: Set the default screen scheme of {issueTypeScreenSchemeId} to {screenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          screenSchemeId: requestBody.screenSchemeId
      - text: Make screen scheme {screenSchemeId} the fallback for unmapped issue types in {issueTypeScreenSchemeId}.
        slots:
          screenSchemeId: requestBody.screenSchemeId
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove issue type mappings from a screen scheme
      effect: destructive
      questions:
      - How do I unmap an issue type from an issue type screen scheme?
      - Can I remove several issue type mappings at once?
      instructions:
      - text: Remove issue types {issueTypeIds} from issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Unmap issue type {issueTypeIds} in screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/project'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects using an issue type screen scheme
      effect: read
      questions:
      - Which projects use this issue type screen scheme?
      - Can I search the projects tied to an issue type screen scheme by name?
      instructions:
      - text: List projects associated with issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Find projects matching {query} that use screen scheme {issueTypeScreenSchemeId}.
        slots:
          query: query.query
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-10-01'