{
  "schemaVersion": 1,
  "operation": {
    "operationId": "getDashboard",
    "method": "GET",
    "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}",
    "summary": "Describe dashboard",
    "description": "",
    "tags": [
      "BI"
    ],
    "effect": "read",
    "confirmation": "never",
    "authorization": {
      "mode": "privilege",
      "privilege": "VIEW_ITEM"
    },
    "parameters": [
      {
        "name": "workspace",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "dashboard",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": [
      {
        "status": "200",
        "description": "The request has succeeded.",
        "content": [
          {
            "contentType": "application/json",
            "schema": {
              "$ref": "#/components/schemas/DashboardManifestResponse"
            }
          }
        ]
      },
      {
        "status": "400",
        "description": "The server could not understand the request due to invalid syntax.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "401",
        "description": "Access is unauthorized.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "403",
        "description": "Access is forbidden.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "404",
        "description": "The server cannot find the requested resource.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "409",
        "description": "The request conflicts with the current state of the server.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "412",
        "description": "Precondition failed.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "413",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "415",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "422",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "429",
        "description": "Client error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "500",
        "description": "Server error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "502",
        "description": "Server error",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      },
      {
        "status": "503",
        "description": "Service unavailable.",
        "content": [
          {
            "contentType": "application/problem+json",
            "schema": {
              "$ref": "#/components/schemas/ProblemDetails"
            }
          }
        ]
      }
    ]
  },
  "schemas": {
    "DashboardManifestComponent": {
      "example": {
        "id": "example",
        "kind": "example",
        "ref": "example",
        "title": "example"
      },
      "properties": {
        "id": {
          "example": "example",
          "type": "string"
        },
        "kind": {
          "enum": [
            "visual",
            "filter",
            "header"
          ],
          "example": "example",
          "type": "string"
        },
        "ref": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "id",
        "kind",
        "ref"
      ],
      "type": "object"
    },
    "DashboardManifestCounts": {
      "example": {
        "filters": 1,
        "pages": 1,
        "visuals": 1
      },
      "properties": {
        "filters": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "pages": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "visuals": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        }
      },
      "required": [
        "pages",
        "visuals",
        "filters"
      ],
      "type": "object"
    },
    "DashboardManifestPage": {
      "example": {
        "components": [
          {
            "id": "example",
            "kind": "example",
            "ref": "example",
            "title": "example"
          }
        ],
        "description": "example",
        "id": "example",
        "title": "example"
      },
      "properties": {
        "components": {
          "example": [
            {
              "id": "example",
              "kind": "example",
              "ref": "example",
              "title": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/DashboardManifestComponent"
          },
          "type": "array"
        },
        "description": {
          "example": "example",
          "type": "string"
        },
        "id": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "id",
        "title",
        "components"
      ],
      "type": "object"
    },
    "DashboardManifestResponse": {
      "example": {
        "counts": {
          "filters": 1,
          "pages": 1,
          "visuals": 1
        },
        "description": "example",
        "detail_tools": {
          "key": "example"
        },
        "id": "example",
        "model": {
          "id": "example",
          "title": "example"
        },
        "pages": [
          {
            "components": [
              {
                "id": "example",
                "kind": "example",
                "ref": "example",
                "title": "example"
              }
            ],
            "description": "example",
            "id": "example",
            "title": "example"
          }
        ],
        "semantic_model": "example",
        "title": "example"
      },
      "properties": {
        "counts": {
          "$ref": "#/components/schemas/DashboardManifestCounts"
        },
        "description": {
          "example": "example",
          "type": "string"
        },
        "detail_tools": {
          "additionalProperties": {
            "type": "string"
          },
          "example": {
            "key": "example"
          },
          "type": "object"
        },
        "id": {
          "example": "example",
          "type": "string"
        },
        "model": {
          "$ref": "#/components/schemas/ModelRef"
        },
        "pages": {
          "example": [
            {
              "components": [
                {
                  "id": "example",
                  "kind": "example",
                  "ref": "example",
                  "title": "example"
                }
              ],
              "description": "example",
              "id": "example",
              "title": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/DashboardManifestPage"
          },
          "type": "array"
        },
        "semantic_model": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "id",
        "title",
        "counts",
        "pages",
        "detail_tools"
      ],
      "type": "object"
    },
    "ModelRef": {
      "example": {
        "id": "example",
        "title": "example"
      },
      "properties": {
        "id": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "id",
        "title"
      ],
      "type": "object"
    },
    "ProblemDetails": {
      "example": {
        "code": "example",
        "detail": "example",
        "errors": [
          {
            "code": "example",
            "detail": "example",
            "field": "example"
          }
        ],
        "instance": "example",
        "requestId": "example",
        "status": 1,
        "title": "example",
        "type": "example"
      },
      "properties": {
        "code": {
          "example": "example",
          "type": "string"
        },
        "detail": {
          "example": "example",
          "type": "string"
        },
        "errors": {
          "example": [
            {
              "code": "example",
              "detail": "example",
              "field": "example"
            }
          ],
          "items": {
            "$ref": "#/components/schemas/ProblemFieldError"
          },
          "type": "array"
        },
        "instance": {
          "example": "example",
          "type": "string"
        },
        "requestId": {
          "example": "example",
          "type": "string"
        },
        "status": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "title": {
          "example": "example",
          "type": "string"
        },
        "type": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "type",
        "title",
        "status",
        "detail",
        "instance",
        "code",
        "requestId",
        "errors"
      ],
      "type": "object"
    },
    "ProblemFieldError": {
      "example": {
        "code": "example",
        "detail": "example",
        "field": "example"
      },
      "properties": {
        "code": {
          "example": "example",
          "type": "string"
        },
        "detail": {
          "example": "example",
          "type": "string"
        },
        "field": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "field",
        "code",
        "detail"
      ],
      "type": "object"
    }
  }
}