# 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 Announcement banner API
  version: 1.0.0
extends: openapi/jira-announcement-banner-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: 2
- target: $.paths['/rest/api/3/announcementBanner'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the announcement banner settings
      effect: read
      questions:
      - What announcement banner is currently shown across Jira?
      - Is the site banner enabled and who can see it?
      instructions:
      - text: Get the current announcement banner configuration.
      - text: Show me the banner message and its visibility.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/announcementBanner'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the announcement banner
      effect: write
      questions:
      - Can I post a site-wide banner announcing planned maintenance?
      - Is it possible to make the banner dismissible or visible only to logged-in users?
      instructions:
      - text: Set the announcement banner message to {message}.
        slots:
          message: requestBody.message
      - text: Turn the banner on with {isEnabled} and dismissible set to {isDismissible}.
        slots:
          isEnabled: requestBody.isEnabled
          isDismissible: requestBody.isDismissible
      - text: Show the banner {message} to {visibility} users.
        slots:
          message: requestBody.message
          visibility: requestBody.visibility
      method: generated
      generated: '2026-09-26'