Jira · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jira Issue Types API

10 actions 10 updates phrasing extends openapi/jira-issue-types-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/issuetype'].get
$.paths['/rest/api/3/issuetype'].get
$.paths['/rest/api/3/issuetype'].post
$.paths['/rest/api/3/issuetype/project'].get
$.paths['/rest/api/3/issuetype/{id}'].get
$.paths['/rest/api/3/issuetype/{id}'].put
$.paths['/rest/api/3/issuetype/{id}'].delete
$.paths['/rest/api/3/issuetype/{id}/alternatives'].get
$.paths['/rest/api/3/issuetype/{id}/avatar2'].post

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 Jira Issue Types API
  version: 1.0.0
extends: openapi/jira-issue-types-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: 9
- target: $.paths['/issuetype'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue types via the legacy unversioned path
      effect: read
      questions:
      - Is there an older unversioned endpoint that lists the issue types visible to me?
      - What does the legacy /issuetype path return for my user?
      instructions:
      - text: Use the legacy unversioned issuetype path to list issue types I can see.
      - text: Call the older /issuetype endpoint for my visible issue types.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetype'].get
  update:
    x-apievangelist-phrasing:
      intent: List all issue types via REST API v3
      effect: read
      questions:
      - Which issue types exist across the Jira site in the v3 API?
      - Why do I see fewer issue types than a Jira admin does?
      instructions:
      - text: List all issue types using the v3 REST API.
      - text: Get every issue type available to me from /rest/api/3/issuetype.
      method: generated
      generated: '2026-09-26'
- 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 to Jira?
      - Can I create a subtask-level issue type?
      instructions:
      - text: Create an issue type called {name}.
        slots:
          name: requestBody.name
      - text: Create issue type {name} at hierarchy level {hierarchyLevel} described as {description}.
        slots:
          name: requestBody.name
          hierarchyLevel: requestBody.hierarchyLevel
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetype/project'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue types for a project
      effect: read
      questions:
      - Which issue types can be used in a particular project?
      - Can I list only the epic-level issue types in a 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-09-26'
- target: $.paths['/rest/api/3/issuetype/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one issue type
      effect: read
      questions:
      - What are the details of a specific issue type by ID?
      - Is a given issue type a subtask or a standard type?
      instructions:
      - text: Get issue type {id}.
        slots:
          id: path.id
      - text: Show the name, description and hierarchy level of issue type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- 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 or change its avatar?
      - Is there a length limit on an issue type's name?
      instructions:
      - text: Rename issue type {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the avatar of issue type {id} to avatar {avatarId}.
        slots:
          id: path.id
          avatarId: requestBody.avatarId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetype/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type
      effect: destructive
      questions:
      - How do I delete an issue type that's still used by issues?
      - What happens to existing issues when their issue type is deleted?
      instructions:
      - text: Delete issue type {id}.
        slots:
          id: path.id
      - text: Delete issue type {id} and move its issues to issue type {alternativeIssueTypeId}.
        slots:
          id: path.id
          alternativeIssueTypeId: query.alternativeIssueTypeId
      method: generated
      generated: '2026-09-26'
- 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 plan to delete?
      - What issue types share the same workflow, field and screen schemes as this one?
      instructions:
      - text: List alternative issue types for issue type {id}.
        slots:
          id: path.id
      - text: Show which issue types can take over for issue type {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuetype/{id}/avatar2'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an avatar image for an issue type
      effect: write
      questions:
      - How do I upload a custom icon for an issue type?
      - Which image formats can an issue type avatar use, and can I crop it?
      instructions:
      - text: Upload this image as the avatar for issue type {id}, cropped to {size} pixels.
        slots:
          id: path.id
          size: query.size
      - text: Load an issue type avatar for {id} cropping a {size} square from x {x} and y {y}.
        slots:
          id: path.id
          size: query.size
          x: query.x
          y: query.y
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/jira-issue-types-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.