Files
superset2/docs/developer_docs_versioned_docs/version-6.1.0/api/get-an-rls.StatusCodes.json

182 lines
5.6 KiB
JSON

{
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"description_columns": {
"properties": {
"column_name": {
"description": "The description for the column name. Will be translated by babel",
"example": "A Nice description for the column",
"type": "string"
}
},
"type": "object"
},
"id": { "description": "The item id", "type": "string" },
"label_columns": {
"properties": {
"column_name": {
"description": "The label for the column name. Will be translated by babel",
"example": "A Nice label for the column",
"type": "string"
}
},
"type": "object"
},
"result": {
"properties": {
"clause": {
"description": "clause_description",
"type": "string"
},
"description": {
"description": "description_description",
"type": "string"
},
"filter_type": {
"description": "filter_type_description",
"enum": ["Regular", "Base"],
"type": "string"
},
"group_key": {
"description": "group_key_description",
"type": "string"
},
"id": { "description": "id_description", "type": "integer" },
"name": {
"description": "name_description",
"type": "string"
},
"roles": {
"items": {
"properties": {
"id": { "type": "integer" },
"name": { "type": "string" }
},
"type": "object",
"title": "Roles1"
},
"type": "array"
},
"tables": {
"items": {
"properties": {
"id": { "type": "integer" },
"schema": { "type": "string" },
"table_name": { "type": "string" }
},
"type": "object",
"title": "Tables"
},
"type": "array"
}
},
"type": "object",
"title": "RLSRestApi.get"
},
"show_columns": {
"description": "A list of columns",
"items": { "type": "string" },
"type": "array"
},
"show_title": {
"description": "A title to render. Will be translated by babel",
"example": "Show Item Details",
"type": "string"
}
},
"type": "object"
},
"example": {
"description_columns": {
"column_name": "A Nice description for the column"
},
"id": "string",
"label_columns": { "column_name": "A Nice label for the column" },
"result": {
"clause": "string",
"description": "string",
"filter_type": "Regular",
"group_key": "string",
"id": 1,
"name": "string",
"roles": [],
"tables": []
},
"show_columns": ["string"],
"show_title": "Show Item Details"
}
}
},
"description": "Item from Model"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Bad request: Invalid parameters provided" }
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Unauthorized: Authentication required" }
}
},
"description": "Unauthorized"
},
"404": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": {
"message": "Not found: The requested resource does not exist"
}
}
},
"description": "Not found"
},
"422": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": { "message": "Unprocessable entity: Validation error" }
}
},
"description": "Could not process entity"
},
"500": {
"content": {
"application/json": {
"schema": {
"properties": { "message": { "type": "string" } },
"type": "object"
},
"example": {
"message": "Internal server error: An unexpected error occurred"
}
}
},
"description": "Fatal error"
}
}
}