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.
# 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 Issue custom field configuration…
version: 1.0.0
extends: openapi/jira-issue-custom-field-configuration-apps-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: 3
- target: $.paths['/rest/api/3/app/field/context/configuration/list'].post
update:
x-apievangelist-phrasing:
intent: Bulk get configurations for Forge custom fields
effect: read
questions:
- How do I get the configurations of several Forge app custom fields in one request?
- Can I filter configurations for many custom fields down to one issue?
instructions:
- text: Get the configurations of custom fields {fieldIdsOrKeys}.
slots:
fieldIdsOrKeys: requestBody.fieldIdsOrKeys
- text: Bulk fetch configurations of fields {fieldIdsOrKeys} as they apply to issue {issueId}.
slots:
fieldIdsOrKeys: requestBody.fieldIdsOrKeys
issueId: query.issueId
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].get
update:
x-apievangelist-phrasing:
intent: Get configurations for one Forge custom field
effect: read
questions:
- What configuration does my Forge custom field have in each context?
- Can I see which configuration of a field applies to one project and issue type?
instructions:
- text: List the context configurations of custom field {fieldIdOrKey}.
slots:
fieldIdOrKey: path.fieldIdOrKey
- text: Show the configuration of field {fieldIdOrKey} for project {projectKeyOrId} and issue type {issueTypeId}.
slots:
fieldIdOrKey: path.fieldIdOrKey
projectKeyOrId: query.projectKeyOrId
issueTypeId: query.issueTypeId
method: generated
generated: '2026-09-26'
- target: $.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].put
update:
x-apievangelist-phrasing:
intent: Update a Forge custom field's context configs
effect: write
questions:
- How do I change the configuration of my Forge custom field for its contexts?
- Who is allowed to update a Forge app field's configuration?
instructions:
- text: Update custom field {fieldIdOrKey} with configurations {configurations}.
slots:
fieldIdOrKey: path.fieldIdOrKey
configurations: requestBody.configurations
- text: Apply context configurations {configurations} to Forge field {fieldIdOrKey}.
slots:
configurations: requestBody.configurations
fieldIdOrKey: path.fieldIdOrKey
method: generated
generated: '2026-09-26'
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.