From 29e8f00d31acb7b039513c52eb8aff0dd7d06b22 Mon Sep 17 00:00:00 2001 From: powerfool Date: Wed, 22 May 2024 17:50:35 +0800 Subject: [PATCH] fix(api-docs): fixed missing path parameters in obproxy api docs (#395) --- internal/dashboard/generated/swagger/docs.go | 46 +++++++++++++++++++ .../dashboard/generated/swagger/swagger.json | 46 +++++++++++++++++++ .../dashboard/generated/swagger/swagger.yaml | 32 +++++++++++++ internal/dashboard/handler/obproxy_handler.go | 6 +++ 4 files changed, 130 insertions(+) diff --git a/internal/dashboard/generated/swagger/docs.go b/internal/dashboard/generated/swagger/docs.go index dd32f3825..81705d1a1 100644 --- a/internal/dashboard/generated/swagger/docs.go +++ b/internal/dashboard/generated/swagger/docs.go @@ -2998,6 +2998,22 @@ const docTemplate = `{ ], "summary": "Get OBProxy", "operationId": "GetOBProxy", + "parameters": [ + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true + } + ], "responses": { "200": { "description": "OK", @@ -3055,6 +3071,22 @@ const docTemplate = `{ ], "summary": "Delete OBProxy", "operationId": "DeleteOBProxy", + "parameters": [ + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true + } + ], "responses": { "200": { "description": "OK", @@ -3121,6 +3153,20 @@ const docTemplate = `{ "schema": { "$ref": "#/definitions/obproxy.PatchOBProxyParam" } + }, + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true } ], "responses": { diff --git a/internal/dashboard/generated/swagger/swagger.json b/internal/dashboard/generated/swagger/swagger.json index 60f21f820..84d3c5625 100644 --- a/internal/dashboard/generated/swagger/swagger.json +++ b/internal/dashboard/generated/swagger/swagger.json @@ -2991,6 +2991,22 @@ ], "summary": "Get OBProxy", "operationId": "GetOBProxy", + "parameters": [ + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true + } + ], "responses": { "200": { "description": "OK", @@ -3048,6 +3064,22 @@ ], "summary": "Delete OBProxy", "operationId": "DeleteOBProxy", + "parameters": [ + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true + } + ], "responses": { "200": { "description": "OK", @@ -3114,6 +3146,20 @@ "schema": { "$ref": "#/definitions/obproxy.PatchOBProxyParam" } + }, + { + "type": "string", + "description": "namespace of obproxy deployment", + "name": "namespace", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "name of obproxy deployment", + "name": "name", + "in": "path", + "required": true } ], "responses": { diff --git a/internal/dashboard/generated/swagger/swagger.yaml b/internal/dashboard/generated/swagger/swagger.yaml index bc43e9216..c6b562db4 100644 --- a/internal/dashboard/generated/swagger/swagger.yaml +++ b/internal/dashboard/generated/swagger/swagger.yaml @@ -4086,6 +4086,17 @@ paths: - application/json description: Delete OBProxy by namespace and name operationId: DeleteOBProxy + parameters: + - description: namespace of obproxy deployment + in: path + name: namespace + required: true + type: string + - description: name of obproxy deployment + in: path + name: name + required: true + type: string produces: - application/json responses: @@ -4120,6 +4131,17 @@ paths: - application/json description: Get OBProxy by namespace and name operationId: GetOBProxy + parameters: + - description: namespace of obproxy deployment + in: path + name: namespace + required: true + type: string + - description: name of obproxy deployment + in: path + name: name + required: true + type: string produces: - application/json responses: @@ -4161,6 +4183,16 @@ paths: required: true schema: $ref: '#/definitions/obproxy.PatchOBProxyParam' + - description: namespace of obproxy deployment + in: path + name: namespace + required: true + type: string + - description: name of obproxy deployment + in: path + name: name + required: true + type: string produces: - application/json responses: diff --git a/internal/dashboard/handler/obproxy_handler.go b/internal/dashboard/handler/obproxy_handler.go index ca297a8fd..781a93e5d 100644 --- a/internal/dashboard/handler/obproxy_handler.go +++ b/internal/dashboard/handler/obproxy_handler.go @@ -67,6 +67,8 @@ func CreateOBProxy(c *gin.Context) (*obproxy.OBProxy, error) { // @Tags OBProxy // @Accept application/json // @Produce application/json +// @Param namespace path string true "namespace of obproxy deployment" +// @Param name path string true "name of obproxy deployment" // @Success 200 object response.APIResponse{data=obproxy.OBProxy} // @Failure 400 object response.APIResponse // @Failure 401 object response.APIResponse @@ -89,6 +91,8 @@ func GetOBProxy(c *gin.Context) (*obproxy.OBProxy, error) { // @Accept application/json // @Produce application/json // @Param body body obproxy.PatchOBProxyParam true "Request body for patching obproxy" +// @Param namespace path string true "namespace of obproxy deployment" +// @Param name path string true "name of obproxy deployment" // @Success 200 object response.APIResponse{data=obproxy.OBProxy} // @Failure 400 object response.APIResponse // @Failure 401 object response.APIResponse @@ -115,6 +119,8 @@ func PatchOBProxy(c *gin.Context) (*obproxy.OBProxy, error) { // @Tags OBProxy // @Accept application/json // @Produce application/json +// @Param namespace path string true "namespace of obproxy deployment" +// @Param name path string true "name of obproxy deployment" // @Success 200 object response.APIResponse{data=obproxy.OBProxy} // @Failure 400 object response.APIResponse // @Failure 401 object response.APIResponse