Atlassian · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Custom Field…
14 actions
14 updates
phrasing
extends
openapi/atlassian-issue-custom-field-contexts-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 14
$.info
$.paths['/rest/api/3/field/{fieldId}/context'].get
$.paths['/rest/api/3/field/{fieldId}/context'].post
$.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].get
$.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].put
$.paths['/rest/api/3/field/{fieldId}/context/issuetypemapping'].get
$.paths['/rest/api/3/field/{fieldId}/context/mapping'].post
$.paths['/rest/api/3/field/{fieldId}/context/projectmapping'].get
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].put
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].delete
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype'].put
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove'].post
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project'].put
$.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project/remove'].post
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 Issue Custom Field…
version: 1.0.0
extends: openapi/atlassian-issue-custom-field-contexts-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: 13
- target: $.paths['/rest/api/3/field/{fieldId}/context'].get
update:
x-apievangelist-phrasing:
intent: List the contexts of a custom field
effect: read
questions:
- Which contexts are configured for a particular custom field?
- Can I list only the global contexts that apply to all projects?
instructions:
- text: List the contexts for custom field {fieldId}.
slots:
fieldId: path.fieldId
- text: Show only the global contexts of field {fieldId} ({isGlobalContext}).
slots:
fieldId: path.fieldId
isGlobalContext: query.isGlobalContext
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context'].post
update:
x-apievangelist-phrasing:
intent: Create a context for a custom field
effect: write
questions:
- How do I scope a custom field to certain projects and issue types?
- What happens if I create a field context without any project IDs?
instructions:
- text: Create a context named {name} for custom field {fieldId}.
slots:
name: requestBody.name
fieldId: path.fieldId
- text: Add context {name} to field {fieldId} for projects {projectIds} and issue types {issueTypeIds}.
slots:
name: requestBody.name
fieldId: path.fieldId
projectIds: requestBody.projectIds
issueTypeIds: requestBody.issueTypeIds
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].get
update:
x-apievangelist-phrasing:
intent: Get a custom field's default values per context
effect: read
questions:
- What default value does a custom field fill in for each context?
- Can I see the default for just one context of a field?
instructions:
- text: Show the default values for custom field {fieldId}.
slots:
fieldId: path.fieldId
- text: Get the default value of field {fieldId} in context {contextId}.
slots:
fieldId: path.fieldId
contextId: query.contextId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/defaultValue'].put
update:
x-apievangelist-phrasing:
intent: Set default values for custom field contexts
effect: write
questions:
- How do I set the default value a custom field gets in new issues?
- Can I set a date field's default for one of its contexts?
instructions:
- text: Set the defaults for custom field {fieldId} to {defaultValues}.
slots:
fieldId: path.fieldId
defaultValues: requestBody.defaultValues
- text: Update the context default values on field {fieldId} using {defaultValues}.
slots:
fieldId: path.fieldId
defaultValues: requestBody.defaultValues
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/issuetypemapping'].get
update:
x-apievangelist-phrasing:
intent: List issue types mapped to a field's contexts
effect: read
questions:
- Which issue types does each context of a custom field cover?
- What issue types are attached to a single field context?
instructions:
- text: Show the issue type mappings for contexts of field {fieldId}.
slots:
fieldId: path.fieldId
- text: List issue types attached to context {contextId} of field {fieldId}.
slots:
contextId: query.contextId
fieldId: path.fieldId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/mapping'].post
update:
x-apievangelist-phrasing:
intent: Find which field context applies to project/type pairs
effect: read
questions:
- Which context of a custom field applies to a given project and issue type combination?
- Can I look up the effective field context for several project and issue type pairs at once?
instructions:
- text: Find the context of field {fieldId} that applies to {mappings}.
slots:
fieldId: path.fieldId
mappings: requestBody.mappings
- text: 'Resolve the effective field {fieldId} context for these project and issue type pairs: {mappings}.'
slots:
fieldId: path.fieldId
mappings: requestBody.mappings
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/projectmapping'].get
update:
x-apievangelist-phrasing:
intent: List projects mapped to a field's contexts
effect: read
questions:
- Which projects use each context of a custom field?
- What projects is a particular field context assigned to?
instructions:
- text: Show the project mappings for contexts of field {fieldId}.
slots:
fieldId: path.fieldId
- text: List projects assigned to context {contextId} of field {fieldId}.
slots:
contextId: query.contextId
fieldId: path.fieldId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].put
update:
x-apievangelist-phrasing:
intent: Rename or redescribe a field context
effect: write
questions:
- How do I rename an existing custom field context?
- What is the length limit on a field context's description?
instructions:
- text: Rename context {contextId} of field {fieldId} to {name}.
slots:
contextId: path.contextId
fieldId: path.fieldId
name: requestBody.name
- text: Change the description of field {fieldId} context {contextId} to {description}.
slots:
fieldId: path.fieldId
contextId: path.contextId
description: requestBody.description
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a custom field context
effect: destructive
questions:
- How do I delete a context from a custom field?
- Who is permitted to remove a custom field context?
instructions:
- text: Delete context {contextId} from custom field {fieldId}.
slots:
contextId: path.contextId
fieldId: path.fieldId
- text: Remove the {contextId} context entirely from field {fieldId}.
slots:
contextId: path.contextId
fieldId: path.fieldId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype'].put
update:
x-apievangelist-phrasing:
intent: Add issue types to a field context
effect: write
questions:
- How do I make a custom field context apply to more issue types?
- What happens when I add issue types to a context that covered all types?
instructions:
- text: Add issue types {issueTypeIds} to context {contextId} of field {fieldId}.
slots:
issueTypeIds: requestBody.issueTypeIds
contextId: path.contextId
fieldId: path.fieldId
- text: Append {issueTypeIds} to the issue types of field {fieldId} context {contextId}.
slots:
issueTypeIds: requestBody.issueTypeIds
fieldId: path.fieldId
contextId: path.contextId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove'].post
update:
x-apievangelist-phrasing:
intent: Remove issue types from a field context
effect: write
questions:
- How do I stop a custom field context from applying to some issue types?
- What does a field context cover once I remove all of its issue types?
instructions:
- text: Remove issue types {issueTypeIds} from context {contextId} of field {fieldId}.
slots:
issueTypeIds: requestBody.issueTypeIds
contextId: path.contextId
fieldId: path.fieldId
- text: Drop {issueTypeIds} from the issue types of field {fieldId} context {contextId}.
slots:
issueTypeIds: requestBody.issueTypeIds
fieldId: path.fieldId
contextId: path.contextId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project'].put
update:
x-apievangelist-phrasing:
intent: Assign a field context to projects
effect: write
questions:
- How do I apply a custom field context to specific projects?
- Why would assigning projects to a field context fail?
instructions:
- text: Assign context {contextId} of field {fieldId} to projects {projectIds}.
slots:
contextId: path.contextId
fieldId: path.fieldId
projectIds: requestBody.projectIds
- text: Attach projects {projectIds} to field {fieldId} context {contextId}.
slots:
projectIds: requestBody.projectIds
fieldId: path.fieldId
contextId: path.contextId
method: generated
generated: '2026-10-01'
- target: $.paths['/rest/api/3/field/{fieldId}/context/{contextId}/project/remove'].post
update:
x-apievangelist-phrasing:
intent: Remove a field context from projects
effect: write
questions:
- How do I detach a custom field context from some projects?
- Does removing every project make a field context apply globally?
instructions:
- text: Remove context {contextId} of field {fieldId} from projects {projectIds}.
slots:
contextId: path.contextId
fieldId: path.fieldId
projectIds: requestBody.projectIds
- text: Detach projects {projectIds} from field {fieldId} context {contextId}.
slots:
projectIds: requestBody.projectIds
fieldId: path.fieldId
contextId: path.contextId
method: generated
generated: '2026-10-01'