API Evangelist conversational phrasing for Jira Cloud platform REST Issue type 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 schemes API
  version: 1.0.0
extends: openapi/jira-issue-type-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: 10
- target: $.paths['/rest/api/3/issuetypescheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue type schemes
      effect: read
      questions:
      - What issue type schemes exist for our classic projects?
      - Can I search issue type schemes by part of their name?
      instructions:
      - text: List all issue type schemes.
      - text: Find issue type schemes whose name contains {queryString}.
        slots:
          queryString: query.queryString
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue type scheme
      effect: write
      questions:
      - How do I create a new issue type scheme with a chosen set of issue types?
      - Does a new issue type scheme need at least one standard issue type?
      instructions:
      - text: Create an issue type scheme named {name} with issue types {issueTypeIds}.
        slots:
          name: requestBody.name
          issueTypeIds: requestBody.issueTypeIds
      - text: Create issue type scheme {name} containing {issueTypeIds} with {defaultIssueTypeId} as the default.
        slots:
          name: requestBody.name
          issueTypeIds: requestBody.issueTypeIds
          defaultIssueTypeId: requestBody.defaultIssueTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List the issue types inside issue type schemes
      effect: read
      questions:
      - Which issue types belong to each issue type scheme?
      - Can I see the issue type members of just certain schemes?
      instructions:
      - text: List the issue type items in every issue type scheme.
      - text: Show which issue types are in issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeSchemeId: query.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find the issue type scheme used by projects
      effect: read
      questions:
      - Which issue type scheme is a given project using?
      - What issue type schemes are assigned to these projects?
      instructions:
      - text: Get the issue type scheme used by project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show the issue type schemes for projects {projectId} and the projects that share each.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign an issue type scheme to a project
      effect: write
      questions:
      - How do I switch a classic project to a different issue type scheme?
      - Why would assigning an issue type scheme to a project fail?
      instructions:
      - text: Assign issue type scheme {issueTypeSchemeId} to project {projectId}.
        slots:
          issueTypeSchemeId: requestBody.issueTypeSchemeId
          projectId: requestBody.projectId
      - text: Switch project {projectId} over to issue type scheme {issueTypeSchemeId}.
        slots:
          projectId: requestBody.projectId
          issueTypeSchemeId: requestBody.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue type scheme's details
      effect: write
      questions:
      - How do I rename an issue type scheme or change its default issue type?
      - Can I edit an issue type scheme's description?
      instructions:
      - text: Rename issue type scheme {issueTypeSchemeId} to {name}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
          name: requestBody.name
      - text: Set the default issue type of scheme {issueTypeSchemeId} to {defaultIssueTypeId}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
          defaultIssueTypeId: requestBody.defaultIssueTypeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type scheme
      effect: destructive
      questions:
      - How do I delete an issue type scheme we no longer need?
      - Can I delete an issue type scheme that's still attached to a project?
      instructions:
      - text: Delete issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Remove the unused issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype'].put
  update:
    x-apievangelist-phrasing:
      intent: Add issue types to an issue type scheme
      effect: write
      questions:
      - How do I add more issue types to an existing issue type scheme?
      - What happens if one of the issue types I add is already in the scheme?
      instructions:
      - text: Add issue types {issueTypeIds} to issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Append issue types {issueTypeIds} to the end of scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder issue types in a scheme
      effect: write
      questions:
      - Can I change the order issue types appear in within an issue type scheme?
      - Is it possible to move issue types to a specific position in a scheme?
      instructions:
      - text: Move issue types {issueTypeIds} after issue type {after} in scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          after: requestBody.after
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Move issue types {issueTypeIds} to the {position} of scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          position: requestBody.position
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an issue type from a scheme
      effect: destructive
      questions:
      - How do I take one issue type out of an issue type scheme?
      - Why can't I remove an issue type that issues are still using from its scheme?
      instructions:
      - text: Remove issue type {issueTypeId} from issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeId: path.issueTypeId
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Drop issue type {issueTypeId} out of scheme {issueTypeSchemeId}.
        slots:
          issueTypeId: path.issueTypeId
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-09-26'