Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-project-types-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 5

$.info

$.paths['/rest/api/3/project/type'].get

$.paths['/rest/api/3/project/type/accessible'].get

$.paths['/rest/api/3/project/type/{projectTypeKey}'].get

$.paths['/rest/api/3/project/type/{projectTypeKey}/accessible'].get

OpenAPI Overlay

# 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 Project Types API
  version: 1.0.0
extends: openapi/atlassian-project-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: 4
- target: $.paths['/rest/api/3/project/type'].get
  update:
    x-apievangelist-phrasing:
      intent: List every Jira project type
      effect: read
      questions:
      - What project types exist in Jira, licensed or not?
      - Can I list software, business and service desk project types anonymously?
      instructions:
      - text: List all Jira project types regardless of license.
      - text: Show every project type the instance knows about.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/type/accessible'].get
  update:
    x-apievangelist-phrasing:
      intent: List licensed project types
      effect: read
      questions:
      - Which project types does my Jira site actually have a license for?
      - Can I see only the project types we're allowed to create?
      instructions:
      - text: List the project types with a valid license.
      - text: Show only licensed Jira project types.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/type/{projectTypeKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project type by key
      effect: read
      questions:
      - What are the details of the software project type?
      - Can I look up any project type by its key without logging in?
      instructions:
      - text: Get project type {projectTypeKey}.
        slots:
          projectTypeKey: path.projectTypeKey
      - text: Show the description and icon of project type {projectTypeKey}.
        slots:
          projectTypeKey: path.projectTypeKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/type/{projectTypeKey}/accessible'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if I can access a project type
      effect: read
      questions:
      - Is a particular project type available to me on this site?
      - Can I confirm a project type is licensed and accessible before creating a project?
      instructions:
      - text: Check whether project type {projectTypeKey} is accessible to me.
        slots:
          projectTypeKey: path.projectTypeKey
      - text: Get project type {projectTypeKey} only if I have access to it.
        slots:
          projectTypeKey: path.projectTypeKey
      method: generated
      generated: '2026-10-01'