Jira · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Jira Cloud platform REST Project components API
9 actions
9 updates
phrasing
extends
openapi/jira-project-components-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.
What the actions change
x-apievangelist-phrasing
Targets 9
$.info
$.paths['/rest/api/3/component'].get
$.paths['/rest/api/3/component'].post
$.paths['/rest/api/3/component/{id}'].get
$.paths['/rest/api/3/component/{id}'].put
$.paths['/rest/api/3/component/{id}'].delete
$.paths['/rest/api/3/component/{id}/relatedIssueCounts'].get
$.paths['/rest/api/3/project/{projectIdOrKey}/component'].get
$.paths['/rest/api/3/project/{projectIdOrKey}/components'].get
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 Jira Cloud platform REST Project components API
version: 1.0.0
extends: openapi/jira-project-components-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/api/3/component'].get
update:
x-apievangelist-phrasing:
intent: Find components across several projects
effect: read
questions:
- Which components exist across a set of projects, including Compass components?
- Can I search components by name across multiple projects?
instructions:
- text: Find components in projects {projectIdsOrKeys}.
slots:
projectIdsOrKeys: query.projectIdsOrKeys
- text: Search components matching {query} across projects {projectIdsOrKeys}.
slots:
query: query.query
projectIdsOrKeys: query.projectIdsOrKeys
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/component'].post
update:
x-apievangelist-phrasing:
intent: Create a component in a project
effect: write
questions:
- How do I add a new component to a project?
- Can I set a component lead and default assignee when creating it?
instructions:
- text: Create a component named {name} in project {project}.
slots:
name: requestBody.name
project: requestBody.project
- text: Create component {name} in project {project} led by {leadAccountId} with assignee type {assigneeType}.
slots:
name: requestBody.name
project: requestBody.project
leadAccountId: requestBody.leadAccountId
assigneeType: requestBody.assigneeType
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/component/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a component's details
effect: read
questions:
- Who is the lead of a particular component?
- How do I look up one component by its ID?
instructions:
- text: Get component {id}.
slots:
id: path.id
- text: Show the lead and default assignee of component {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/component/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a component
effect: write
questions:
- Can I rename a component or change its lead?
- How do I remove the lead from a component?
instructions:
- text: Rename component {id} to {name}.
slots:
id: path.id
name: requestBody.name
- text: Make {leadAccountId} the lead of component {id}.
slots:
leadAccountId: requestBody.leadAccountId
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/component/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a component
effect: destructive
questions:
- How do I delete a component from a project?
- Can I move the component's issues to another component when deleting it?
instructions:
- text: Delete component {id}.
slots:
id: path.id
- text: Delete component {id} and move its issues to component {moveIssuesTo}.
slots:
id: path.id
moveIssuesTo: query.moveIssuesTo
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/component/{id}/relatedIssueCounts'].get
update:
x-apievangelist-phrasing:
intent: Count issues assigned to a component
effect: read
questions:
- How many issues are assigned to a component?
- What's the issue count for a component before I delete it?
instructions:
- text: Count the issues in component {id}.
slots:
id: path.id
- text: Tell me how many issues belong to component {id}.
slots:
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/component'].get
update:
x-apievangelist-phrasing:
intent: Page through a project's components
effect: read
questions:
- Can I page through a project's components and filter them by name?
- Is it possible to list only Jira or only Compass components in a project?
instructions:
- text: Page through the components of project {projectIdOrKey}, {maxResults} at a time.
slots:
projectIdOrKey: path.projectIdOrKey
maxResults: query.maxResults
- text: Search components in project {projectIdOrKey} matching {query}, ordered by {orderBy}.
slots:
projectIdOrKey: path.projectIdOrKey
query: query.query
orderBy: query.orderBy
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/components'].get
update:
x-apievangelist-phrasing:
intent: List all components in a project at once
effect: read
questions:
- How do I get every component of a project in one unpaginated list?
- What components does my project have?
instructions:
- text: List all components in project {projectIdOrKey} without paging.
slots:
projectIdOrKey: path.projectIdOrKey
- text: Get the full component list of project {projectIdOrKey} from source {componentSource}.
slots:
projectIdOrKey: path.projectIdOrKey
componentSource: query.componentSource
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.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/jira-project-components-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.