synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add missing body parameter (#6132)

Browse Source
This commit is contained in:
Marcin Tojek
2023-02-09 15:02:03 +01:00
committed by GitHub
parent 4493649d7e
commit 049984ce7f
5 changed files with 160 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
coderd/apidoc/docs.go generated
View File

@ -1066,6 +1066,9 @@ const docTemplate = `{
"CoderSessionToken": []
}
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
@ -1089,6 +1092,15 @@ const docTemplate = `{
"name": "user",
"in": "path",
"required": true
},
{
"description": "Create workspace request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/codersdk.CreateWorkspaceRequest"
}
}
],
"responses": {
@ -5902,6 +5914,41 @@ const docTemplate = `{
}
}
},
"codersdk.CreateWorkspaceRequest": {
"type": "object",
"required": [
"name",
"template_id"
],
"properties": {
"autostart_schedule": {
"type": "string"
},
"name": {
"type": "string"
},
"parameter_values": {
"description": "ParameterValues allows for additional parameters to be provided\nduring the initial provision.",
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.CreateParameterRequest"
}
},
"rich_parameter_values": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.WorkspaceBuildParameter"
}
},
"template_id": {
"type": "string",
"format": "uuid"
},
"ttl_ms": {
"type": "integer"
}
}
},
"codersdk.DAUEntry": {
"type": "object",
"properties": {

42
coderd/apidoc/swagger.json generated
View File

@ -924,6 +924,7 @@
"CoderSessionToken": []
}
],
"consumes": ["application/json"],
"produces": ["application/json"],
"tags": ["Workspaces"],
"summary": "Create user workspace by organization",
@ -943,6 +944,15 @@
"name": "user",
"in": "path",
"required": true
},
{
"description": "Create workspace request",
"name": "request",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/codersdk.CreateWorkspaceRequest"
}
}
],
"responses": {
@ -5231,6 +5241,38 @@
}
}
},
"codersdk.CreateWorkspaceRequest": {
"type": "object",
"required": ["name", "template_id"],
"properties": {
"autostart_schedule": {
"type": "string"
},
"name": {
"type": "string"
},
"parameter_values": {
"description": "ParameterValues allows for additional parameters to be provided\nduring the initial provision.",
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.CreateParameterRequest"
}
},
"rich_parameter_values": {
"type": "array",
"items": {
"$ref": "#/definitions/codersdk.WorkspaceBuildParameter"
}
},
"template_id": {
"type": "string",
"format": "uuid"
},
"ttl_ms": {
"type": "integer"
}
}
},
"codersdk.DAUEntry": {
"type": "object",
"properties": {