From b5c61d7bfb2ae751b24be30cebfd3e4b80781f13 Mon Sep 17 00:00:00 2001 From: donggyu Date: Thu, 28 Mar 2024 11:26:04 +0900 Subject: [PATCH] minor fix. fix swag error --- api/swagger/docs.go | 125 ++++++++++++++++----------- api/swagger/swagger.json | 125 ++++++++++++++++----------- api/swagger/swagger.yaml | 87 +++++++++++-------- internal/delivery/http/permission.go | 2 +- internal/delivery/http/role.go | 2 +- 5 files changed, 199 insertions(+), 142 deletions(-) diff --git a/api/swagger/docs.go b/api/swagger/docs.go index 61cffa4b..c81d7dac 100644 --- a/api/swagger/docs.go +++ b/api/swagger/docs.go @@ -6191,7 +6191,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse" } } } @@ -7974,7 +7974,7 @@ const docTemplate = `{ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse" } } } @@ -10329,6 +10329,30 @@ const docTemplate = `{ } } }, + "github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "Permissions *PermissionTemplateResponse ` + "`" + `json:\"permissions\"` + "`" + `", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse" + } + } + } + }, + "github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "Permissions *PermissionSetResponse ` + "`" + `json:\"permissions\"` + "`" + `", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" + } + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.GetPolicyResponse": { "type": "object", "properties": { @@ -10703,7 +10727,11 @@ const docTemplate = `{ "type": "object", "properties": { "permissions": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse" + "description": "Permissions *MergedPermissionSetResponse ` + "`" + `json:\"permissions\"` + "`" + `", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" + } } } }, @@ -11007,7 +11035,7 @@ const docTemplate = `{ "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" } }, - "is_allowed": { + "isAllowed": { "type": "boolean" }, "key": { @@ -11015,29 +11043,6 @@ const docTemplate = `{ } } }, - "github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse": { - "type": "object", - "properties": { - "configuration": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "dashboard": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "notification": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "policy": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "project_management": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "stack": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - } - } - }, "github_com_openinfradev_tks-api_pkg_domain.OrganizationResponse": { "type": "object", "properties": { @@ -11161,7 +11166,7 @@ const docTemplate = `{ "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.EndpointResponse" } }, - "is_allowed": { + "isAllowed": { "type": "boolean" }, "key": { @@ -11172,29 +11177,6 @@ const docTemplate = `{ } } }, - "github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse": { - "type": "object", - "properties": { - "configuration": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "dashboard": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "notification": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "policy": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "project_management": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "stack": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - } - } - }, "github_com_openinfradev_tks-api_pkg_domain.PermittedOrganization": { "type": "object", "properties": { @@ -12472,6 +12454,26 @@ const docTemplate = `{ } } }, + "github_com_openinfradev_tks-api_pkg_domain.TemplateResponse": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse" + } + }, + "isAllowed": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.Unit": { "type": "object", "properties": { @@ -12691,13 +12693,32 @@ const docTemplate = `{ } } }, + "github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest": { + "type": "object", + "required": [ + "ID", + "isAllowed" + ], + "properties": { + "ID": { + "type": "string" + }, + "isAllowed": { + "type": "boolean", + "enum": [ + true, + false + ] + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionsByRoleIdRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest" } } } diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json index 880944d0..e67b2342 100644 --- a/api/swagger/swagger.json +++ b/api/swagger/swagger.json @@ -6185,7 +6185,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse" } } } @@ -7968,7 +7968,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse" } } } @@ -10323,6 +10323,30 @@ } } }, + "github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "Permissions *PermissionTemplateResponse `json:\"permissions\"`", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse" + } + } + } + }, + "github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "Permissions *PermissionSetResponse `json:\"permissions\"`", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" + } + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.GetPolicyResponse": { "type": "object", "properties": { @@ -10697,7 +10721,11 @@ "type": "object", "properties": { "permissions": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse" + "description": "Permissions *MergedPermissionSetResponse `json:\"permissions\"`", + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" + } } } }, @@ -11001,7 +11029,7 @@ "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" } }, - "is_allowed": { + "isAllowed": { "type": "boolean" }, "key": { @@ -11009,29 +11037,6 @@ } } }, - "github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse": { - "type": "object", - "properties": { - "configuration": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "dashboard": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "notification": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "policy": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "project_management": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - }, - "stack": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse" - } - } - }, "github_com_openinfradev_tks-api_pkg_domain.OrganizationResponse": { "type": "object", "properties": { @@ -11155,7 +11160,7 @@ "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.EndpointResponse" } }, - "is_allowed": { + "isAllowed": { "type": "boolean" }, "key": { @@ -11166,29 +11171,6 @@ } } }, - "github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse": { - "type": "object", - "properties": { - "configuration": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "dashboard": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "notification": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "policy": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "project_management": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - }, - "stack": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" - } - } - }, "github_com_openinfradev_tks-api_pkg_domain.PermittedOrganization": { "type": "object", "properties": { @@ -12466,6 +12448,26 @@ } } }, + "github_com_openinfradev_tks-api_pkg_domain.TemplateResponse": { + "type": "object", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse" + } + }, + "isAllowed": { + "type": "boolean" + }, + "key": { + "type": "string" + }, + "name": { + "type": "string" + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.Unit": { "type": "object", "properties": { @@ -12685,13 +12687,32 @@ } } }, + "github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest": { + "type": "object", + "required": [ + "ID", + "isAllowed" + ], + "properties": { + "ID": { + "type": "string" + }, + "isAllowed": { + "type": "boolean", + "enum": [ + true, + false + ] + } + } + }, "github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionsByRoleIdRequest": { "type": "object", "properties": { "permissions": { "type": "array", "items": { - "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse" + "$ref": "#/definitions/github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest" } } } diff --git a/api/swagger/swagger.yaml b/api/swagger/swagger.yaml index 6a4a557a..f430024b 100644 --- a/api/swagger/swagger.yaml +++ b/api/swagger/swagger.yaml @@ -1544,6 +1544,22 @@ definitions: organization: $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.OrganizationResponse' type: object + github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse: + properties: + permissions: + description: Permissions *PermissionTemplateResponse `json:"permissions"` + items: + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse' + type: array + type: object + github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse: + properties: + permissions: + description: Permissions *PermissionSetResponse `json:"permissions"` + items: + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' + type: array + type: object github_com_openinfradev_tks-api_pkg_domain.GetPolicyResponse: properties: policy: @@ -1783,7 +1799,10 @@ definitions: github_com_openinfradev_tks-api_pkg_domain.GetUsersPermissionsResponse: properties: permissions: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse' + description: Permissions *MergedPermissionSetResponse `json:"permissions"` + items: + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' + type: array type: object github_com_openinfradev_tks-api_pkg_domain.ImportClusterRequest: properties: @@ -1984,26 +2003,11 @@ definitions: items: $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' type: array - is_allowed: + isAllowed: type: boolean key: type: string type: object - github_com_openinfradev_tks-api_pkg_domain.MergedPermissionSetResponse: - properties: - configuration: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - dashboard: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - notification: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - policy: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - project_management: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - stack: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.MergePermissionResponse' - type: object github_com_openinfradev_tks-api_pkg_domain.OrganizationResponse: properties: admin: @@ -2085,28 +2089,13 @@ definitions: items: $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.EndpointResponse' type: array - is_allowed: + isAllowed: type: boolean key: type: string name: type: string type: object - github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse: - properties: - configuration: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - dashboard: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - notification: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - policy: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - project_management: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - stack: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' - type: object github_com_openinfradev_tks-api_pkg_domain.PermittedOrganization: properties: organizationId: @@ -2959,6 +2948,19 @@ definitions: required: - metricQuery type: object + github_com_openinfradev_tks-api_pkg_domain.TemplateResponse: + properties: + children: + items: + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.TemplateResponse' + type: array + isAllowed: + type: boolean + key: + type: string + name: + type: string + type: object github_com_openinfradev_tks-api_pkg_domain.Unit: properties: data: @@ -3105,11 +3107,24 @@ definitions: - newPassword - originPassword type: object + github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest: + properties: + ID: + type: string + isAllowed: + enum: + - true + - false + type: boolean + required: + - ID + - isAllowed + type: object github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionsByRoleIdRequest: properties: permissions: items: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionResponse' + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.UpdatePermissionUpdateRequest' type: array type: object github_com_openinfradev_tks-api_pkg_domain.UpdatePolicyClustersRequest: @@ -7461,7 +7476,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse' + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionsByRoleIdResponse' security: - JWT: [] summary: Get Permissions By Role ID @@ -8621,7 +8636,7 @@ paths: "200": description: OK schema: - $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.PermissionSetResponse' + $ref: '#/definitions/github_com_openinfradev_tks-api_pkg_domain.GetPermissionTemplatesResponse' security: - JWT: [] summary: Get Permission Templates diff --git a/internal/delivery/http/permission.go b/internal/delivery/http/permission.go index 2dcaf3ce..3ad7798f 100644 --- a/internal/delivery/http/permission.go +++ b/internal/delivery/http/permission.go @@ -32,7 +32,7 @@ func NewPermissionHandler(usecase usecase.Usecase) IPermissionHandler { // @Description Get Permission Templates // @Accept json // @Produce json -// @Success 200 {object} domain.PermissionSetResponse +// @Success 200 {object} domain.GetPermissionTemplatesResponse // @Router /permissions/templates [get] // @Security JWT func (h PermissionHandler) GetPermissionTemplates(w http.ResponseWriter, r *http.Request) { diff --git a/internal/delivery/http/role.go b/internal/delivery/http/role.go index f3a69004..b96f4792 100644 --- a/internal/delivery/http/role.go +++ b/internal/delivery/http/role.go @@ -285,7 +285,7 @@ func (h RoleHandler) UpdateTksRole(w http.ResponseWriter, r *http.Request) { // @Produce json // @Param organizationId path string true "Organization ID" // @Param roleId path string true "Role ID" -// @Success 200 {object} domain.PermissionSetResponse +// @Success 200 {object} domain.GetPermissionsByRoleIdResponse // @Router /organizations/{organizationId}/roles/{roleId}/permissions [get] // @Security JWT func (h RoleHandler) GetPermissionsByRoleId(w http.ResponseWriter, r *http.Request) {