|
533 | 533 | },
|
534 | 534 | "hidden": true,
|
535 | 535 | "name": "string",
|
| 536 | + "required": true, |
536 | 537 | "use_instead": [
|
537 | 538 | {
|
538 | 539 | "annotations": {
|
|
557 | 558 | },
|
558 | 559 | "hidden": true,
|
559 | 560 | "name": "string",
|
| 561 | + "required": true, |
560 | 562 | "use_instead": [],
|
561 | 563 | "value": null,
|
562 | 564 | "value_source": "",
|
|
571 | 573 |
|
572 | 574 | ### Properties
|
573 | 575 |
|
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. | |
589 | 592 |
|
590 | 593 | ## clibase.Struct-array_codersdk_GitAuthConfig
|
591 | 594 |
|
@@ -2097,6 +2100,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
2097 | 2100 | },
|
2098 | 2101 | "hidden": true,
|
2099 | 2102 | "name": "string",
|
| 2103 | + "required": true, |
2100 | 2104 | "use_instead": [{}],
|
2101 | 2105 | "value": null,
|
2102 | 2106 | "value_source": "",
|
|
0 commit comments