Skip to content

Commit 262ecf9

Browse files
committed
Make gen
1 parent 1681c99 commit 262ecf9

File tree

4 files changed

+28
-15
lines changed

4 files changed

+28
-15
lines changed

coderd/apidoc/docs.go

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 4 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/general.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
398398
},
399399
"hidden": true,
400400
"name": "string",
401+
"required": true,
401402
"use_instead": [{}],
402403
"value": null,
403404
"value_source": "",

docs/api/schemas.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -533,6 +533,7 @@
533533
},
534534
"hidden": true,
535535
"name": "string",
536+
"required": true,
536537
"use_instead": [
537538
{
538539
"annotations": {
@@ -557,6 +558,7 @@
557558
},
558559
"hidden": true,
559560
"name": "string",
561+
"required": true,
560562
"use_instead": [],
561563
"value": null,
562564
"value_source": "",
@@ -571,21 +573,22 @@
571573

572574
### Properties
573575

574-
| Name | Type | Required | Restrictions | Description |
575-
| ---------------- | ------------------------------------------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------ |
576-
| `annotations` | [clibase.Annotations](#clibaseannotations) | false | | Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. |
577-
| `default` | string | false | | Default is parsed into Value if set. |
578-
| `description` | string | false | | |
579-
| `env` | string | false | | Env is the environment variable used to configure this option. If unset, environment configuring is disabled. |
580-
| `flag` | string | false | | Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. |
581-
| `flag_shorthand` | string | false | | Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. |
582-
| `group` | [clibase.Group](#clibasegroup) | false | | Group is a group hierarchy that helps organize this option in help, configs and other documentation. |
583-
| `hidden` | boolean | false | | |
584-
| `name` | string | false | | |
585-
| `use_instead` | array of [clibase.Option](#clibaseoption) | false | | Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. |
586-
| `value` | any | false | | Value includes the types listed in values.go. |
587-
| `value_source` | [clibase.ValueSource](#clibasevaluesource) | false | | |
588-
| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. |
576+
| Name | Type | Required | Restrictions | Description |
577+
| ---------------- | ------------------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
578+
| `annotations` | [clibase.Annotations](#clibaseannotations) | false | | Annotations enable extensions to clibase higher up in the stack. It's useful for help formatting and documentation generation. |
579+
| `default` | string | false | | Default is parsed into Value if set. |
580+
| `description` | string | false | | |
581+
| `env` | string | false | | Env is the environment variable used to configure this option. If unset, environment configuring is disabled. |
582+
| `flag` | string | false | | Flag is the long name of the flag used to configure this option. If unset, flag configuring is disabled. |
583+
| `flag_shorthand` | string | false | | Flag shorthand is the one-character shorthand for the flag. If unset, no shorthand is used. |
584+
| `group` | [clibase.Group](#clibasegroup) | false | | Group is a group hierarchy that helps organize this option in help, configs and other documentation. |
585+
| `hidden` | boolean | false | | |
586+
| `name` | string | false | | |
587+
| `required` | boolean | false | | Required means this value must be set by some means. It requires `ValueSource != ValueSourceNone` If `Default` is set, then `Required` is ignored. |
588+
| `use_instead` | array of [clibase.Option](#clibaseoption) | false | | Use instead is a list of options that should be used instead of this one. The field is used to generate a deprecation warning. |
589+
| `value` | any | false | | Value includes the types listed in values.go. |
590+
| `value_source` | [clibase.ValueSource](#clibasevaluesource) | false | | |
591+
| `yaml` | string | false | | Yaml is the YAML key used to configure this option. If unset, YAML configuring is disabled. |
589592

590593
## clibase.Struct-array_codersdk_GitAuthConfig
591594

@@ -2097,6 +2100,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
20972100
},
20982101
"hidden": true,
20992102
"name": "string",
2103+
"required": true,
21002104
"use_instead": [{}],
21012105
"value": null,
21022106
"value_source": "",

0 commit comments

Comments
 (0)