Fix swagger user_id path parameter view

Matrix278 · Matrix278 · commit 3e425496aadf · 2025-01-26T11:45:15.000+02:00
diff --git a/controller/user.go b/controller/user.go
@@ -27,11 +27,11 @@ func NewUser(
 //	@Tags			User
 //	@Accept			json
 //	@Produce		json
-//	@Param			id	path		string					true	"User ID"
-//	@Success		200	{object}	model.UserByIDResponse	"Get user by ID"
-//	@Failure		400	{object}	swagger.StatusBadRequest
-//	@Failure		403	{object}	swagger.StatusForbidden
-//	@Failure		500	{object}	swagger.StatusInternalError
+//	@Param			user_id	path		string					true	"User ID"
+//	@Success		200		{object}	model.UserByIDResponse	"Get user by ID"
+//	@Failure		400		{object}	swagger.StatusBadRequest
+//	@Failure		403		{object}	swagger.StatusForbidden
+//	@Failure		500		{object}	swagger.StatusInternalError
 //	@Router			/user/{id} [get]
 func (controller *User) UserByID(ctx *gin.Context) {
 	// Validate path params
diff --git a/docs/docs.go b/docs/docs.go
@@ -36,7 +36,7 @@ const docTemplate = `{
                     {
                         "type": "string",
                         "description": "User ID",
-                        "name": "id",
+                        "name": "user_id",
                         "in": "path",
                         "required": true
                     }
@@ -148,7 +148,7 @@ const docTemplate = `{
 
 // SwaggerInfo holds exported Swagger Info so clients can modify it
 var SwaggerInfo = &swag.Spec{
-	Version:          "1.1",
+	Version:          "1.0",
 	Host:             "localhost:8080",
 	BasePath:         "/api/v1",
 	Schemes:          []string{},
diff --git a/docs/index.html b/docs/index.html
@@ -348,11 +348,11 @@
           55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864
           -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688,
           -104.0616 -231.873,-231.248 z
-        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Go API<!-- --> <span>(<!-- -->1.1<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><div class="sc-kBAPdo gmEXff"><div class="sc-ftmehX eeVPfW"><span class="sc-gbwXoZ bcPxPq">API Support<!-- -->:<!-- --> <a href="mailto:support@gmail.com">support@gmail.com</a></span> <span class="sc-gbwXoZ bcPxPq">URL: <a href="https://example.com/">https://example.com/</a></span> <!-- --> </div></div></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;GO API documentation&lt;/p&gt;
+        " fill="currentColor"></path></g></svg></div></div><div class="sc-jdwyG knmTbM api-content"><div class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq api-info"><h1 class="sc-ixGGxD sc-geoRQH kHkxTT dZsYqS">Go API<!-- --> <span>(<!-- -->1.0<!-- -->)</span></h1><p>Download OpenAPI specification<!-- -->:<a download="openapi.json" target="_blank" class="sc-kEsJEW enkzRg">Download</a></p><div class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><div class="sc-kBAPdo gmEXff"><div class="sc-ftmehX eeVPfW"><span class="sc-gbwXoZ bcPxPq">API Support<!-- -->:<!-- --> <a href="mailto:support@gmail.com">support@gmail.com</a></span> <span class="sc-gbwXoZ bcPxPq">URL: <a href="https://example.com/">https://example.com/</a></span> <!-- --> </div></div></div><div data-role="redoc-summary" html="" class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"></div><div data-role="redoc-description" html="&lt;p&gt;GO API documentation&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>GO API documentation</p>
 </div></div></div></div><div id="tag/User" data-section-id="tag/User" class="sc-dntaoT bvhSud"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User" aria-label="tag/User"></a>User</h2></div></div></div><div id="tag/User/paths/~1user~1{id}/get" data-section-id="tag/User/paths/~1user~1{id}/get" class="sc-dntaoT aYCdu"><div class="sc-kLhKbu dECWTf"><div class="sc-fAUdSK dFrZq"><h2 class="sc-khLCKb wHiQv"><a class="sc-jwIPbr hbTOAm" href="#tag/User/paths/~1user~1{id}/get" aria-label="tag/User/paths/~1user~1{id}/get"></a>Get user by ID<!-- --> </h2><div class="sc-fantwC exRUVh"><div html="&lt;p&gt;Get user by ID&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK"><p>Get user by ID</p>
-</div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="id" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><div html="&lt;p&gt;User ID&lt;/p&gt;
+</div></div><div><h5 class="sc-dpBQxM eJAAZj">path<!-- --> Parameters</h5><table class="sc-dprtRQ eNFxPe"><tbody><tr class="last "><td kind="field" title="user_id" class="sc-ovuCP sc-eauhAA iyKqKI iQpMVv"><span class="sc-gQaihK kPDxnK"></span><span class="property-name">user_id</span><div class="sc-CNKsk sc-hGZxvd hPAOR feFoaC">required</div></td><td class="sc-fFoeYl cHXoZJ"><div><div><span class="sc-CNKsk sc-cqgMZH hPAOR dWKYKL"></span><span class="sc-CNKsk sc-gQkENW hPAOR bIEFFi">string</span></div> <div><div html="&lt;p&gt;User ID&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"><p>User ID</p>
 </div></div></div></td></tr></tbody></table></div><div><h3 class="sc-edsqmr dheqgt">Responses</h3><div><button class="sc-gohMHu cnBopK"><svg class="sc-cHqXqK hmCwJW" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-bKXUjo beMorW">200<!-- --> </strong><div html="&lt;p&gt;Get user by ID&lt;/p&gt;
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Get user by ID</p>
@@ -364,7 +364,7 @@
 " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK sc-drVZOg jtjIAv"><p>Internal Server Error</p>
 </div></button></div></div></div><div class="sc-ivxoEo sc-ghWlax gOjFGl oECKJ"><div class="sc-duWCru dWZoid"><button class="sc-iPHsxv ebcgbH"><span type="get" class="sc-txhaY IVbnb http-verb get">get</span><span class="sc-etPtWW iqHzp">/user/{id}</span><svg class="sc-cHqXqK fmmJjS" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-ePpfBx ddApzj"><div class="sc-dwGkES evaCJX"><div html="" class="sc-epnzzT sc-eMwmJz drsioI ewnBNs"></div><div tabindex="0" role="button"><div class="sc-hSyjfr gufODt"><span>https://localhost:8080/api/v1</span>/user/{id}</div></div></div></div></div><div><h3 class="sc-keTIit zvQzH"> <!-- -->Response samples<!-- --> </h3><div class="sc-bMTdWJ fbQvpV" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab:R2eeq:0" aria-selected="true" aria-disabled="false" aria-controls="panel:R2eeq:0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab:R2eeq:1" aria-selected="false" aria-disabled="false" aria-controls="panel:R2eeq:1" data-rttab="true">400</li><li class="tab-error" role="tab" id="tab:R2eeq:2" aria-selected="false" aria-disabled="false" aria-controls="panel:R2eeq:2" data-rttab="true">403</li><li class="tab-error" role="tab" id="tab:R2eeq:3" aria-selected="false" aria-disabled="false" aria-controls="panel:R2eeq:3" data-rttab="true">500</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel:R2eeq:0" aria-labelledby="tab:R2eeq:0"><div><div class="sc-Rjrgp dIDLbO"><span class="sc-fufdwm eqWzJe">Content type</span><div class="sc-UblHX kKXAng">application/json</div></div><div class="sc-FFETS kqHNPM"><div class="sc-eDHQDy mMhCU"><div class="sc-uYFMi hhzNne"><button><div class="sc-eWPXlR ezdXRP">Copy</div></button><button> Expand all </button><button> Collapse all </button></div><div class="sc-epnzzT drsioI sc-giBObj iyEpFV"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"user"</span>: <button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable collapsed"><span class="property token string">"created_at"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"email"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"id"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"updated_at"</span>: <span class="token string">&quot;string&quot;</span><span class="token punctuation">,</span></div></li><li><div class="hoverable collapsed"><span class="property token string">"username"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2eeq:1" aria-labelledby="tab:R2eeq:1"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2eeq:2" aria-labelledby="tab:R2eeq:2"></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel:R2eeq:3" aria-labelledby="tab:R2eeq:3"></div></div></div></div></div></div></div><div class="sc-eEVuZf ifLiBE"></div></div></div>
       <script>
-      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"contact":{"email":"support@gmail.com","name":"API Support","url":"https://example.com/"},"description":"GO API documentation","title":"Go API","version":"1.1"},"paths":{"/user/{id}":{"get":{"description":"Get user by ID","parameters":[{"description":"User ID","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get user by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.UserByIDResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusBadRequest"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusForbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusInternalError"}}}}},"summary":"Get user by ID","tags":["User"]}}},"servers":[{"url":"//localhost:8080/api/v1"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"model.User":{"properties":{"created_at":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"updated_at":{"type":"string"},"username":{"type":"string"}},"type":"object"},"model.UserByIDResponse":{"properties":{"user":{"$ref":"#/components/schemas/model.User"}},"type":"object"},"swagger.StatusBadRequest":{"properties":{"code":{"example":"BAD_REQUEST","type":"string"},"message":{"example":"Bad request","type":"string"}},"type":"object"},"swagger.StatusForbidden":{"properties":{"code":{"example":"FORBIDDEN","type":"string"},"message":{"example":"You don't have permission to access this resource","type":"string"}},"type":"object"},"swagger.StatusInternalError":{"properties":{"code":{"example":"INTERNAL_ERROR","type":"string"},"message":{"example":"Internal server error","type":"string"}},"type":"object"}}}}},"searchIndex":{"store":["tag/User","tag/User/paths/~1user~1{id}/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.155]],["description/0",[]],["title/1",[0,0.118,1,0.16]],["description/1",[0,0.095,1,0.129,2,0.492]]],"invertedIndex":[["id",{"_index":1,"title":{"1":{}},"description":{"1":{}}}],["user",{"_index":0,"title":{"0":{},"1":{}},"description":{"1":{}}}],["user/{id",{"_index":2,"title":{},"description":{"1":{}}}]],"pipeline":[]}},"options":{}};
+      const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.0.0","info":{"contact":{"email":"support@gmail.com","name":"API Support","url":"https://example.com/"},"description":"GO API documentation","title":"Go API","version":"1.0"},"paths":{"/user/{id}":{"get":{"description":"Get user by ID","parameters":[{"description":"User ID","in":"path","name":"user_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get user by ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model.UserByIDResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusBadRequest"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusForbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/swagger.StatusInternalError"}}}}},"summary":"Get user by ID","tags":["User"]}}},"servers":[{"url":"//localhost:8080/api/v1"}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic"}},"schemas":{"model.User":{"properties":{"created_at":{"type":"string"},"email":{"type":"string"},"id":{"type":"string"},"updated_at":{"type":"string"},"username":{"type":"string"}},"type":"object"},"model.UserByIDResponse":{"properties":{"user":{"$ref":"#/components/schemas/model.User"}},"type":"object"},"swagger.StatusBadRequest":{"properties":{"code":{"example":"BAD_REQUEST","type":"string"},"message":{"example":"Bad request","type":"string"}},"type":"object"},"swagger.StatusForbidden":{"properties":{"code":{"example":"FORBIDDEN","type":"string"},"message":{"example":"You don't have permission to access this resource","type":"string"}},"type":"object"},"swagger.StatusInternalError":{"properties":{"code":{"example":"INTERNAL_ERROR","type":"string"},"message":{"example":"Internal server error","type":"string"}},"type":"object"}}}}},"searchIndex":{"store":["tag/User","tag/User/paths/~1user~1{id}/get"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.155]],["description/0",[]],["title/1",[0,0.118,1,0.16]],["description/1",[0,0.095,1,0.129,2,0.492]]],"invertedIndex":[["id",{"_index":1,"title":{"1":{}},"description":{"1":{}}}],["user",{"_index":0,"title":{"0":{},"1":{}},"description":{"1":{}}}],["user/{id",{"_index":2,"title":{},"description":{"1":{}}}]],"pipeline":[]}},"options":{}};
 
       var container = document.getElementById('redoc');
       Redoc.hydrate(__redoc_state, container);
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -8,7 +8,7 @@
             "url": "https://example.com/",
             "email": "support@gmail.com"
         },
-        "version": "1.1"
+        "version": "1.0"
     },
     "host": "localhost:8080",
     "basePath": "/api/v1",
@@ -30,7 +30,7 @@
                     {
                         "type": "string",
                         "description": "User ID",
-                        "name": "id",
+                        "name": "user_id",
                         "in": "path",
                         "required": true
                     }
diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -53,7 +53,7 @@ info:
     url: https://example.com/
   description: GO API documentation
   title: Go API
-  version: "1.1"
+  version: "1.0"
 paths:
   /user/{id}:
     get:
@@ -63,7 +63,7 @@ paths:
       parameters:
       - description: User ID
         in: path
-        name: id
+        name: user_id
         required: true
         type: string
       produces:
