Fix

mtojek · mtojek · commit e5a46184ef80 · 2022-12-20T19:32:33.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -790,6 +790,7 @@ const docTemplate = `{
             }
         },
         "codersdk.CreateParameterRequest": {
+            "description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
             "type": "object",
             "required": [
                 "destination_scheme",
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -694,6 +694,7 @@
       }
     },
     "codersdk.CreateParameterRequest": {
+      "description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
       "type": "object",
       "required": [
         "destination_scheme",
diff --git a/codersdk/parameters.go b/codersdk/parameters.go
@@ -83,7 +83,7 @@ type ParameterSchema struct {
 	ValidationContains []string `json:"validation_contains,omitempty"`
 }
 
-// CreateParameterRequest is 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.
 	// The other param must be related to the same template_id for this to
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -117,6 +117,8 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
 }
 ```
 
+CreateParameterRequest is a structure used to create a new parameter value for a scope.
+
 ### Properties
 
 | Name                  | Type   | Required | Restrictions | Description                                                                                                                                                                                                                                                    |
@@ -168,7 +170,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
 | `display_name`                     | string                                                                      | false    | none         | Display name is the displayed name of the template.                                                                                                                                                                                                                                                            |
 | `icon`                             | string                                                                      | false    | none         | Icon is a relative path or external URL that specifies<br>an icon to be displayed in the dashboard.                                                                                                                                                                                                            |
 | `name`                             | string                                                                      | true     | none         | Name is the name of the template.                                                                                                                                                                                                                                                                              |
-| `parameter_values`                 | array of [codersdk.CreateParameterRequest](#codersdkcreateparameterrequest) | false    | none         | none                                                                                                                                                                                                                                                                                                           |
+| `parameter_values`                 | array of [codersdk.CreateParameterRequest](#codersdkcreateparameterrequest) | false    | none         | Parameter values is a structure used to create a new parameter value for a scope.]                                                                                                                                                                                                                             |
 | `template_version_id`              | string                                                                      | true     | none         | Template version id is an in-progress or completed job to use as an initial version<br>of the template.<br><br>This is required on creation to enable a user-flow of validating a<br>template works. There is no reason the data-model cannot support empty<br>templates, but it doesn't make sense for users. |
 
 ## codersdk.DERPRegion

Original file line number	Diff line number	Diff line change
@@ -790,6 +790,7 @@ const docTemplate = `{
`790`	`790`	`}`
`791`	`791`	`},`
`792`	`792`	`"codersdk.CreateParameterRequest": {`
	`793`	`+ "description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",`
`793`	`794`	`"type": "object",`
`794`	`795`	`"required": [`
`795`	`796`	`"destination_scheme",`
Original file line number	Diff line number	Diff line change
`@@ -694,6 +694,7 @@`
`694`	`694`	`}`
`695`	`695`	`},`
`696`	`696`	`"codersdk.CreateParameterRequest": {`
	`697`	`+ "description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",`
`697`	`698`	`"type": "object",`
`698`	`699`	`"required": [`
`699`	`700`	`"destination_scheme",`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ type ParameterSchema struct {`
`83`	`83`	ValidationContains []string `json:"validation_contains,omitempty"`
`84`	`84`	`}`
`85`	`85`
`86`		`-// CreateParameterRequest is used to create a new parameter value for a scope.`
	`86`	`+// @Description CreateParameterRequest is a structure used to create a new parameter value for a scope.`
`87`	`87`	`type CreateParameterRequest struct {`
`88`	`88`	`// CloneID allows copying the value of another parameter.`
`89`	`89`	`// The other param must be related to the same template_id for this to`