Atlassian · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Security…
17 actions
17 updates
phrasing
extends
openapi/atlassian-issue-security-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.
What the actions change
x-apievangelist-phrasing
Targets 17 · first 16 shown; the file carries all of them
$.info
$.paths['/rest/api/3/issuesecurityschemes'].get
$.paths['/rest/api/3/issuesecurityschemes'].post
$.paths['/rest/api/3/issuesecurityschemes/level'].get
$.paths['/rest/api/3/issuesecurityschemes/level/default'].put
$.paths['/rest/api/3/issuesecurityschemes/level/member'].get
$.paths['/rest/api/3/issuesecurityschemes/project'].get
$.paths['/rest/api/3/issuesecurityschemes/project'].put
$.paths['/rest/api/3/issuesecurityschemes/search'].get
$.paths['/rest/api/3/issuesecurityschemes/{id}'].get
$.paths['/rest/api/3/issuesecurityschemes/{id}'].put
$.paths['/rest/api/3/issuesecurityschemes/{schemeId}'].delete
$.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level'].put
$.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].put
$.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].delete
$.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member'].put
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 Issue Security…
version: 1.0.0
extends: openapi/atlassian-issue-security-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: 16
- target: $.paths['/rest/api/3/issuesecurityschemes'].get
update:
x-apievangelist-phrasing:
intent: List all issue security schemes
effect: read
questions:
- Which issue security schemes exist on my Jira site?
- Can I get every issue security scheme in one unpaginated call?
instructions:
- text: List every issue security scheme in Jira.
- text: Show me all the issue security schemes we have configured.
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes'].post
update:
x-apievangelist-phrasing:
intent: Create an issue security scheme
effect: write
questions:
- How do I set up a new issue security scheme with its levels?
- How many security levels and members can I include when creating a scheme?
instructions:
- text: Create an issue security scheme named {name}.
slots:
name: requestBody.name
- text: Create security scheme {name} with levels {levels}.
slots:
name: requestBody.name
levels: requestBody.levels
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/level'].get
update:
x-apievangelist-phrasing:
intent: List issue security levels
effect: read
questions:
- What security levels are defined across my issue security schemes?
- Can I list only the default security level of each scheme?
instructions:
- text: List the issue security levels in scheme {schemeId}.
slots:
schemeId: query.schemeId
- text: Show only the default issue security levels, filtered to {onlyDefault}.
slots:
onlyDefault: query.onlyDefault
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/level/default'].put
update:
x-apievangelist-phrasing:
intent: Set default issue security levels for schemes
effect: write
questions:
- How do I change which security level a scheme applies by default?
- Can I set default levels for several security schemes in one request?
instructions:
- text: Set the default issue security levels to {defaultValues}.
slots:
defaultValues: requestBody.defaultValues
- text: Update scheme default security levels using {defaultValues}.
slots:
defaultValues: requestBody.defaultValues
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/level/member'].get
update:
x-apievangelist-phrasing:
intent: List members of issue security levels
effect: read
questions:
- Who can see issues at a particular security level?
- Can I filter security level members by scheme or by level?
instructions:
- text: List the members of security level {levelId}.
slots:
levelId: query.levelId
- text: Show all security level members in scheme {schemeId}.
slots:
schemeId: query.schemeId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/project'].get
update:
x-apievangelist-phrasing:
intent: Find projects using issue security schemes
effect: read
questions:
- Which projects are using a given issue security scheme?
- What security scheme is assigned to a specific project?
instructions:
- text: List the projects that use issue security scheme {issueSecuritySchemeId}.
slots:
issueSecuritySchemeId: query.issueSecuritySchemeId
- text: Show which issue security scheme project {projectId} is mapped to.
slots:
projectId: query.projectId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/project'].put
update:
x-apievangelist-phrasing:
intent: Associate a security scheme with a project
effect: write
questions:
- How do I switch a project to a different issue security scheme?
- Can I remap existing issues' security levels when changing a project's scheme?
instructions:
- text: Associate issue security scheme {schemeId} with project {projectId}.
slots:
schemeId: requestBody.schemeId
projectId: requestBody.projectId
- text: Move project {projectId} to security scheme {schemeId}, remapping levels with {oldToNewSecurityLevelMappings}.
slots:
projectId: requestBody.projectId
schemeId: requestBody.schemeId
oldToNewSecurityLevelMappings: requestBody.oldToNewSecurityLevelMappings
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/search'].get
update:
x-apievangelist-phrasing:
intent: Search issue security schemes with paging
effect: read
questions:
- Can I search issue security schemes by ID or project, page by page?
- What's the paginated way to find security schemes tied to certain projects?
instructions:
- text: Search for issue security schemes used by project {projectId}.
slots:
projectId: query.projectId
- text: Find issue security schemes with IDs {id}.
slots:
id: query.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get an issue security scheme and its levels
effect: read
questions:
- What security levels does a particular issue security scheme contain?
- Can a project admin view a single security scheme's details?
instructions:
- text: Get issue security scheme {id} with its levels.
slots:
id: path.id
- text: Show me the details of security scheme {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{id}'].put
update:
x-apievangelist-phrasing:
intent: Rename or redescribe an issue security scheme
effect: write
questions:
- How do I rename an issue security scheme?
- Can I change only the description of an existing security scheme?
instructions:
- text: Rename issue security scheme {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Change the description of security scheme {id} to {description}.
slots:
id: path.id
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an issue security scheme
effect: destructive
questions:
- How do I get rid of an issue security scheme we no longer use?
- What permission is needed to delete an issue security scheme?
instructions:
- text: Delete issue security scheme {schemeId}.
slots:
schemeId: path.schemeId
- text: Permanently remove the security scheme {schemeId} from Jira.
slots:
schemeId: path.schemeId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level'].put
update:
x-apievangelist-phrasing:
intent: Add security levels to a scheme
effect: write
questions:
- Can I add new security levels to an existing issue security scheme?
- How many levels can I add to a scheme per request?
instructions:
- text: Add security levels {levels} to scheme {schemeId}.
slots:
levels: requestBody.levels
schemeId: path.schemeId
- text: Extend issue security scheme {schemeId} with the levels {levels}.
slots:
schemeId: path.schemeId
levels: requestBody.levels
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].put
update:
x-apievangelist-phrasing:
intent: Update an issue security level
effect: write
questions:
- How do I rename a single security level inside a scheme?
- Can I edit a security level's description without touching its members?
instructions:
- text: Rename security level {levelId} in scheme {schemeId} to {name}.
slots:
levelId: path.levelId
schemeId: path.schemeId
name: requestBody.name
- text: Set the description of level {levelId} in scheme {schemeId} to {description}.
slots:
levelId: path.levelId
schemeId: path.schemeId
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an issue security level
effect: destructive
questions:
- What happens to issues at a security level when I delete that level?
- Can I move issues to a replacement level while removing one?
instructions:
- text: Delete security level {levelId} from scheme {schemeId}.
slots:
levelId: path.levelId
schemeId: path.schemeId
- text: Remove level {levelId} from scheme {schemeId} and move its issues to level {replaceWith}.
slots:
levelId: path.levelId
schemeId: path.schemeId
replaceWith: query.replaceWith
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member'].put
update:
x-apievangelist-phrasing:
intent: Add members to an issue security level
effect: write
questions:
- How do I let more users or groups see issues at a security level?
- Is there a cap on members added to a security level at once?
instructions:
- text: Add members {members} to security level {levelId} in scheme {schemeId}.
slots:
members: requestBody.members
levelId: path.levelId
schemeId: path.schemeId
- text: Grant level {levelId} of scheme {schemeId} to {members}.
slots:
levelId: path.levelId
schemeId: path.schemeId
members: requestBody.members
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a member from an issue security level
effect: destructive
questions:
- Can I stop one member from seeing issues at a security level?
- Which IDs do I need to take a member off a security level?
instructions:
- text: Remove member {memberId} from security level {levelId} in scheme {schemeId}.
slots:
memberId: path.memberId
levelId: path.levelId
schemeId: path.schemeId
- text: Revoke member {memberId}'s access to level {levelId} of scheme {schemeId}.
slots:
memberId: path.memberId
levelId: path.levelId
schemeId: path.schemeId
method: generated
generated: '2026-10-01'