Lightdash · Example Payload

Lightdash V2 Example

v2Custom Roles

Lightdash V2 Example is an example object payload from Lightdash, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

methodpathsummarytagsrequestBodyresponses

Example Payload

Raw ↑ 
{
  "method": "POST",
  "path": "/api/v2/orgs/{orgUuid}/roles",
  "summary": "Create custom role",
  "tags": [
    "v2",
    "Custom Roles"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/CreateRole"
        }
      }
    }
  },
  "responses": {
    "201": {
      "description": "Created",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiDefaultRoleResponse"
          }
        }
      }
    },
    "default": {
      "description": "Error",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/ApiErrorPayload"
          }
        }
      }
    }
  }
}