LBAC for datasources: Update swagger documentation (#92594)

* LBAC for datasources: Update swagger documentation

* update swagger again
This commit is contained in:
Eric Leijonmarck 2024-08-28 17:04:57 +01:00 committed by GitHub
parent 8324a720f4
commit 577ebb3444
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 261 additions and 8 deletions

View File

@ -777,7 +777,7 @@
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/okResponse" "$ref": "#/responses/getTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/responses/badRequestError" "$ref": "#/responses/badRequestError"
@ -808,11 +808,18 @@
"name": "uid", "name": "uid",
"in": "path", "in": "path",
"required": true "required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateTeamLBACCommand"
}
} }
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/okResponse" "$ref": "#/responses/updateTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/responses/badRequestError" "$ref": "#/responses/badRequestError"
@ -3299,6 +3306,9 @@
"type": "string", "type": "string",
"example": "PE1C5CBDA0504A6A3" "example": "PE1C5CBDA0504A6A3"
}, },
"type": {
"$ref": "#/definitions/CorrelationType"
},
"uid": { "uid": {
"description": "Unique identifier of the correlation", "description": "Unique identifier of the correlation",
"type": "string", "type": "string",
@ -3310,7 +3320,6 @@
"type": "object", "type": "object",
"required": [ "required": [
"field", "field",
"type",
"target" "target"
], ],
"properties": { "properties": {
@ -3330,6 +3339,9 @@
}, },
"transformations": { "transformations": {
"$ref": "#/definitions/Transformations" "$ref": "#/definitions/Transformations"
},
"type": {
"$ref": "#/definitions/CorrelationType"
} }
} }
}, },
@ -3369,6 +3381,9 @@
} }
} }
}, },
"CorrelationType": {
"type": "string"
},
"CreateAccessTokenResponseDTO": { "CreateAccessTokenResponseDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -3399,9 +3414,12 @@
"type": "boolean" "type": "boolean"
}, },
"targetUID": { "targetUID": {
"description": "Target data source UID to which the correlation is created. required if config.type = query", "description": "Target data source UID to which the correlation is created. required if type = query",
"type": "string", "type": "string",
"example": "PE1C5CBDA0504A6A3" "example": "PE1C5CBDA0504A6A3"
},
"type": {
"$ref": "#/definitions/CorrelationType"
} }
} }
}, },
@ -7377,6 +7395,31 @@
} }
} }
}, },
"TeamLBACRule": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "string"
}
},
"teamId": {
"type": "string"
}
}
},
"TeamLBACRules": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
}
}
},
"TeamMemberDTO": { "TeamMemberDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -7809,6 +7852,9 @@
"description": "Optional label identifying the correlation", "description": "Optional label identifying the correlation",
"type": "string", "type": "string",
"example": "My label" "example": "My label"
},
"type": {
"$ref": "#/definitions/CorrelationType"
} }
} }
}, },
@ -8106,6 +8152,17 @@
} }
} }
}, },
"UpdateTeamLBACCommand": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
}
}
},
"UpdateTeamMemberCommand": { "UpdateTeamMemberCommand": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -9337,6 +9394,15 @@
} }
} }
}, },
"getTeamLBACRulesResponse": {
"description": "",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRules"
}
}
},
"getTeamMembersResponse": { "getTeamMembersResponse": {
"description": "", "description": "",
"schema": { "schema": {
@ -9832,6 +9898,30 @@
} }
} }
}, },
"updateTeamLBACRulesResponse": {
"description": "",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"lbacRules": {
"$ref": "#/definitions/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
}
}
},
"userResponse": { "userResponse": {
"description": "", "description": "",
"schema": { "schema": {

View File

@ -4623,7 +4623,7 @@
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/okResponse" "$ref": "#/responses/getTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/responses/badRequestError" "$ref": "#/responses/badRequestError"
@ -4654,11 +4654,18 @@
"name": "uid", "name": "uid",
"in": "path", "in": "path",
"required": true "required": true
},
{
"name": "body",
"in": "body",
"schema": {
"$ref": "#/definitions/UpdateTeamLBACCommand"
}
} }
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/responses/okResponse" "$ref": "#/responses/updateTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/responses/badRequestError" "$ref": "#/responses/badRequestError"
@ -20691,6 +20698,31 @@
} }
} }
}, },
"TeamLBACRule": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"type": "string"
}
},
"teamId": {
"type": "string"
}
}
},
"TeamLBACRules": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
}
}
},
"TeamMemberDTO": { "TeamMemberDTO": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -21715,6 +21747,17 @@
} }
} }
}, },
"UpdateTeamLBACCommand": {
"type": "object",
"properties": {
"rules": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRule"
}
}
}
},
"UpdateTeamMemberCommand": { "UpdateTeamMemberCommand": {
"type": "object", "type": "object",
"properties": { "properties": {
@ -23718,6 +23761,15 @@
} }
} }
}, },
"getTeamLBACRulesResponse": {
"description": "(empty)",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/TeamLBACRules"
}
}
},
"getTeamMembersResponse": { "getTeamMembersResponse": {
"description": "(empty)", "description": "(empty)",
"schema": { "schema": {
@ -24228,6 +24280,30 @@
} }
} }
}, },
"updateTeamLBACRulesResponse": {
"description": "(empty)",
"schema": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"lbacRules": {
"$ref": "#/definitions/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
}
}
},
"userResponse": { "userResponse": {
"description": "(empty)", "description": "(empty)",
"schema": { "schema": {

View File

@ -1307,6 +1307,19 @@
}, },
"description": "(empty)" "description": "(empty)"
}, },
"getTeamLBACRulesResponse": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/TeamLBACRules"
},
"type": "array"
}
}
},
"description": "(empty)"
},
"getTeamMembersResponse": { "getTeamMembersResponse": {
"content": { "content": {
"application/json": { "application/json": {
@ -2037,6 +2050,34 @@
}, },
"description": "(empty)" "description": "(empty)"
}, },
"updateTeamLBACRulesResponse": {
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"format": "int64",
"type": "integer"
},
"lbacRules": {
"$ref": "#/components/schemas/TeamLBACRules"
},
"message": {
"type": "string"
},
"name": {
"type": "string"
},
"uid": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "(empty)"
},
"userResponse": { "userResponse": {
"content": { "content": {
"application/json": { "application/json": {
@ -10785,6 +10826,31 @@
}, },
"type": "object" "type": "object"
}, },
"TeamLBACRule": {
"properties": {
"rules": {
"items": {
"type": "string"
},
"type": "array"
},
"teamId": {
"type": "string"
}
},
"type": "object"
},
"TeamLBACRules": {
"properties": {
"rules": {
"items": {
"$ref": "#/components/schemas/TeamLBACRule"
},
"type": "array"
}
},
"type": "object"
},
"TeamMemberDTO": { "TeamMemberDTO": {
"properties": { "properties": {
"auth_module": { "auth_module": {
@ -11809,6 +11875,17 @@
}, },
"type": "object" "type": "object"
}, },
"UpdateTeamLBACCommand": {
"properties": {
"rules": {
"items": {
"$ref": "#/components/schemas/TeamLBACRule"
},
"type": "array"
}
},
"type": "object"
},
"UpdateTeamMemberCommand": { "UpdateTeamMemberCommand": {
"properties": { "properties": {
"permission": { "permission": {
@ -17894,7 +17971,7 @@
], ],
"responses": { "responses": {
"200": { "200": {
"$ref": "#/components/responses/okResponse" "$ref": "#/components/responses/getTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/components/responses/badRequestError" "$ref": "#/components/responses/badRequestError"
@ -17929,9 +18006,19 @@
} }
} }
], ],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTeamLBACCommand"
}
}
},
"x-originalParamName": "body"
},
"responses": { "responses": {
"200": { "200": {
"$ref": "#/components/responses/okResponse" "$ref": "#/components/responses/updateTeamLBACRulesResponse"
}, },
"400": { "400": {
"$ref": "#/components/responses/badRequestError" "$ref": "#/components/responses/badRequestError"