API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Types API

# 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 Types API
  version: 1.0.0
extends: openapi/atlassian-issue-types-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: 8
- target: $.paths['/rest/api/3/issuetype'].get
  update:
    x-apievangelist-phrasing:
      intent: List all issue types
      effect: read
      questions:
      - What issue types exist across my Jira site?
      - Which issue types am I allowed to see as a non-admin?
      instructions:
      - text: List every issue type in Jira.
      - text: Show all issue types visible to me site-wide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue type
      effect: write
      questions:
      - How do I add a new issue type like Incident to Jira?
      - Can I create a subtask-level issue type?
      instructions:
      - text: Create an issue type named {name}.
        slots:
          name: requestBody.name
      - text: Add issue type {name} at hierarchy level {hierarchyLevel} with description {description}.
        slots:
          name: requestBody.name
          hierarchyLevel: requestBody.hierarchyLevel
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/project'].get
  update:
    x-apievangelist-phrasing:
      intent: List the issue types in a project
      effect: read
      questions:
      - Which issue types can I create in a specific project?
      - Can I list only epic-level issue types for one project?
      instructions:
      - text: List the issue types for project {projectId}.
        slots:
          projectId: query.projectId
      - text: Show issue types at level {level} in project {projectId}.
        slots:
          level: query.level
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue type
      effect: read
      questions:
      - What are the details of one issue type, like its hierarchy level and icon?
      - Is a given issue type a subtask type?
      instructions:
      - text: Get issue type {id}.
        slots:
          id: path.id
      - text: Show the name, level and avatar of issue type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an issue type
      effect: write
      questions:
      - How do I rename an issue type?
      - Can I change an issue type's icon to another avatar?
      instructions:
      - text: Rename issue type {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set issue type {id}'s avatar to {avatarId}.
        slots:
          id: path.id
          avatarId: requestBody.avatarId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type
      effect: destructive
      questions:
      - What happens to existing issues when I delete an issue type?
      - Can I move issues to a replacement type while deleting their old type?
      instructions:
      - text: Delete issue type {id}.
        slots:
          id: path.id
      - text: Delete issue type {id} and move its issues to {alternativeIssueTypeId}.
        slots:
          id: path.id
          alternativeIssueTypeId: query.alternativeIssueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{id}/alternatives'].get
  update:
    x-apievangelist-phrasing:
      intent: List replacement issue types for an issue type
      effect: read
      questions:
      - Which issue types could replace one I'm about to delete?
      - What issue types share the same schemes as a given type?
      instructions:
      - text: List alternative issue types that could replace {id}.
        slots:
          id: path.id
      - text: Show valid substitutes for issue type {id} before I delete it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{id}/avatar2'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an avatar for an issue type
      effect: write
      questions:
      - How do I upload a custom icon image for an issue type?
      - Can I crop the image when loading an issue type avatar?
      instructions:
      - text: Upload a new avatar for issue type {id} at size {size}.
        slots:
          id: path.id
          size: query.size
      - text: Load an icon for issue type {id}, cropped from {x},{y} at size {size}.
        slots:
          id: path.id
          x: query.x
          y: query.y
          size: query.size
      method: generated
      generated: '2026-10-01'