Atlassian · Schema

DashboardGadget

Details of a 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`.
id integer The ID of the gadget instance.
moduleKey string The module key of the gadget type.
position object The position of the gadget.
title string The title of the gadget.
uri string The URI of the gadget type.
View JSON Schema on GitHub

JSON Schema

atlassian-dashboardgadget-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DashboardGadget",
  "title": "DashboardGadget",
  "additionalProperties": false,
  "description": "Details of a gadget.",
  "properties": {
    "color": {
      "description": "The color of the gadget. Should be one of `blue`, `red`, `yellow`, `green`, `cyan`, `purple`, `gray`, or `white`.",
      "enum": [
        "blue",
        "red",
        "yellow",
        "green",
        "cyan",
        "purple",
        "gray",
        "white"
      ],
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the gadget instance.",
      "format": "int64",
      "readOnly": true,
      "type": "integer"
    },
    "moduleKey": {
      "description": "The module key of the gadget type.",
      "readOnly": true,
      "type": "string"
    },
    "position": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardGadgetPosition"
        }
      ],
      "description": "The position of the gadget.",
      "readOnly": true
    },
    "title": {
      "description": "The title of the gadget.",
      "readOnly": true,
      "type": "string"
    },
    "uri": {
      "description": "The URI of the gadget type.",
      "readOnly": true,
      "type": "string"
    }
  },
  "required": [
    "color",
    "id",
    "position",
    "title"
  ],
  "type": "object"
}