opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: add secret requirement contract to dynamic parameters (#24785)

Browse Source 
Adds structured `secret_requirements` to dynamic parameter responses and
enforces missing required secrets during workspace start.

Stop, delete, and tag rendering paths skip secret requirement
enforcement so unmet secrets do not prevent cleanup. The SDK, generated
API docs/types, and backend render/resolver/wsbuilder tests are updated
for the new contract.
This commit is contained in:
dylanhuff-at-coder
2026-04-29 16:38:26 -07:00
committed by GitHub
parent fe6c8771df
commit fb84e72319
28 changed files with 1382 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/reference/api/schemas.md
Generated
+34 -5
View File
@@ -4557,17 +4557,26 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o
"value": "string"
}
}
],
"secret_requirements": [
{
"env": "string",
"file": "string",
"help_message": "string",
"satisfied": true
}
]
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
|---------------|---------------------------------------------------------------------|----------|--------------|-------------|
| `diagnostics` | array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic) | false | | |
| `id` | integer | false | | |
| `parameters` | array of [codersdk.PreviewParameter](#codersdkpreviewparameter) | false | | |
| Name | Type | Required | Restrictions | Description |
|-----------------------|-------------------------------------------------------------------------------|----------|--------------|-------------|
| `diagnostics` | array of [codersdk.FriendlyDiagnostic](#codersdkfriendlydiagnostic) | false | | |
| `id` | integer | false | | |
| `parameters` | array of [codersdk.PreviewParameter](#codersdkpreviewparameter) | false | | |
| `secret_requirements` | array of [codersdk.SecretRequirementStatus](#codersdksecretrequirementstatus) | false | | |
## codersdk.Entitlement
@@ -8885,6 +8894,26 @@ Only certain features set these fields: - FeatureManagedAgentLimit|
| `ssh_config_options` | object | false | | |
| » `[any property]` | string | false | | |
## codersdk.SecretRequirementStatus
```json
{
"env": "string",
"file": "string",
"help_message": "string",
"satisfied": true
}
```
### Properties
| Name | Type | Required | Restrictions | Description |
|----------------|---------|----------|--------------|-------------|
| `env` | string | false | | |
| `file` | string | false | | |
| `help_message` | string | false | | |
| `satisfied` | boolean | false | | |
## codersdk.ServerSentEvent
```json
docs/reference/api/templates.md
Generated
+8
View File
@@ -2802,6 +2802,14 @@ curl -X POST http://coder-server:8080/api/v2/templateversions/{templateversion}/
"value": "string"
}
}
],
"secret_requirements": [
{
"env": "string",
"file": "string",
"help_message": "string",
"satisfied": true
}
]
}
```