Atlassian · Schema

DashboardGadgetSettings

Details of the settings for a dashboard gadget.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
color string The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.
ignoreUriAndModuleKeyValidation boolean Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.
moduleKey string The module key of the gadget type. Can't be provided with `uri`.
position object The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it.
title string The title of the gadget.
uri string The URI of the gadget type. Can't be provided with `moduleKey`.
View JSON Schema on GitHub

JSON Schema

atlassian-dashboardgadgetsettings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DashboardGadgetSettings",
  "title": "DashboardGadgetSettings",
  "additionalProperties": false,
  "description": "Details of the settings for a dashboard gadget.",
  "properties": {
    "color": {
      "description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.",
      "type": "string",
      "writeOnly": true
    },
    "ignoreUriAndModuleKeyValidation": {
      "description": "Whether to ignore the validation of module key and URI. For example, when a gadget is created that is a part of an application that isn't installed.",
      "type": "boolean",
      "writeOnly": true
    },
    "moduleKey": {
      "description": "The module key of the gadget type. Can't be provided with `uri`.",
      "type": "string",
      "writeOnly": true
    },
    "position": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardGadgetPosition"
        }
      ],
      "description": "The position of the gadget. When the gadget is placed into the position, other gadgets in the same column are moved down to accommodate it."
    },
    "title": {
      "description": "The title of the gadget.",
      "type": "string",
      "writeOnly": true
    },
    "uri": {
      "description": "The URI of the gadget type. Can't be provided with `moduleKey`.",
      "type": "string",
      "writeOnly": true
    }
  },
  "type": "object"
}