docs: document projects query parameter as optional (resolve muety#653)

Milopadma · Jul 6, 2024 · afe8634 · afe8634
1 parent 89550ee
commit afe8634
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 6 deletions.
diff --git a/routes/compat/wakatime/v1/projects.go b/routes/compat/wakatime/v1/projects.go
@@ -46,7 +46,7 @@ func (h *ProjectsHandler) RegisterRoutes(router chi.Router) {
 // @Tags wakatime
 // @Produce json
 // @Param user path string true "User ID to fetch data for (or 'current')"
-// @Param q query string true "Query to filter projects by"
+// @Param q query string false "Query to filter projects by"
 // @Security ApiKeyAuth
 // @Success 200 {object} v1.ProjectsViewModel
 // @Router /compat/wakatime/v1/users/{user}/projects [get]

diff --git a/static/docs/docs.go b/static/docs/docs.go
@@ -334,8 +334,7 @@ const docTemplate = `{
                         "type": "string",
                         "description": "Query to filter projects by",
                         "name": "q",
-                        "in": "query",
-                        "required": true
+                        "in": "query"
                     }
                 ],
                 "responses": {

diff --git a/static/docs/swagger.json b/static/docs/swagger.json
@@ -326,8 +326,7 @@
                         "type": "string",
                         "description": "Query to filter projects by",
                         "name": "q",
-                        "in": "query",
-                        "required": true
+                        "in": "query"
                     }
                 ],
                 "responses": {

diff --git a/static/docs/swagger.yaml b/static/docs/swagger.yaml
@@ -763,7 +763,6 @@ paths:
       - description: Query to filter projects by
         in: query
         name: q
-        required: true
         type: string
       produces:
       - application/json