Update get/export audit logs spec

This commit is contained in:
Tuan Dang
2023-11-23 12:18:01 +07:00
parent 097a8cae89
commit 53ac05694c
4 changed files with 26 additions and 128 deletions
@@ -583,8 +583,7 @@ export const getWorkspaceAuditLogs = async (req: Request, res: Response) => {
#swagger.description = 'Return audit logs'
#swagger.security = [{
"apiKeyAuth": [],
"bearerAuth": []
"apiKeyAuth": []
}]
#swagger.parameters['workspaceId'] = {
@@ -595,43 +594,43 @@ export const getWorkspaceAuditLogs = async (req: Request, res: Response) => {
}
#swagger.parameters['offset'] = {
"description": "Number of versions to skip",
"description": "Number of logs to skip before starting to return logs for pagination",
"required": false,
"type": "string"
}
#swagger.parameters['limit'] = {
"description": "Maximum number of versions to return",
"description": "Maximum number of logs to return for pagination",
"required": false,
"type": "string"
}
#swagger.parameters['startDate'] = {
"description": "Filter logs from the provided date",
"description": "Filter logs from this date in ISO-8601 format",
"required": false,
"type": "string"
}
#swagger.parameters['endDate'] = {
"description": "Filter logs till the provided date",
"description": "Filter logs till this date in ISO-8601 format",
"required": false,
"type": "string"
}
#swagger.parameters['eventType'] = {
"description": "Type of event",
"description": "Filter by type of event such as get-secrets, get-secret, create-secret, update-secret, delete-secret, etc.",
"required": false,
"type": "string",
}
#swagger.parameters['userAgentType'] = {
"description": "Type of event",
"description": "Filter by type of user agent such as web, cli, k8-operator, or other",
"required": false,
"type": "string",
}
#swagger.parameters['actor'] = {
"description": "Source of operation. It can be user, service token etc",
"description": "Filter by actor such as user or service",
"required": false,
"type": "string"
}