API Evangelist conversational phrasing for Jira Cloud platform REST Issue security schemes API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue security schemes API
  version: 1.0.0
extends: openapi/jira-issue-security-schemes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      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:
      - What issue security schemes exist on my Jira site?
      - Can I get every issue security scheme in one unfiltered call?
      instructions:
      - text: List all issue security schemes.
      - text: Show me every issue security scheme configured on the site, unfiltered.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an issue security scheme
      effect: write
      questions:
      - How do I create a new issue security scheme to restrict who sees issues?
      - Can I add security levels and their members while creating the scheme?
      - How many security levels can be included when a scheme is first created?
      instructions:
      - text: Create an issue security scheme named {name}.
        slots:
          name: requestBody.name
      - text: 'Create security scheme {name} described as {description} with these levels: {levels}.'
        slots:
          name: requestBody.name
          description: requestBody.description
          levels: requestBody.levels
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/level'].get
  update:
    x-apievangelist-phrasing:
      intent: List issue security levels across schemes
      effect: read
      questions:
      - Which security levels are defined in my issue security schemes?
      - Can I list only the default security level of each scheme?
      - How do I filter issue security levels to particular schemes?
      instructions:
      - text: List the issue security levels in scheme {schemeId}.
        slots:
          schemeId: query.schemeId
      - text: Show only default security levels ({onlyDefault}) across all security schemes.
        slots:
          onlyDefault: query.onlyDefault
      - text: Get issue security levels {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/level/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set default security levels for schemes
      effect: write
      questions:
      - How do I change which security level new issues get by default in a scheme?
      - Can I update default security levels for several schemes in one request?
      instructions:
      - text: 'Set these default issue security levels per scheme: {defaultValues}.'
        slots:
          defaultValues: requestBody.defaultValues
      - text: Update the default level for my security schemes using {defaultValues}.
        slots:
          defaultValues: requestBody.defaultValues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/level/member'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of issue security levels
      effect: read
      questions:
      - Who is allowed to see issues at a given security level?
      - Can I list security level members for a whole scheme at once?
      instructions:
      - text: List the members of issue security level {levelId}.
        slots:
          levelId: query.levelId
      - text: Show all security level members in scheme {schemeId}.
        slots:
          schemeId: query.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/project'].get
  update:
    x-apievangelist-phrasing:
      intent: Find projects associated with security schemes
      effect: read
      questions:
      - Which projects use a given issue security scheme?
      - What issue security scheme is assigned to my project?
      instructions:
      - text: List the projects using issue security scheme {issueSecuritySchemeId}.
        slots:
          issueSecuritySchemeId: query.issueSecuritySchemeId
      - text: Show the security scheme mapping for project {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/project'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign a security scheme to a project
      effect: write
      questions:
      - How do I apply an issue security scheme to a project?
      - Can existing issues be moved to new security levels when I swap a project's scheme?
      - Is associating a security scheme with a project done as a background task?
      instructions:
      - text: Associate issue security scheme {schemeId} with project {projectId}.
        slots:
          schemeId: requestBody.schemeId
          projectId: requestBody.projectId
      - text: Switch project {projectId} to security scheme {schemeId}, remapping issue levels with {oldToNewSecurityLevelMappings}.
        slots:
          projectId: requestBody.projectId
          schemeId: requestBody.schemeId
          oldToNewSecurityLevelMappings: requestBody.oldToNewSecurityLevelMappings
      method: generated
      generated: '2026-09-26'
- 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 by the projects that use them?
      - Is there a paginated way to look up specific issue security schemes?
      instructions:
      - text: Search issue security schemes {id}.
        slots:
          id: query.id
      - text: Find security schemes, with their project IDs, for projects {projectId}.
        slots:
          projectId: query.projectId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security scheme with its levels
      effect: read
      questions:
      - What security levels does a specific issue security scheme contain?
      - Can a project admin view the security scheme their project uses?
      instructions:
      - text: Show issue security scheme {id} and its security levels.
        slots:
          id: path.id
      - text: Get the details of security scheme {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a security scheme
      effect: write
      questions:
      - How do I rename an issue security scheme?
      - Can I change a security scheme's description without touching its levels?
      instructions:
      - text: Rename issue security scheme {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Set the description of security scheme {id} to {description}.
        slots:
          id: path.id
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue security scheme
      effect: destructive
      questions:
      - How do I permanently remove an issue security scheme?
      - Can I delete a security scheme I no longer need?
      instructions:
      - text: Delete issue security scheme {schemeId}.
        slots:
          schemeId: path.schemeId
      - text: Remove security scheme {schemeId} from Jira for good.
        slots:
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level'].put
  update:
    x-apievangelist-phrasing:
      intent: Add security levels to a scheme
      effect: write
      questions:
      - How do I add a new security level to an existing security scheme?
      - Can I add levels and their members to a scheme in one call, and how many at a time?
      instructions:
      - text: 'Add these security levels to scheme {schemeId}: {levels}.'
        slots:
          schemeId: path.schemeId
          levels: requestBody.levels
      - text: Create new levels {levels} with their members in existing security scheme {schemeId}.
        slots:
          levels: requestBody.levels
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a security level
      effect: write
      questions:
      - How do I rename an issue security level?
      - Can I edit a security level's description?
      instructions:
      - text: Rename security level {levelId} in scheme {schemeId} to {name}.
        slots:
          levelId: path.levelId
          schemeId: path.schemeId
          name: requestBody.name
      - text: Update the description of level {levelId} in security scheme {schemeId} to {description}.
        slots:
          levelId: path.levelId
          schemeId: path.schemeId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a security level from a scheme
      effect: destructive
      questions:
      - How do I delete an issue security level?
      - What happens to issues at a security level I remove — can they move to another level?
      instructions:
      - text: Remove security level {levelId} from scheme {schemeId}.
        slots:
          levelId: path.levelId
          schemeId: path.schemeId
      - text: Delete level {levelId} in scheme {schemeId} and move its issues to level {replaceWith}.
        slots:
          levelId: path.levelId
          schemeId: path.schemeId
          replaceWith: query.replaceWith
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member'].put
  update:
    x-apievangelist-phrasing:
      intent: Add members to a security level
      effect: write
      questions:
      - How do I let more users or groups see issues at a security level?
      - How many members can I add to a security level per request?
      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 security scheme {schemeId} access to {members}.
        slots:
          levelId: path.levelId
          schemeId: path.schemeId
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issuesecurityschemes/{schemeId}/level/{levelId}/member/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a security level
      effect: destructive
      questions:
      - How do I stop a user or group from seeing issues at a security level?
      - Can I remove a single member from an issue 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 security scheme {schemeId}.
        slots:
          memberId: path.memberId
          levelId: path.levelId
          schemeId: path.schemeId
      method: generated
      generated: '2026-09-26'