Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Announcement Banner…

3 actions 3 updates phrasing extends openapi/atlassian-announcement-banner-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 3

$.info

$.paths['/rest/api/3/announcementBanner'].get

$.paths['/rest/api/3/announcementBanner'].put

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 Announcement Banner…
  version: 1.0.0
extends: openapi/atlassian-announcement-banner-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: 2
- target: $.paths['/rest/api/3/announcementBanner'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the announcement banner settings
      effect: read
      questions:
      - What message is the site-wide announcement banner showing right now?
      - Is the announcement banner enabled, and can users dismiss it?
      instructions:
      - text: Show the current announcement banner configuration.
      - text: Tell me whether the banner is on and what it says.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/announcementBanner'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the announcement banner
      effect: write
      questions:
      - How do I post a maintenance notice in the announcement banner?
      - Can I make the banner visible only to logged-in users?
      instructions:
      - text: Set the announcement banner message to {message} and enable it ({isEnabled}).
        slots:
          message: requestBody.message
          isEnabled: requestBody.isEnabled
      - text: Change the banner visibility to {visibility} and dismissible to {isDismissible}.
        slots:
          visibility: requestBody.visibility
          isDismissible: requestBody.isDismissible
      method: generated
      generated: '2026-10-01'