Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-project-permission-schemes-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/{projectKeyOrId}/issuesecuritylevelscheme'].get

$.paths['/rest/api/3/project/{projectKeyOrId}/permissionscheme'].get

$.paths['/rest/api/3/project/{projectKeyOrId}/permissionscheme'].put

$.paths['/rest/api/3/project/{projectKeyOrId}/securitylevel'].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 Permission…
  version: 1.0.0
extends: openapi/atlassian-project-permission-schemes-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/{projectKeyOrId}/issuesecuritylevelscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's issue security scheme
      effect: read
      questions:
      - Which issue security scheme controls who can see issues in a project?
      - Does a project have an issue security scheme assigned?
      instructions:
      - text: Show the issue security scheme for project {projectKeyOrId}.
        slots:
          projectKeyOrId: path.projectKeyOrId
      - text: Tell me which security scheme governs issue visibility in {projectKeyOrId}.
        slots:
          projectKeyOrId: path.projectKeyOrId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectKeyOrId}/permissionscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's permission scheme
      effect: read
      questions:
      - Which permission scheme is a project using?
      - Who is allowed to do what in a given project?
      instructions:
      - text: Show the permission scheme for project {projectKeyOrId}.
        slots:
          projectKeyOrId: path.projectKeyOrId
      - text: Get the permission scheme of {projectKeyOrId} with {expand} expanded.
        slots:
          projectKeyOrId: path.projectKeyOrId
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectKeyOrId}/permissionscheme'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a permission scheme to a project
      effect: write
      questions:
      - How do I switch a project to a different permission scheme?
      - Can I apply one permission scheme to a project by its scheme ID?
      instructions:
      - text: Assign permission scheme {id} to project {projectKeyOrId}.
        slots:
          id: requestBody.id
          projectKeyOrId: path.projectKeyOrId
      - text: Make {projectKeyOrId} use permission scheme {id}.
        slots:
          projectKeyOrId: path.projectKeyOrId
          id: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectKeyOrId}/securitylevel'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's issue security levels
      effect: read
      questions:
      - What security levels can I set on issues in a project?
      - Which issue security levels do I have access to in a given project?
      instructions:
      - text: List the issue security levels for project {projectKeyOrId}.
        slots:
          projectKeyOrId: path.projectKeyOrId
      - text: Show which security levels I can apply to issues in {projectKeyOrId}.
        slots:
          projectKeyOrId: path.projectKeyOrId
      method: generated
      generated: '2026-10-01'