# 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 Screens API
  version: 1.0.0
extends: openapi/jira-screens-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: 7
- target: $.paths['/rest/api/3/field/{fieldId}/screens'].get
  update:
    x-apievangelist-phrasing:
      intent: List the screens a field appears on
      effect: read
      questions:
      - Which screens is a particular field used on?
      - Can I see every screen that shows a custom field?
      instructions:
      - text: List the screens that use field {fieldId}.
        slots:
          fieldId: path.fieldId
      - text: Show screens containing field {fieldId}, expanded with {expand}.
        slots:
          fieldId: path.fieldId
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens'].get
  update:
    x-apievangelist-phrasing:
      intent: List or search screens
      effect: read
      questions:
      - What screens are configured on my Jira site?
      - Can I search screens by name or filter them by scope?
      instructions:
      - text: List all screens.
      - text: Search screens whose name contains {queryString}.
        slots:
          queryString: query.queryString
      - text: Get screens with IDs {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a screen
      effect: write
      questions:
      - How do I create a new screen?
      - Does a newly created screen come with a default tab?
      instructions:
      - text: Create a screen named {name}.
        slots:
          name: requestBody.name
      - text: Create screen {name} with description {description}.
        slots:
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/addToDefault/{fieldId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a field to the default screen
      effect: write
      questions:
      - How do I put a field on the default screen's default tab?
      - Can I quickly make a new custom field visible on the default screen?
      instructions:
      - text: Add field {fieldId} to the default screen.
        slots:
          fieldId: path.fieldId
      - text: Put field {fieldId} on the default tab of the default screen.
        slots:
          fieldId: path.fieldId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a screen
      effect: write
      questions:
      - Can I rename a screen used in a classic project?
      - How do I change a screen's description?
      instructions:
      - text: Rename screen {screenId} to {name}.
        slots:
          screenId: path.screenId
          name: requestBody.name
      - text: Set screen {screenId}'s description to {description}.
        slots:
          screenId: path.screenId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a screen
      effect: destructive
      questions:
      - How do I delete a screen I no longer use?
      - Why can't I delete a screen that's in a screen scheme or workflow?
      instructions:
      - text: Delete screen {screenId}.
        slots:
          screenId: path.screenId
      - text: Remove unused screen {screenId}.
        slots:
          screenId: path.screenId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screens/{screenId}/availableFields'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields that can be added to a screen
      effect: read
      questions:
      - Which fields could I still add to a screen?
      - What fields are available but not yet on a screen's tabs?
      instructions:
      - text: List the fields available to add to screen {screenId}.
        slots:
          screenId: path.screenId
      - text: Show fields not yet placed on screen {screenId}.
        slots:
          screenId: path.screenId
      method: generated
      generated: '2026-09-26'