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-values-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/value'].post
$.paths['/rest/api/3/app/field/{fieldIdOrKey}/value'].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-values-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/value'].post
  update:
    x-apievangelist-phrasing:
      intent: Update several app custom fields across issues
      effect: write
      questions:
      - Can my app set values for multiple custom fields on many issues in one request?
      - Is it possible to skip writing a changelog entry when an app updates field values?
      instructions:
      - text: Apply custom field updates {updates} across issues in one batch.
        slots:
          updates: requestBody.updates
      - text: Bulk-update app custom fields with {updates} and generateChangelog {generateChangelog}.
        slots:
          updates: requestBody.updates
          generateChangelog: query.generateChangelog
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/app/field/{fieldIdOrKey}/value'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one app custom field on issues
      effect: write
      questions:
      - How does my app set the value of its single custom field on a few issues?
      - Which custom fields is an app allowed to update this way?
      instructions:
      - text: Set custom field {fieldIdOrKey} on issues using {updates}.
        slots:
          fieldIdOrKey: path.fieldIdOrKey
          updates: requestBody.updates
      - text: 'Update only field {fieldIdOrKey} on the listed issues without a changelog: {generateChangelog}.'
        slots:
          fieldIdOrKey: path.fieldIdOrKey
          generateChangelog: query.generateChangelog
      method: generated
      generated: '2026-10-01'