# 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 schemes API
  version: 1.0.0
extends: openapi/jira-screen-schemes-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: 4
- target: $.paths['/rest/api/3/screenscheme'].get
  update:
    x-apievangelist-phrasing:
      intent: List screen schemes
      effect: read
      questions:
      - What screen schemes are defined for my classic projects?
      - Can I search screen schemes by part of their name?
      - How do I sort screen schemes by name or ID?
      instructions:
      - text: List all screen schemes.
      - text: Find screen schemes whose name contains {queryString}.
        slots:
          queryString: query.queryString
      - text: Get screen schemes {id}, ordered by {orderBy}.
        slots:
          id: query.id
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screenscheme'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a screen scheme
      effect: write
      questions:
      - How do I create a screen scheme that sets different screens for create, edit and view?
      - What's the length limit on a screen scheme name?
      instructions:
      - text: Create screen scheme {name} using screens {screens}.
        slots:
          name: requestBody.name
          screens: requestBody.screens
      - text: Set up a new screen scheme {name}, described as {description}, with screens {screens}.
        slots:
          name: requestBody.name
          description: requestBody.description
          screens: requestBody.screens
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screenscheme/{screenSchemeId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a screen scheme
      effect: write
      questions:
      - How do I rename a screen scheme?
      - Can I change which screen a screen scheme uses for editing issues?
      instructions:
      - text: Rename screen scheme {screenSchemeId} to {name}.
        slots:
          screenSchemeId: path.screenSchemeId
          name: requestBody.name
      - text: Change the screens in screen scheme {screenSchemeId} to {screens}.
        slots:
          screenSchemeId: path.screenSchemeId
          screens: requestBody.screens
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/screenscheme/{screenSchemeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a screen scheme
      effect: destructive
      questions:
      - How do I delete a screen scheme?
      - Why can't I delete a screen scheme that an issue type screen scheme uses?
      instructions:
      - text: Delete screen scheme {screenSchemeId}.
        slots:
          screenSchemeId: path.screenSchemeId
      - text: Remove the unused screen scheme {screenSchemeId}.
        slots:
          screenSchemeId: path.screenSchemeId
      method: generated
      generated: '2026-09-26'