Jira · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jira Software Cloud Operations API

10 actions 10 updates phrasing extends openapi/jira-operations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/rest/operations/1.0/linkedWorkspaces/bulk'].post
$.paths['/rest/operations/1.0/linkedWorkspaces/bulk'].delete
$.paths['/rest/operations/1.0/linkedWorkspaces'].get
$.paths['/rest/operations/1.0/bulk'].post
$.paths['/rest/operations/1.0/bulkByProperties'].delete
$.paths['/rest/operations/1.0/incidents/{incidentId}'].get
$.paths['/rest/operations/1.0/incidents/{incidentId}'].delete
$.paths['/rest/operations/1.0/post-incident-reviews/{reviewId}'].get
$.paths['/rest/operations/1.0/post-incident-reviews/{reviewId}'].delete

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 Jira Software Cloud Operations API
  version: 1.0.0
extends: openapi/jira-operations-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: 9
- target: $.paths['/rest/operations/1.0/linkedWorkspaces/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Link Operations workspaces to the Jira site
      effect: write
      questions:
      - How does my app link its Operations workspace IDs to a Jira site?
      - What happens if a workspace ID is already linked when I submit it again?
      instructions:
      - text: Link Operations workspaces {workspaceIds} to this Jira site.
        slots:
          workspaceIds: requestBody.workspaceIds
      - text: Submit workspace IDs {workspaceIds} with credentials {Authorization}.
        slots:
          workspaceIds: requestBody.workspaceIds
          Authorization: header.Authorization
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/linkedWorkspaces/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink Operations workspaces in bulk
      effect: destructive
      questions:
      - How do I unlink Operations workspaces from a Jira site in bulk?
      - Which apps are allowed to remove linked Operations workspaces?
      instructions:
      - text: Unlink the matching Operations workspaces using token {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Remove all linked Operations workspace IDs from the site.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/linkedWorkspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List linked Operations workspaces
      effect: read
      questions:
      - Which Operations workspace IDs are linked to my Jira site?
      - Does the linked workspace list reflect pending updates or deletes?
      instructions:
      - text: List the Operations workspaces linked to this site using token {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Show every Operations workspace ID associated with Jira.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Send incident or post-incident review data
      effect: write
      questions:
      - How does my ops tool push incident and review data into Jira?
      - Will submitting an incident with the same ID replace the stored one?
      instructions:
      - text: Submit incidents and reviews from provider {providerMetadata}.
        slots:
          providerMetadata: requestBody.providerMetadata
      - text: Upsert incident and review data tagged with properties {properties}.
        slots:
          properties: requestBody.properties
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/bulkByProperties'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete incidents and reviews by property
      effect: destructive
      questions:
      - Can I bulk delete incident data that matches certain properties?
      - If I pass several properties, does deletion require all of them to match?
      instructions:
      - text: Delete all incidents and reviews matching the given properties using token {Authorization}.
        slots:
          Authorization: header.Authorization
      - text: Bulk remove incident and review records tagged with my properties.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/incidents/{incidentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a stored incident
      effect: read
      questions:
      - How do I read back an incident my app sent to Jira?
      - Can I confirm an incident was deleted by fetching it by ID?
      instructions:
      - text: Show incident {incidentId}.
        slots:
          incidentId: path.incidentId
      - text: Get the stored data for incident {incidentId}.
        slots:
          incidentId: path.incidentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/incidents/{incidentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a stored incident
      effect: destructive
      questions:
      - How do I delete a single incident my app submitted?
      - Is deleting an incident by ID immediate or asynchronous?
      instructions:
      - text: Delete incident {incidentId}.
        slots:
          incidentId: path.incidentId
      - text: Remove the stored data for incident {incidentId}.
        slots:
          incidentId: path.incidentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/post-incident-reviews/{reviewId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a post-incident review
      effect: read
      questions:
      - How do I fetch a post-incident review my app stored in Jira?
      - Can I read one review by its ID?
      instructions:
      - text: Show post-incident review {reviewId}.
        slots:
          reviewId: path.reviewId
      - text: Get the stored review {reviewId}.
        slots:
          reviewId: path.reviewId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/operations/1.0/post-incident-reviews/{reviewId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a post-incident review
      effect: destructive
      questions:
      - How do I delete a post-incident review from Jira?
      - Is a review deleted right away when I remove it by ID?
      instructions:
      - text: Delete post-incident review {reviewId}.
        slots:
          reviewId: path.reviewId
      - text: Remove the stored review {reviewId}.
        slots:
          reviewId: path.reviewId
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/jira-operations-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.