Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Workflow Scheme…

3 actions 3 updates phrasing extends openapi/atlassian-workflow-scheme-project-associations-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 3

$.info
$.paths['/rest/api/3/workflowscheme/project'].get
$.paths['/rest/api/3/workflowscheme/project'].put

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 Workflow Scheme…
  version: 1.0.0
extends: openapi/atlassian-workflow-scheme-project-associations-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: 2
- target: $.paths['/rest/api/3/workflowscheme/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find which workflow scheme projects use
      effect: read
      questions:
      - Which workflow scheme is a given project using?
      - Can I look up the workflow schemes for several projects at once?
      instructions:
      - text: Show the workflow scheme for project {projectId}.
        slots:
          projectId: query.projectId
      - text: List the workflow schemes associated with projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/workflowscheme/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a workflow scheme to a project
      effect: write
      questions:
      - How do I switch a classic project to a different workflow scheme?
      - Can I assign a workflow scheme to a project that already has issues?
      instructions:
      - text: Assign workflow scheme {workflowSchemeId} to project {projectId}.
        slots:
          workflowSchemeId: requestBody.workflowSchemeId
          projectId: requestBody.projectId
      - text: Put project {projectId} back on the default workflow scheme.
        slots:
          projectId: requestBody.projectId
      method: generated
      generated: '2026-10-01'