{
  "schemaVersion": 1,
  "operation": {
    "operationId": "getDashboardPage",
    "method": "GET",
    "path": "/api/v1/workspaces/{workspace}/dashboards/{dashboard}/pages/{page}",
    "summary": "Describe dashboard page",
    "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"
        }
      },
      {
        "name": "page",
        "in": "path",
        "required": true,
        "description": "",
        "schema": {
          "type": "string"
        }
      }
    ],
    "responses": [
      {
        "status": "200",
        "description": "The request has succeeded.",
        "content": [
          {
            "contentType": "application/json",
            "schema": {
              "$ref": "#/components/schemas/DashboardPageResponse"
            }
          }
        ]
      },
      {
        "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": {
    "DashboardComponentPlacement": {
      "example": {
        "col": 1,
        "colSpan": 1,
        "row": 1,
        "rowSpan": 1
      },
      "properties": {
        "col": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "colSpan": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "row": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        },
        "rowSpan": {
          "example": 1,
          "format": "int32",
          "type": "integer"
        }
      },
      "type": "object"
    },
    "DashboardComponentResponse": {
      "discriminator": {
        "mapping": {
          "filter": "#/components/schemas/DashboardFilterComponentResponse",
          "header": "#/components/schemas/DashboardHeaderComponentResponse",
          "visual": "#/components/schemas/DashboardVisualComponentResponse"
        },
        "propertyName": "kind"
      },
      "oneOf": [
        {
          "$ref": "#/components/schemas/DashboardVisualComponentResponse"
        },
        {
          "$ref": "#/components/schemas/DashboardFilterComponentResponse"
        },
        {
          "$ref": "#/components/schemas/DashboardHeaderComponentResponse"
        }
      ]
    },
    "DashboardComponentResponseBase": {
      "example": {
        "description": "example",
        "height": 1,
        "id": "example",
        "kind": "example",
        "placement": {
          "col": 1,
          "colSpan": 1,
          "row": 1,
          "rowSpan": 1
        },
        "ref": "example",
        "title": "example",
        "width": 1,
        "x": 1,
        "y": 1
      },
      "properties": {
        "description": {
          "example": "example",
          "type": "string"
        },
        "height": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "id": {
          "example": "example",
          "type": "string"
        },
        "kind": {
          "enum": [
            "visual",
            "filter",
            "header"
          ],
          "example": "example",
          "type": "string"
        },
        "placement": {
          "$ref": "#/components/schemas/DashboardComponentPlacement"
        },
        "ref": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        },
        "width": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "x": {
          "example": 1,
          "format": "double",
          "type": "number"
        },
        "y": {
          "example": 1,
          "format": "double",
          "type": "number"
        }
      },
      "required": [
        "id",
        "kind"
      ],
      "type": "object"
    },
    "DashboardFilterComponentResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardComponentResponseBase"
        }
      ],
      "example": {
        "filterId": "example",
        "kind": "example"
      },
      "properties": {
        "filterId": {
          "example": "example",
          "type": "string"
        },
        "kind": {
          "enum": [
            "filter"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "filterId"
      ],
      "type": "object"
    },
    "DashboardHeaderComponentResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardComponentResponseBase"
        }
      ],
      "example": {
        "kind": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "header"
          ],
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind"
      ],
      "type": "object"
    },
    "DashboardPageResponse": {
      "example": {
        "components": [],
        "description": "example",
        "id": "example",
        "title": "example"
      },
      "properties": {
        "components": {
          "example": [],
          "items": {
            "$ref": "#/components/schemas/DashboardComponentResponse"
          },
          "type": "array"
        },
        "description": {
          "example": "example",
          "type": "string"
        },
        "id": {
          "example": "example",
          "type": "string"
        },
        "title": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "id",
        "title",
        "components"
      ],
      "type": "object"
    },
    "DashboardVisualComponentResponse": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DashboardComponentResponseBase"
        }
      ],
      "example": {
        "kind": "example",
        "visualId": "example"
      },
      "properties": {
        "kind": {
          "enum": [
            "visual"
          ],
          "example": "example",
          "type": "string"
        },
        "visualId": {
          "example": "example",
          "type": "string"
        }
      },
      "required": [
        "kind",
        "visualId"
      ],
      "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"
    }
  }
}