Atlassian · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Project Components…
9 actions
9 updates
phrasing
extends
openapi/atlassian-project-components-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian 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 Atlassian The Jira Cloud platform REST Project Components…
version: 1.0.0
extends: openapi/atlassian-project-components-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 8
- target: $.paths['/rest/api/3/component'].get
update:
x-apievangelist-phrasing:
intent: Search components across projects
effect: read
questions:
- How do I find components across several Jira projects at once?
- Does component search include Compass components too?
instructions:
- text: Find components in projects {projectIdsOrKeys}.
slots:
projectIdsOrKeys: query.projectIdsOrKeys
- text: Search components named like {query} across projects {projectIdsOrKeys}.
slots:
query: query.query
projectIdsOrKeys: query.projectIdsOrKeys
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/component'].post
update:
x-apievangelist-phrasing:
intent: Create a project component
effect: write
questions:
- How do I add a component to a Jira project?
- Can I set a component lead when creating it?
instructions:
- text: Create component {name} in project {project}.
slots:
name: requestBody.name
project: requestBody.project
- text: Add component {name} to {project} with lead {leadAccountId}.
slots:
name: requestBody.name
project: requestBody.project
leadAccountId: requestBody.leadAccountId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/component/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a project component
effect: read
questions:
- How do I look up a Jira component by id?
- Who leads this component and what's its default assignee?
instructions:
- text: Get component {id}.
slots:
id: path.id
- text: Show me the lead and description of component {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/component/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a project component
effect: write
questions:
- How do I change who leads a component?
- Can I clear a component's lead by sending an empty value?
instructions:
- text: Set the lead of component {id} to {leadAccountId}.
slots:
id: path.id
leadAccountId: requestBody.leadAccountId
- text: Rename component {id} to {name}.
slots:
id: path.id
name: requestBody.name
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/component/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a project component
effect: destructive
questions:
- How do I delete a component and move its issues to another component?
- What happens to issues when their component is removed?
instructions:
- text: Delete component {id}.
slots:
id: path.id
- text: Delete component {id} and move its issues to {moveIssuesTo}.
slots:
id: path.id
moveIssuesTo: query.moveIssuesTo
method: generated
generated: '2026-10-01'
- 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 filed under this component?
- Is a component still in use before I delete it?
instructions:
- text: Count the issues in component {id}.
slots:
id: path.id
- text: Tell me how many issues reference component {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/component'].get
update:
x-apievangelist-phrasing:
intent: Page through a project's components
effect: read
questions:
- How do I page through the components of one Jira project?
- Can I filter a project's components by source or name?
instructions:
- text: List components of project {projectIdOrKey} page by page.
slots:
projectIdOrKey: path.projectIdOrKey
- text: Show components in {projectIdOrKey} matching {query} from source {componentSource}.
slots:
projectIdOrKey: path.projectIdOrKey
query: query.query
componentSource: query.componentSource
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/components'].get
update:
x-apievangelist-phrasing:
intent: Get every component in a project, unpaginated
effect: read
questions:
- Can I get all of a project's components in one unpaginated response?
- What's the full component list for this project?
instructions:
- text: Get all components of project {projectIdOrKey} in one list.
slots:
projectIdOrKey: path.projectIdOrKey
- text: Return the complete component list for {projectIdOrKey} from source {componentSource}.
slots:
projectIdOrKey: path.projectIdOrKey
componentSource: query.componentSource
method: generated
generated: '2026-10-01'
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/atlassian-project-components-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.