# 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 Screen tabs API
  version: 1.0.0
extends: openapi/jira-screen-tabs-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: 6
- target: $.paths['/rest/api/3/screens/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List tabs across many screens
      effect: read
      questions:
      - How do I get the tabs for several screens in one request?
      - What's the maximum number of screen tabs returned per page in the bulk call?
      instructions:
      - text: List the tabs for screens {screenId}.
        slots:
          screenId: query.screenId
      - text: Bulk fetch screen tabs {tabId} across screens {screenId}.
        slots:
          tabId: query.tabId
          screenId: query.screenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tabs on one screen
      effect: read
      questions:
      - What tabs does a particular screen have?
      - Can a project admin see a screen's tabs by passing their project key?
      instructions:
      - text: Show the tabs on screen {screenId}.
        slots:
          screenId: path.screenId
      - text: List tabs of screen {screenId} for project {projectKey}.
        slots:
          screenId: path.screenId
          projectKey: query.projectKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tab to a screen
      effect: write
      questions:
      - How do I add a new tab to a Jira screen?
      - Is there a length limit on a screen tab name?
      instructions:
      - text: Create a tab named {name} on screen {screenId}.
        slots:
          name: requestBody.name
          screenId: path.screenId
      - text: Add a {name} tab to screen {screenId}.
        slots:
          name: requestBody.name
          screenId: path.screenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a screen tab
      effect: write
      questions:
      - How do I rename a tab on a screen?
      - Can I change a screen tab's label after creating it?
      instructions:
      - text: Rename tab {tabId} on screen {screenId} to {name}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
          name: requestBody.name
      - text: Change the label of screen {screenId} tab {tabId} to {name}.
        slots:
          screenId: path.screenId
          tabId: path.tabId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a screen tab
      effect: destructive
      questions:
      - How do I remove a tab from a screen?
      - Can I delete a screen tab I no longer need?
      instructions:
      - text: Delete tab {tabId} from screen {screenId}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
      - text: Remove the {tabId} tab on screen {screenId}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos}'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder a tab on a screen
      effect: write
      questions:
      - How do I change the order of tabs on a screen?
      - Is tab position counted from zero when moving a screen tab?
      instructions:
      - text: Move tab {tabId} on screen {screenId} to position {pos}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
          pos: path.pos
      - text: Make tab {tabId} the first tab on screen {screenId} by moving it to position {pos}.
        slots:
          tabId: path.tabId
          screenId: path.screenId
          pos: path.pos
      method: generated
      generated: '2026-09-26'