feat: add validate for CourseGroupSearchV3Request

OpenTreeHole · Sep 28, 2023 · 0abe361 · 0abe361
1 parent 8306842
commit 0abe361
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 8 deletions.
diff --git a/internal/docs/docs.go b/internal/docs/docs.go
@@ -890,19 +890,26 @@ const docTemplate = `{
                 "summary": "search course group",
                 "parameters": [
                     {
+                        "minimum": 0,
                         "type": "integer",
+                        "example": 0,
                         "name": "page",
                         "in": "query"
                     },
                     {
+                        "maximum": 100,
+                        "minimum": 0,
                         "type": "integer",
+                        "example": 10,
                         "name": "page_size",
                         "in": "query"
                     },
                     {
                         "type": "string",
+                        "example": "计算机",
                         "name": "query",
-                        "in": "query"
+                        "in": "query",
+                        "required": true
                     }
                 ],
                 "responses": {

diff --git a/internal/docs/swagger.json b/internal/docs/swagger.json
@@ -887,19 +887,26 @@
                 "summary": "search course group",
                 "parameters": [
                     {
+                        "minimum": 0,
                         "type": "integer",
+                        "example": 0,
                         "name": "page",
                         "in": "query"
                     },
                     {
+                        "maximum": 100,
+                        "minimum": 0,
                         "type": "integer",
+                        "example": 10,
                         "name": "page_size",
                         "in": "query"
                     },
                     {
                         "type": "string",
+                        "example": "计算机",
                         "name": "query",
-                        "in": "query"
+                        "in": "query",
+                        "required": true
                     }
                 ],
                 "responses": {

diff --git a/internal/docs/swagger.yaml b/internal/docs/swagger.yaml
@@ -1136,14 +1136,21 @@ paths:
         - application/json
       description: search course group, no courses
       parameters:
-        - in: query
+        - example: 0
+          in: query
+          minimum: 0
           name: page
           type: integer
-        - in: query
+        - example: 10
+          in: query
+          maximum: 100
+          minimum: 0
           name: page_size
           type: integer
-        - in: query
+        - example: 计算机
+          in: query
           name: query
+          required: true
           type: string
       produces:
         - application/json

diff --git a/internal/schema/course_group.go b/internal/schema/course_group.go
@@ -49,9 +49,9 @@ func (r *CourseGroupHashV1Response) FromModel(hash string) *CourseGroupHashV1Res
 /* V3 */
 
 type CourseGroupSearchV3Request struct {
-	Query    string `json:"query" form:"query" query:"query"`
-	Page     int    `json:"page" form:"page" query:"page"`
-	PageSize int    `json:"page_size" form:"page_size" query:"page_size"`
+	Query    string `json:"query" form:"query" query:"query" validate:"required" example:"计算机"`
+	Page     int    `json:"page" form:"page" query:"page" validate:"min=0" example:"0"`
+	PageSize int    `json:"page_size" form:"page_size" query:"page_size" validate:"min=0,max=100" example:"10"`
 }
 
 type CourseGroupV3Response struct {