From 57ef0fc54af49052539306c35501a893f24eca18 Mon Sep 17 00:00:00 2001 From: Arda Serdar Pektezol <1669855+pektezol@users.noreply.github.com> Date: Mon, 3 Jul 2023 19:40:43 +0300 Subject: docs: update swagger Former-commit-id: d55150a028f67d5dc8668e2b2384d13511339b46 --- backend/controllers/modController.go | 30 +++++++++++++++--------------- backend/controllers/recordController.go | 6 +++--- docs/docs.go | 15 +++++---------- docs/swagger.json | 9 +++------ docs/swagger.yaml | 3 --- 5 files changed, 26 insertions(+), 37 deletions(-) diff --git a/backend/controllers/modController.go b/backend/controllers/modController.go index b26f1ae..f1874f7 100644 --- a/backend/controllers/modController.go +++ b/backend/controllers/modController.go @@ -14,11 +14,11 @@ import ( // @Summary Create map summary with specified map id. // @Tags maps // @Produce json -// @Param Authorization header string true "JWT Token" -// @Param id path int true "Map ID" -// @Param request body models.CreateMapSummaryRequest true "Body" -// @Success 200 {object} models.Response{data=models.CreateMapSummaryRequest} -// @Failure 400 {object} models.Response +// @Param Authorization header string true "JWT Token" +// @Param id path int true "Map ID" +// @Param request body models.CreateMapSummaryRequest true "Body" +// @Success 200 {object} models.Response{data=models.CreateMapSummaryRequest} +// @Failure 400 {object} models.Response // @Router /maps/{id}/summary [post] func CreateMapSummary(c *gin.Context) { // Check if user exists @@ -100,11 +100,11 @@ func CreateMapSummary(c *gin.Context) { // @Summary Edit map summary with specified map id. // @Tags maps // @Produce json -// @Param Authorization header string true "JWT Token" -// @Param id path int true "Map ID" -// @Param request body models.EditMapSummaryRequest true "Body" -// @Success 200 {object} models.Response{data=models.EditMapSummaryRequest} -// @Failure 400 {object} models.Response +// @Param Authorization header string true "JWT Token" +// @Param id path int true "Map ID" +// @Param request body models.EditMapSummaryRequest true "Body" +// @Success 200 {object} models.Response{data=models.EditMapSummaryRequest} +// @Failure 400 {object} models.Response // @Router /maps/{id}/summary [put] func EditMapSummary(c *gin.Context) { // Check if user exists @@ -183,11 +183,11 @@ func EditMapSummary(c *gin.Context) { // @Summary Delete map summary with specified map id. // @Tags maps // @Produce json -// @Param Authorization header string true "JWT Token" -// @Param id path int true "Map ID" -// @Param request body models.DeleteMapSummaryRequest true "Body" -// @Success 200 {object} models.Response{data=models.DeleteMapSummaryRequest} -// @Failure 400 {object} models.Response +// @Param Authorization header string true "JWT Token" +// @Param id path int true "Map ID" +// @Param request body models.DeleteMapSummaryRequest true "Body" +// @Success 200 {object} models.Response{data=models.DeleteMapSummaryRequest} +// @Failure 400 {object} models.Response // @Router /maps/{id}/summary [delete] func DeleteMapSummary(c *gin.Context) { // Check if user exists diff --git a/backend/controllers/recordController.go b/backend/controllers/recordController.go index 183ab27..9cc6da6 100644 --- a/backend/controllers/recordController.go +++ b/backend/controllers/recordController.go @@ -27,9 +27,9 @@ import ( // @Produce json // @Param Authorization header string true "JWT Token" // @Param host_demo formData file true "Host Demo" -// @Param partner_demo formData file true "Partner Demo" -// @Param is_partner_orange formData boolean true "Is Partner Orange" -// @Param partner_id formData string true "Partner ID" +// @Param partner_demo formData file false "Partner Demo" +// @Param is_partner_orange formData boolean false "Is Partner Orange" +// @Param partner_id formData string false "Partner ID" // @Success 200 {object} models.Response // @Failure 400 {object} models.Response // @Failure 401 {object} models.Response diff --git a/docs/docs.go b/docs/docs.go index 9368c2c..41acab3 100644 --- a/docs/docs.go +++ b/docs/docs.go @@ -1,5 +1,5 @@ -// Code generated by swaggo/swag. DO NOT EDIT. - +// Package docs GENERATED BY SWAG; DO NOT EDIT +// This file was generated by swaggo/swag package docs import "github.com/swaggo/swag" @@ -355,22 +355,19 @@ const docTemplate = `{ "type": "file", "description": "Partner Demo", "name": "partner_demo", - "in": "formData", - "required": true + "in": "formData" }, { "type": "boolean", "description": "Is Partner Orange", "name": "is_partner_orange", - "in": "formData", - "required": true + "in": "formData" }, { "type": "string", "description": "Partner ID", "name": "partner_id", - "in": "formData", - "required": true + "in": "formData" } ], "responses": { @@ -1314,8 +1311,6 @@ var SwaggerInfo = &swag.Spec{ Description: "Backend API endpoints for the Least Portals Database.", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, - LeftDelim: "{{", - RightDelim: "}}", } func init() { diff --git a/docs/swagger.json b/docs/swagger.json index 3acc883..3ec06b6 100644 --- a/docs/swagger.json +++ b/docs/swagger.json @@ -348,22 +348,19 @@ "type": "file", "description": "Partner Demo", "name": "partner_demo", - "in": "formData", - "required": true + "in": "formData" }, { "type": "boolean", "description": "Is Partner Orange", "name": "is_partner_orange", - "in": "formData", - "required": true + "in": "formData" }, { "type": "string", "description": "Partner ID", "name": "partner_id", - "in": "formData", - "required": true + "in": "formData" } ], "responses": { diff --git a/docs/swagger.yaml b/docs/swagger.yaml index 6d06e22..3fe5d66 100644 --- a/docs/swagger.yaml +++ b/docs/swagger.yaml @@ -435,17 +435,14 @@ paths: - description: Partner Demo in: formData name: partner_demo - required: true type: file - description: Is Partner Orange in: formData name: is_partner_orange - required: true type: boolean - description: Partner ID in: formData name: partner_id - required: true type: string produces: - application/json -- cgit v1.2.3