Fix: godoc nice

mtojek · mtojek · commit 60e0f279e8f0 · 2022-12-21T14:07:25.000+01:00
diff --git a/coderd/authorize.go b/coderd/authorize.go
@@ -104,6 +104,9 @@ func (h *HTTPAuthorizer) AuthorizeSQLFilter(r *http.Request, action rbac.Action,
 	return prepared, nil
 }
 
+// checkAuthorization returns if the current API key can use the given
+// permissions, factoring in the current user's roles and the API key scopes.
+//
 // @Summary Check authorization
 // @ID check-authorization
 // @Security CoderSessionToken
@@ -113,9 +116,6 @@ func (h *HTTPAuthorizer) AuthorizeSQLFilter(r *http.Request, action rbac.Action,
 // @Param request body codersdk.AuthorizationRequest true "Authorization request"
 // @Success 200 {object} codersdk.AuthorizationResponse
 // @Router /authcheck [post]
-//
-// checkAuthorization returns if the current API key can use the given
-// permissions, factoring in the current user's roles and the API key scopes.
 func (api *API) checkAuthorization(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	auth := httpmw.UserAuthorization(r)
diff --git a/codersdk/parameters.go b/codersdk/parameters.go
@@ -83,6 +83,8 @@ type ParameterSchema struct {
 	ValidationContains []string `json:"validation_contains,omitempty"`
 }
 
+// CreateParameterRequest is a structure used to create a new parameter value for a scope.
+//
 // @Description CreateParameterRequest is a structure used to create a new parameter value for a scope.
 type CreateParameterRequest struct {
 	// CloneID allows copying the value of another parameter.

Original file line number	Diff line number	Diff line change
`@@ -83,6 +83,8 @@ type ParameterSchema struct {`
`83`	`83`	ValidationContains []string `json:"validation_contains,omitempty"`
`84`	`84`	`}`
`85`	`85`
	`86`	`+// CreateParameterRequest is a structure used to create a new parameter value for a scope.`
	`87`	`+//`
`86`	`88`	`// @Description CreateParameterRequest is a structure used to create a new parameter value for a scope.`
`87`	`89`	`type CreateParameterRequest struct {`
`88`	`90`	`// CloneID allows copying the value of another parameter.`