Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Custom Field…

3 actions 3 updates phrasing extends openapi/atlassian-issue-custom-field-configuration-apps-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].get
$.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].put

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 Atlassian The Jira Cloud platform REST Issue Custom Field…
  version: 1.0.0
extends: openapi/atlassian-issue-custom-field-configuration-apps-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: 2
- target: $.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Forge custom field configurations
      effect: read
      questions:
      - What configuration does my Forge app's custom field have per context?
      - Can I look up the field configuration that applies to a specific issue?
      instructions:
      - text: Get configurations for custom field {fieldIdOrKey}.
        slots:
          fieldIdOrKey: path.fieldIdOrKey
      - text: Show the configuration of field {fieldIdOrKey} that applies to issue {issueId}.
        slots:
          fieldIdOrKey: path.fieldIdOrKey
          issueId: query.issueId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/app/field/{fieldIdOrKey}/context/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Forge custom field configurations
      effect: write
      questions:
      - How does my Forge app update its custom field's context configuration?
      - Can I set configurations for several field contexts at once?
      instructions:
      - text: Update configurations of field {fieldIdOrKey} to {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-10-01'