Atlassian · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/rest/api/3/issuetypescheme'].get
$.paths['/rest/api/3/issuetypescheme'].post
$.paths['/rest/api/3/issuetypescheme/mapping'].get
$.paths['/rest/api/3/issuetypescheme/project'].get
$.paths['/rest/api/3/issuetypescheme/project'].put
$.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].put
$.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].delete
$.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype'].put
$.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move'].put
$.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId}'].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 Type Schemes…
  version: 1.0.0
extends: openapi/atlassian-issue-type-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: 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 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}, ordered by {orderBy}.
        slots:
          queryString: query.queryString
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- 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 set of allowed issue types for projects?
      - Can I pick a default issue type when creating a scheme?
      instructions:
      - text: Create an issue type scheme named {name} with issue types {issueTypeIds}.
        slots:
          name: requestBody.name
          issueTypeIds: requestBody.issueTypeIds
      - text: Create scheme {name} containing {issueTypeIds} with {defaultIssueTypeId} as the default.
        slots:
          name: requestBody.name
          issueTypeIds: requestBody.issueTypeIds
          defaultIssueTypeId: requestBody.defaultIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescheme/mapping'].get
  update:
    x-apievangelist-phrasing:
      intent: List the issue types inside schemes
      effect: read
      questions:
      - Which issue types belong to each issue type scheme?
      - What items make up a specific issue type scheme?
      instructions:
      - text: List the issue type scheme items.
      - text: Show which issue types are in scheme {issueTypeSchemeId}.
        slots:
          issueTypeSchemeId: query.issueTypeSchemeId
      method: generated
      generated: '2026-10-01'
- 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 does a given project use?
      - Can I look up the schemes for several projects at once?
      instructions:
      - text: Show the issue type scheme for project {projectId}.
        slots:
          projectId: query.projectId
      - text: List issue type schemes and their projects for projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- 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 project to a different issue type scheme?
      - Why would assigning a new 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: Make project {projectId} use scheme {issueTypeSchemeId}.
        slots:
          projectId: requestBody.projectId
          issueTypeSchemeId: requestBody.issueTypeSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue type scheme
      effect: write
      questions:
      - How do I rename an issue type scheme?
      - Can I change the default issue type of an existing scheme?
      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-10-01'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type scheme
      effect: destructive
      questions:
      - What happens to projects when I delete their issue type scheme?
      - Can team-managed schemes be deleted, or only classic ones?
      instructions:
      - text: Delete issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Remove scheme {issueTypeSchemeId} and move its projects to the default scheme.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype'].put
  update:
    x-apievangelist-phrasing:
      intent: Add issue types to a scheme
      effect: write
      questions:
      - How do I allow a new issue type in an existing scheme?
      - What if one of the issue types I add is already in the scheme?
      instructions:
      - text: Add issue types {issueTypeIds} to scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Append {issueTypeIds} to the end of issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-10-01'
- 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 a scheme?
      - How do I move an issue type to the first position of a scheme?
      instructions:
      - text: Move issue types {issueTypeIds} in scheme {issueTypeSchemeId} to position {position}.
        slots:
          issueTypeIds: requestBody.issueTypeIds
          issueTypeSchemeId: path.issueTypeSchemeId
          position: requestBody.position
      - text: Reorder scheme {issueTypeSchemeId} so {issueTypeIds} come after issue type {after}.
        slots:
          issueTypeSchemeId: path.issueTypeSchemeId
          issueTypeIds: requestBody.issueTypeIds
          after: requestBody.after
      method: generated
      generated: '2026-10-01'
- 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 an issue type out of an issue type scheme?
      - Which issue types can't be removed from a scheme?
      instructions:
      - text: Remove issue type {issueTypeId} from scheme {issueTypeSchemeId}.
        slots:
          issueTypeId: path.issueTypeId
          issueTypeSchemeId: path.issueTypeSchemeId
      - text: Drop type {issueTypeId} from issue type scheme {issueTypeSchemeId}.
        slots:
          issueTypeId: path.issueTypeId
          issueTypeSchemeId: path.issueTypeSchemeId
      method: generated
      generated: '2026-10-01'