Jira · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jira Rest API

5 actions 5 updates phrasing extends openapi/jira-rest-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 5

$.info
$.paths['/rest/internal/api/latest/worklog/bulk'].post
$.paths['/rest/servicedeskapi/customer/skip-permission-check'].post
$.paths['/rest/servicedeskapi/knowledgebase/article/view/{pageId}'].get
$.paths['/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check'].post

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 Rest API
  version: 1.0.0
extends: openapi/jira-rest-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: 4
- target: $.paths['/rest/internal/api/latest/worklog/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk fetch worklogs by issue and worklog ID
      effect: read
      questions:
      - Can an internal service fetch many worklogs at once from issue and worklog ID pairs?
      - What's the cap on worklogs returned by the internal bulk worklog lookup?
      instructions:
      - text: 'Fetch worklogs for these issue and worklog ID pairs: {requests}.'
        slots:
          requests: requestBody.requests
      - text: Look up worklog details in bulk for {requests} via the internal endpoint.
        slots:
          requests: requestBody.requests
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/servicedeskapi/customer/skip-permission-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a service desk customer account (internal)
      effect: write
      questions:
      - Is there an internal endpoint that creates a customer account without a user context token?
      - Can the permission-skipping customer create return a conflict for a duplicate email?
      instructions:
      - text: Create a customer account for {email} named {displayName} using the skip-permission-check endpoint.
        slots:
          email: requestBody.email
          displayName: requestBody.displayName
      - text: Create customer {email} via the internal ASAP-authenticated route.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/servicedeskapi/knowledgebase/article/view/{pageId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a knowledge base article
      effect: read
      questions:
      - How do I open a single knowledge base article by its page ID?
      - Can I view the content of one help center article directly?
      instructions:
      - text: View knowledge base article {pageId}.
        slots:
          pageId: path.pageId
      - text: Open the help article with page ID {pageId}.
        slots:
          pageId: path.pageId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Add customers to a service desk (internal)
      effect: write
      questions:
      - Is there an internal route to add customers to a service desk without a user context?
      - What does the permission-skipping add-customers endpoint require for authorization?
      instructions:
      - text: Add accounts {accountIds} to service desk {serviceDeskId} through the skip-permission-check route.
        slots:
          accountIds: requestBody.accountIds
          serviceDeskId: path.serviceDeskId
      - text: Using the internal ASAP endpoint, grant service desk {serviceDeskId} customer access to {accountIds}.
        slots:
          serviceDeskId: path.serviceDeskId
          accountIds: requestBody.accountIds
      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-rest-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.

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