synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-13 21:36:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

make -B gen

Browse Source
This commit is contained in:
Sas Swart
2025-02-12 08:25:09 +00:00
parent 341c2b4a2b
commit 4fa66746ad
4 changed files with 37 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
coderd/apidoc/docs.go generated
View File

@ -5643,44 +5643,6 @@ const docTemplate = `{
} }
} }
}, },
"/templateversions/{templateversion}/presets/parameters": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": [
"application/json"
],
"tags": [
"Templates"
],
"summary": "Get template version preset parameters",
"operationId": "get-template-version-preset-parameters",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "Template version ID",
"name": "templateversion",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
}
}
}
}
},
"/templateversions/{templateversion}/resources": { "/templateversions/{templateversion}/resources": {
"get": { "get": {
"security": [ "security": [
@ -13051,6 +13013,12 @@ const docTemplate = `{
}, },
"name": { "name": {
"type": "string" "type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
} }
} }
}, },

40
coderd/apidoc/swagger.json generated
View File

@ -4985,40 +4985,6 @@
} }
} }
}, },
"/templateversions/{templateversion}/presets/parameters": {
"get": {
"security": [
{
"CoderSessionToken": []
}
],
"produces": ["application/json"],
"tags": ["Templates"],
"summary": "Get template version preset parameters",
"operationId": "get-template-version-preset-parameters",
"parameters": [
{
"type": "string",
"format": "uuid",
"description": "Template version ID",
"name": "templateversion",
"in": "path",
"required": true
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
}
}
}
}
},
"/templateversions/{templateversion}/resources": { "/templateversions/{templateversion}/resources": {
"get": { "get": {
"security": [ "security": [
@ -11776,6 +11742,12 @@
}, },
"name": { "name": {
"type": "string" "type": "string"
},
"parameters": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.PresetParameter"
}
} }
} }
}, },

18
docs/reference/api/schemas.md generated
View File

@ -4432,16 +4432,24 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith
```json ```json
{ {
"id": "string", "id": "string",
"name": "string" "name": "string",
"parameters": [
{
"name": "string",
"presetID": "string",
"value": "string"
}
]
} }
``` ```
### Properties ### Properties
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
|--------|--------|----------|--------------|-------------| |--------------|---------------------------------------------------------------|----------|--------------|-------------|
| `id` | string | false | | | | `id` | string | false | | |
| `name` | string | false | | | | `name` | string | false | | |
| `parameters` | array of [codersdk.PresetParameter](#codersdkpresetparameter) | false | | |
## codersdk.PresetParameter ## codersdk.PresetParameter

65
docs/reference/api/templates.md generated
View File

@ -2699,7 +2699,14 @@ curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/p
[ [
{ {
"id": "string", "id": "string",
"name": "string" "name": "string",
"parameters": [
{
"name": "string",
"presetID": "string",
"value": "string"
}
]
} }
] ]
``` ```
@ -2719,58 +2726,10 @@ Status Code **200**
| `[array item]` | array | false | | | | `[array item]` | array | false | | |
| `» id` | string | false | | | | `» id` | string | false | | |
| `» name` | string | false | | | | `» name` | string | false | | |
| `» parameters` | array | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). | `»» name` | string | false | | |
| `»» presetID` | string | false | | |
## Get template version preset parameters | `»» value` | string | false | | |
### Code samples
```shell
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/templateversions/{templateversion}/presets/parameters \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
```
`GET /templateversions/{templateversion}/presets/parameters`
### Parameters
| Name | In | Type | Required | Description |
|-------------------|------|--------------|----------|---------------------|
| `templateversion` | path | string(uuid) | true | Template version ID |
### Example responses
> 200 Response
```json
[
{
"name": "string",
"presetID": "string",
"value": "string"
}
]
```
### Responses
| Status | Meaning | Description | Schema |
|--------|---------------------------------------------------------|-------------|-------------------------------------------------------------------------|
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.PresetParameter](schemas.md#codersdkpresetparameter) |
<h3 id="get-template-version-preset-parameters-responseschema">Response Schema</h3>
Status Code **200**
| Name | Type | Required | Restrictions | Description |
|----------------|--------|----------|--------------|-------------|
| `[array item]` | array | false | | |
| `» name` | string | false | | |
| `» presetID` | string | false | | |
| `» value` | string | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md). To perform this operation, you must be authenticated. [Learn more](authentication.md).