Atlassian · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/rest/api/3/projectCategory'].get

$.paths['/rest/api/3/projectCategory'].post

$.paths['/rest/api/3/projectCategory/{id}'].get

$.paths['/rest/api/3/projectCategory/{id}'].put

$.paths['/rest/api/3/projectCategory/{id}'].delete

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 Categories…
  version: 1.0.0
extends: openapi/atlassian-project-categories-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: 5
- target: $.paths['/rest/api/3/projectCategory'].get
  update:
    x-apievangelist-phrasing:
      intent: List all project categories
      effect: read
      questions:
      - What project categories have been set up in our Jira site?
      - Can I see every category used to group projects?
      instructions:
      - text: List all Jira project categories.
      - text: Show me every category available for grouping projects.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectCategory'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project category
      effect: write
      questions:
      - How do I add a new category to group related Jira projects?
      - Can I give a project category a description when I create it?
      instructions:
      - text: Create a project category named {name}.
        slots:
          name: requestBody.name
      - text: Add project category {name} described as {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectCategory/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project category
      effect: read
      questions:
      - What's the name and description of a specific project category?
      - Can I look up a project category by its ID?
      instructions:
      - text: Get project category {id}.
        slots:
          id: path.id
      - text: Show the details of category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectCategory/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a project category
      effect: write
      questions:
      - How do I rename an existing project category?
      - Can I update a category's description later?
      instructions:
      - text: Rename project category {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the description of category {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/projectCategory/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project category
      effect: destructive
      questions:
      - Can I delete a project category we no longer use?
      - Who has permission to remove a project category?
      instructions:
      - text: Delete project category {id}.
        slots:
          id: path.id
      - text: Remove the unused category {id} from Jira.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'