Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Screen Tab Fields API

5 actions 5 updates phrasing extends openapi/atlassian-screen-tab-fields-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 5

$.info

$.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields'].get

$.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields'].post

$.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}'].delete

$.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move'].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 Screen Tab Fields API
  version: 1.0.0
extends: openapi/atlassian-screen-tab-fields-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: 4
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields on a screen tab
      effect: read
      questions:
      - Which fields appear on a particular tab of a Jira screen?
      - Can a project admin see screen tab fields for their project?
      instructions:
      - text: List the fields on tab {tabId} of screen {screenId}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
      - text: Show screen {screenId} tab {tabId} fields for project {projectKey}.
        slots:
          screenId: path.screenId
          tabId: path.tabId
          projectKey: query.projectKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to a screen tab
      effect: write
      questions:
      - How do I put a custom field on a Jira screen tab?
      - Can I add a field to the second tab of a screen?
      instructions:
      - text: Add field {fieldId} to tab {tabId} of screen {screenId}.
        slots:
          fieldId: requestBody.fieldId
          tabId: path.tabId
          screenId: path.screenId
      - text: Show field {fieldId} on screen {screenId}, tab {tabId}.
        slots:
          fieldId: requestBody.fieldId
          screenId: path.screenId
          tabId: path.tabId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a field from a screen tab
      effect: destructive
      questions:
      - How do I take a field off a Jira screen tab?
      - Can I hide a field from a screen by removing it from the tab?
      instructions:
      - text: Remove field {id} from tab {tabId} of screen {screenId}.
        slots:
          id: path.id
          tabId: path.tabId
          screenId: path.screenId
      - text: Take field {id} off screen {screenId} tab {tabId}.
        slots:
          id: path.id
          screenId: path.screenId
          tabId: path.tabId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a field on a screen tab
      effect: write
      questions:
      - Can I move a field to the top of a screen tab?
      - Which wins if I give both an after field and a position when moving a field?
      instructions:
      - text: Move field {id} on screen {screenId} tab {tabId} to position {position}.
        slots:
          id: path.id
          screenId: path.screenId
          tabId: path.tabId
          position: requestBody.position
      - text: Place field {id} after {after} on tab {tabId} of screen {screenId}.
        slots:
          id: path.id
          after: requestBody.after
          tabId: path.tabId
          screenId: path.screenId
      method: generated
      generated: '2026-10-01'