Fix: description

mtojek · mtojek · commit 74de5d459f8b · 2022-12-21T14:11:33.000+01:00
diff --git a/codersdk/authorization.go b/codersdk/authorization.go
@@ -20,8 +20,9 @@ type AuthorizationRequest struct {
 	Checks map[string]AuthorizationCheck `json:"checks"`
 }
 
-// @Description AuthorizationCheck is used to check if the currently authenticated user (or
-// @Description the specified user) can do a given action to a given set of objects.
+// AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.
+//
+// @Description AuthorizationCheck is used to check if the currently authenticated user (or the specified user) can do a given action to a given set of objects.
 type AuthorizationCheck struct {
 	// Object can represent a "set" of objects, such as:
 	// - All workspaces in an organization
@@ -37,6 +38,9 @@ type AuthorizationCheck struct {
 	Action string              `json:"action" enums:"create,read,update,delete"`
 }
 
+// AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me,
+// all workspaces across the entire product.
+//
 // @Description AuthorizationObject can represent a "set" of objects, such as: all workspaces in an organization, all workspaces owned by me,
 // @Description all workspaces across the entire product.
 type AuthorizationObject struct {
diff --git a/scripts/apidocgen/markdown-template/parameters.def b/scripts/apidocgen/markdown-template/parameters.def
@@ -13,7 +13,7 @@
 
 |Name|In|Type|Required|Description|
 |---|---|---|---|---|
-{{~ data.parameters :p}}|{{=p.name}}|{{=p.in}}|{{= renderParameterType(p)}}|{{=p.required}}|{{=p.shortDesc || 'none'}}|
+{{~ data.parameters :p}}|{{=p.name}}|{{=p.in}}|{{= renderParameterType(p)}}|{{=p.required}}|{{=p.shortDesc||''}}|
 {{~}}
 
 {{? data.longDescs }}
