mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: add --experiments flag to replace --experimental (#5767)
- Deprecates the --experimental flag - Adds a new flag --experiments which supports passing multiple comma-separated values or a wildcard value. - Exposes a new endpoint /api/v2/experiments that returns the list of enabled experiments. - Deprecates the field Features.Experimental in favour of this new API. - Updates apidocgen to support type aliases (shoutout to @mtojek). - Modifies apitypings to support generating slice types. - Updates develop.sh to pass additional args after -- to $CODERD_SHIM.
This commit is contained in:
Cian Johnston
@@ -276,6 +276,17 @@ curl -X GET http://coder-server:8080/api/v2/config/deployment \
|
||||
"usage": "string",
|
||||
"value": true
|
||||
},
|
||||
"experiments": {
|
||||
"default": ["string"],
|
||||
"enterprise": true,
|
||||
"flag": "string",
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"secret": true,
|
||||
"shorthand": "string",
|
||||
"usage": "string",
|
||||
"value": ["string"]
|
||||
},
|
||||
"gitauth": {
|
||||
"default": [
|
||||
{
|
||||
@@ -1008,6 +1019,43 @@ curl -X POST http://coder-server:8080/api/v2/csp/reports \
|
||||
|
||||
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
||||
|
||||
## Get experiments
|
||||
|
||||
### Code samples
|
||||
|
||||
```shell
|
||||
# Example request using curl
|
||||
curl -X GET http://coder-server:8080/api/v2/experiments \
|
||||
-H 'Accept: application/json' \
|
||||
-H 'Coder-Session-Token: API_KEY'
|
||||
```
|
||||
|
||||
`GET /experiments`
|
||||
|
||||
### Example responses
|
||||
|
||||
> 200 Response
|
||||
|
||||
```json
|
||||
["vscode_local"]
|
||||
```
|
||||
|
||||
### Responses
|
||||
|
||||
| Status | Meaning | Description | Schema |
|
||||
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- |
|
||||
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
|
||||
|
||||
<h3 id="get-experiments-responseschema">Response Schema</h3>
|
||||
|
||||
Status Code **200**
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| -------------- | ----- | -------- | ------------ | ----------- |
|
||||
| `[array item]` | array | false | | |
|
||||
|
||||
To perform this operation, you must be authenticated. [Learn more](authentication.md).
|
||||
|
||||
## Update check
|
||||
|
||||
### Code samples
|
||||
|
||||
+36
-10
@@ -1356,6 +1356,17 @@ CreateParameterRequest is a structure used to create a new parameter value for a
|
||||
"usage": "string",
|
||||
"value": true
|
||||
},
|
||||
"experiments": {
|
||||
"default": ["string"],
|
||||
"enterprise": true,
|
||||
"flag": "string",
|
||||
"hidden": true,
|
||||
"name": "string",
|
||||
"secret": true,
|
||||
"shorthand": "string",
|
||||
"usage": "string",
|
||||
"value": ["string"]
|
||||
},
|
||||
"gitauth": {
|
||||
"default": [
|
||||
{
|
||||
@@ -2058,7 +2069,8 @@ CreateParameterRequest is a structure used to create a new parameter value for a
|
||||
| `browser_only` | [codersdk.DeploymentConfigField-bool](#codersdkdeploymentconfigfield-bool) | false | | |
|
||||
| `cache_directory` | [codersdk.DeploymentConfigField-string](#codersdkdeploymentconfigfield-string) | false | | |
|
||||
| `derp` | [codersdk.DERP](#codersdkderp) | false | | |
|
||||
| `experimental` | [codersdk.DeploymentConfigField-bool](#codersdkdeploymentconfigfield-bool) | false | | |
|
||||
| `experimental` | [codersdk.DeploymentConfigField-bool](#codersdkdeploymentconfigfield-bool) | false | | Experimental Use Experiments instead. |
|
||||
| `experiments` | [codersdk.DeploymentConfigField-array_string](#codersdkdeploymentconfigfield-array_string) | false | | |
|
||||
| `gitauth` | [codersdk.DeploymentConfigField-array_codersdk_GitAuthConfig](#codersdkdeploymentconfigfield-array_codersdk_gitauthconfig) | false | | |
|
||||
| `http_address` | [codersdk.DeploymentConfigField-string](#codersdkdeploymentconfigfield-string) | false | | |
|
||||
| `in_memory_database` | [codersdk.DeploymentConfigField-bool](#codersdkdeploymentconfigfield-bool) | false | | |
|
||||
@@ -2332,15 +2344,29 @@ CreateParameterRequest is a structure used to create a new parameter value for a
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------------ | ------------------------------------ | -------- | ------------ | ----------- |
|
||||
| `errors` | array of string | false | | |
|
||||
| `experimental` | boolean | false | | |
|
||||
| `features` | object | false | | |
|
||||
| » `[any property]` | [codersdk.Feature](#codersdkfeature) | false | | |
|
||||
| `has_license` | boolean | false | | |
|
||||
| `trial` | boolean | false | | |
|
||||
| `warnings` | array of string | false | | |
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
| ------------------ | ------------------------------------ | -------- | ------------ | ------------------------------------- |
|
||||
| `errors` | array of string | false | | |
|
||||
| `experimental` | boolean | false | | Experimental use Experiments instead. |
|
||||
| `features` | object | false | | |
|
||||
| » `[any property]` | [codersdk.Feature](#codersdkfeature) | false | | |
|
||||
| `has_license` | boolean | false | | |
|
||||
| `trial` | boolean | false | | |
|
||||
| `warnings` | array of string | false | | |
|
||||
|
||||
## codersdk.Experiment
|
||||
|
||||
```json
|
||||
"vscode_local"
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
| Value |
|
||||
| -------------- |
|
||||
| `vscode_local` |
|
||||
|
||||
## codersdk.Feature
|
||||
|
||||
|
||||
Reference in New Issue
Block a user