fix(swagger): update is mandatory to true (chaos-mesh#3743)

* fix(swagger): update `is mandatory` to true Signed-off-by: Yue Yang <[email protected]> * chore: update changelog Signed-off-by: Yue Yang <[email protected]> Signed-off-by: Yue Yang <[email protected]>
FingerLeader · Nov 3, 2022 · 8b13f5a · 8b13f5a
1 parent ce876cf
commit 8b13f5a
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 17 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -34,6 +34,7 @@ For more information and how-to, see [RFC: Keep A Changelog](https://github.com/
 - Fix typo in controller error message [#3704](https://github.com/chaos-mesh/chaos-mesh/pull/3704)
 - Fix panic when logging, log kvs as pair [#3716](https://github.com/chaos-mesh/chaos-mesh/pull/3716)
 - Fix timechaos not injected into the child process [#3725](https://github.com/chaos-mesh/chaos-mesh/pull/3725)
+- Update `is mandatory` to true in a swagger comment [#3743](https://github.com/chaos-mesh/chaos-mesh/pull/3743)
 
 ### Security
 

diff --git a/pkg/dashboard/apiserver/event/event.go b/pkg/dashboard/apiserver/event/event.go
@@ -120,8 +120,8 @@ func (s *Service) list(c *gin.Context) {
 // @Description list all events for Workflow and related WorkflowNode.
 // @Tags events
 // @Produce json
+// @Param uid path string true "The UID of the Workflow"
 // @Param namespace query string false "The namespace of the object"
-// @Param uid path string false "The UID of the Workflow"
 // @Param limit query number false "The max length of events list"
 // @Success 200 {array} core.Event
 // @Failure 500 {object} u.APIError

diff --git a/pkg/dashboard/swaggerdocs/docs.go b/pkg/dashboard/swaggerdocs/docs.go
@@ -944,15 +944,16 @@ const docTemplate = `{
                 "parameters": [
                     {
                         "type": "string",
-                        "description": "The namespace of the object",
-                        "name": "namespace",
-                        "in": "query"
+                        "description": "The UID of the Workflow",
+                        "name": "uid",
+                        "in": "path",
+                        "required": true
                     },
                     {
                         "type": "string",
-                        "description": "The UID of the Workflow",
-                        "name": "uid",
-                        "in": "path"
+                        "description": "The namespace of the object",
+                        "name": "namespace",
+                        "in": "query"
                     },
                     {
                         "type": "number",

diff --git a/pkg/dashboard/swaggerdocs/swagger.json b/pkg/dashboard/swaggerdocs/swagger.json
@@ -936,15 +936,16 @@
                 "parameters": [
                     {
                         "type": "string",
-                        "description": "The namespace of the object",
-                        "name": "namespace",
-                        "in": "query"
+                        "description": "The UID of the Workflow",
+                        "name": "uid",
+                        "in": "path",
+                        "required": true
                     },
                     {
                         "type": "string",
-                        "description": "The UID of the Workflow",
-                        "name": "uid",
-                        "in": "path"
+                        "description": "The namespace of the object",
+                        "name": "namespace",
+                        "in": "query"
                     },
                     {
                         "type": "number",

diff --git a/pkg/dashboard/swaggerdocs/swagger.yaml b/pkg/dashboard/swaggerdocs/swagger.yaml
@@ -6952,13 +6952,14 @@ paths:
     get:
       description: list all events for Workflow and related WorkflowNode.
       parameters:
-      - description: The namespace of the object
-        in: query
-        name: namespace
-        type: string
       - description: The UID of the Workflow
         in: path
         name: uid
+        required: true
+        type: string
+      - description: The namespace of the object
+        in: query
+        name: namespace
         type: string
       - description: The max length of events list
         in: query