# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Software Cloud Security Information API
  version: 1.0.0
extends: openapi/jira-security-information-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: 8
- target: $.paths['/rest/security/1.0/linkedWorkspaces/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Link security workspaces to the Jira site
      effect: write
      questions:
      - How does my security app link its workspaces to a Jira site?
      - What happens if I submit a security workspace that's already linked?
      instructions:
      - text: Link security workspaces {workspaceIds} to this Jira site, authenticating with {Authorization}.
        slots:
          workspaceIds: requestBody.workspaceIds
          Authorization: header.Authorization
      - text: Submit workspace IDs {workspaceIds} to connect them with Jira using token {Authorization}.
        slots:
          workspaceIds: requestBody.workspaceIds
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/linkedWorkspaces/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink security workspaces from Jira
      effect: destructive
      questions:
      - How do I disconnect security workspaces from a Jira site in bulk?
      - Can my app remove several linked security workspaces at once?
      instructions:
      - text: Unlink the matching security workspaces from Jira using app token {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Bulk delete linked security workspaces, authenticated as the app with {Authorization}.
        slots:
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/linkedWorkspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked security workspaces
      effect: read
      questions:
      - Which security workspaces are currently linked to my Jira site?
      - Does the linked workspace list reflect pending updates?
      instructions:
      - text: List all security workspaces linked to this Jira site with token {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Show every linked security workspace as the app authenticated by {Authorization}.
        slots:
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/linkedWorkspaces/{workspaceId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one linked security workspace
      effect: read
      questions:
      - Is a specific security workspace linked to my Jira site?
      - Can I fetch a linked security workspace by its ID?
      instructions:
      - text: Get linked security workspace {workspaceId} using token {Authorization}.
        slots:
          workspaceId: path.workspaceId
          Authorization: header.Authorization
      - text: Check whether workspace {workspaceId} is linked, authenticated with {Authorization}.
        slots:
          workspaceId: path.workspaceId
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send vulnerability data to Jira
      effect: write
      questions:
      - How does my security tool push vulnerabilities into Jira?
      - Will resubmitting a vulnerability with the same ID overwrite the old data?
      - Is vulnerability ingestion processed synchronously or in the background?
      instructions:
      - text: Submit vulnerabilities {vulnerabilities} to Jira using app token {Authorization}.
        slots:
          vulnerabilities: requestBody.vulnerabilities
          Authorization: header.Authorization
      - text: Upsert vulnerabilities {vulnerabilities} tagged with properties {properties}, authenticated with {Authorization}.
        slots:
          vulnerabilities: requestBody.vulnerabilities
          properties: requestBody.properties
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/bulkByProperties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete vulnerabilities by property
      effect: destructive
      questions:
      - How do I delete all vulnerabilities I tagged with a certain property?
      - If I pass several properties, are vulnerabilities deleted only when all of them match?
      instructions:
      - text: Delete every vulnerability matching the given properties, authenticating with {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Bulk remove vulnerabilities by property as the app with token {Authorization}.
        slots:
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/vulnerability/{vulnerabilityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stored vulnerability by ID
      effect: read
      questions:
      - How do I check what vulnerability data Jira has stored for an ID?
      - Can I confirm a vulnerability was deleted by fetching it?
      instructions:
      - text: Get vulnerability {vulnerabilityId} using token {Authorization}.
        slots:
          vulnerabilityId: path.vulnerabilityId
          Authorization: header.Authorization
      - text: Show the stored data for vulnerability {vulnerabilityId}, authenticated with {Authorization}.
        slots:
          vulnerabilityId: path.vulnerabilityId
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/security/1.0/vulnerability/{vulnerabilityId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a vulnerability by ID
      effect: destructive
      questions:
      - How do I remove one vulnerability from Jira?
      - Is deleting a single vulnerability done asynchronously?
      instructions:
      - text: Delete vulnerability {vulnerabilityId} using token {Authorization}.
        slots:
          vulnerabilityId: path.vulnerabilityId
          Authorization: header.Authorization
      - text: Remove the stored vulnerability {vulnerabilityId}, authenticated as the app with {Authorization}.
        slots:
          vulnerabilityId: path.vulnerabilityId
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'