API Evangelist conversational phrasing for Jira Cloud platform REST Issue type screen schemes API

# 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 Issue type screen schemes API
  version: 1.0.0
extends: openapi/jira-issue-type-screen-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: 11
- target: $.paths['/rest/api/3/issuetypescreenscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type screen schemes
      effect: read
      questions:
      - What issue type screen schemes are set up on my site?
      - Can I search issue type screen schemes by part of their name?
      - How do I sort issue type screen schemes by name or ID?
      instructions:
      - text: List all issue type screen schemes.
      - text: Find issue type screen schemes whose name contains {queryString}.
        slots:
          queryString: query.queryString
      - text: List issue type screen schemes ordered by {orderBy}.
        slots:
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- 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 scheme that assigns different screen schemes to different issue types?
      - Do I need a default mapping when creating an issue type screen scheme?
      instructions:
      - text: Create issue type screen scheme {name} with mappings {issueTypeMappings}.
        slots:
          name: requestBody.name
          issueTypeMappings: requestBody.issueTypeMappings
      - text: Create a new issue type screen scheme {name}, described as {description}, using mappings {issueTypeMappings}.
        slots:
          name: requestBody.name
          description: requestBody.description
          issueTypeMappings: requestBody.issueTypeMappings
      method: generated
      generated: '2026-09-26'
- 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 does each issue type use across my issue type screen schemes?
      - Can I list the mapping items for specific issue type screen schemes?
      instructions:
      - text: List the issue type to screen scheme items in issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: query.issueTypeScreenSchemeId
      - text: Show all issue type screen scheme mapping items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescreenscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the issue type screen scheme for projects
      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: Show the issue type screen scheme used by project {projectId}.
        slots:
          projectId: query.projectId
      - text: Get the issue type screen schemes for projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- 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 apply an issue type screen scheme to a project?
      - Can team-managed projects be given an issue type screen scheme?
      instructions:
      - text: Assign issue type screen scheme {issueTypeScreenSchemeId} to project {projectId}.
        slots:
          issueTypeScreenSchemeId: requestBody.issueTypeScreenSchemeId
          projectId: requestBody.projectId
      - text: Make project {projectId} use issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          projectId: requestBody.projectId
          issueTypeScreenSchemeId: requestBody.issueTypeScreenSchemeId
      method: generated
      generated: '2026-09-26'
- 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?
      - What's the length limit on an issue type screen scheme description?
      instructions:
      - text: Rename issue type screen scheme {issueTypeScreenSchemeId} to {name}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          name: requestBody.name
      - text: Change the description of issue type screen scheme {issueTypeScreenSchemeId} to {description}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- 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 issue type screen scheme I no longer need?
      - Can I remove an unused issue type screen scheme?
      instructions:
      - text: Delete issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Remove the issue type screen scheme {issueTypeScreenSchemeId} from the site.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-09-26'
- 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 add another issue type to an existing issue type screen scheme?
      - Can I change the default entry while appending mappings?
      instructions:
      - text: Append mappings {issueTypeMappings} to issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeMappings: requestBody.issueTypeMappings
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Map more issue types to screen schemes in {issueTypeScreenSchemeId} using {issueTypeMappings}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          issueTypeMappings: requestBody.issueTypeMappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the default screen scheme for unmapped types
      effect: write
      questions:
      - How do I change the screen scheme used for issue types that aren't mapped explicitly?
      - Can I swap the default screen scheme inside an issue type screen scheme?
      instructions:
      - text: Set the default screen scheme of issue type screen scheme {issueTypeScreenSchemeId} to {screenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
          screenSchemeId: requestBody.screenSchemeId
      - text: Use screen scheme {screenSchemeId} for all unmapped issue types in {issueTypeScreenSchemeId}.
        slots:
          screenSchemeId: requestBody.screenSchemeId
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-09-26'
- 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 issue types from an issue type screen scheme?
      - Can I remove several issue types' screen scheme mappings at once?
      instructions:
      - text: Remove issue types {issueTypeIds} from issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Unmap {issueTypeIds} so they fall back to the default in {issueTypeScreenSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-09-26'
- 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 company-managed projects use a given issue type screen scheme?
      - Is an issue type screen scheme still in use by any project?
      instructions:
      - text: List the projects associated with issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      - text: Search projects matching {query} that use issue type screen scheme {issueTypeScreenSchemeId}.
        slots:
          query: query.query
          issueTypeScreenSchemeId: path.issueTypeScreenSchemeId
      method: generated
      generated: '2026-09-26'