Atlassian · Schema

AnnouncementBannerConfiguration

Announcement banner configuration.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
hashId string Hash of the banner data. The client detects updates by comparing hash IDs.
isDismissible boolean Flag indicating if the announcement banner can be dismissed by the user.
isEnabled boolean Flag indicating if the announcement banner is enabled or not.
message string The text on the announcement banner.
visibility string Visibility of the announcement banner.
View JSON Schema on GitHub

JSON Schema

atlassian-announcementbannerconfiguration-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AnnouncementBannerConfiguration",
  "title": "AnnouncementBannerConfiguration",
  "additionalProperties": false,
  "description": "Announcement banner configuration.",
  "properties": {
    "hashId": {
      "description": "Hash of the banner data. The client detects updates by comparing hash IDs.",
      "readOnly": true,
      "type": "string"
    },
    "isDismissible": {
      "description": "Flag indicating if the announcement banner can be dismissed by the user.",
      "readOnly": true,
      "type": "boolean"
    },
    "isEnabled": {
      "description": "Flag indicating if the announcement banner is enabled or not.",
      "readOnly": true,
      "type": "boolean"
    },
    "message": {
      "description": "The text on the announcement banner.",
      "readOnly": true,
      "type": "string"
    },
    "visibility": {
      "description": "Visibility of the announcement banner.",
      "enum": [
        "PUBLIC",
        "PRIVATE"
      ],
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}