Skip to content

Commit f96351a

Browse files
mtojekmtojek
committed
templateversions
1 parent 9dd385c commit f96351a

File tree

5 files changed

+1171
-0
lines changed

5 files changed

+1171
-0
lines changed

‎coderd/apidoc/docs.go

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,6 +1041,109 @@ const docTemplate = `{
10411041
}
10421042
}
10431043
},
1044+
"/templateversions/{id}/dry-run": {
1045+
"post": {
1046+
"security": [
1047+
{
1048+
"CoderSessionToken": []
1049+
}
1050+
],
1051+
"consumes": [
1052+
"application/json"
1053+
],
1054+
"produces": [
1055+
"application/json"
1056+
],
1057+
"tags": [
1058+
"Templates"
1059+
],
1060+
"summary": "Create template version dry-run",
1061+
"operationId": "create-template-version-dry-run",
1062+
"parameters": [
1063+
{
1064+
"type": "string",
1065+
"format": "uuid",
1066+
"description": "Template version ID",
1067+
"name": "id",
1068+
"in": "path",
1069+
"required": true
1070+
},
1071+
{
1072+
"description": "Dry-run request",
1073+
"name": "request",
1074+
"in": "body",
1075+
"required": true,
1076+
"schema": {
1077+
"$ref": "#/definitions/codersdk.CreateTemplateVersionDryRunRequest"
1078+
}
1079+
}
1080+
],
1081+
"responses": {
1082+
"201": {
1083+
"description": "Created",
1084+
"schema": {
1085+
"$ref": "#/definitions/codersdk.ProvisionerJob"
1086+
}
1087+
}
1088+
}
1089+
}
1090+
},
1091+
"/templateversions/{id}/resources": {
1092+
"get": {
1093+
"security": [
1094+
{
1095+
"CoderSessionToken": []
1096+
}
1097+
],
1098+
"produces": [
1099+
"application/json"
1100+
],
1101+
"tags": [
1102+
"Templates"
1103+
],
1104+
"summary": "Get template version logs by template version ID",
1105+
"operationId": "get-template-version-resources-by-template-version-id",
1106+
"parameters": [
1107+
{
1108+
"type": "string",
1109+
"format": "uuid",
1110+
"description": "Template version ID",
1111+
"name": "id",
1112+
"in": "path",
1113+
"required": true
1114+
},
1115+
{
1116+
"type": "integer",
1117+
"description": "Before Unix timestamp",
1118+
"name": "before",
1119+
"in": "query"
1120+
},
1121+
{
1122+
"type": "integer",
1123+
"description": "After Unix timestamp",
1124+
"name": "after",
1125+
"in": "query"
1126+
},
1127+
{
1128+
"type": "boolean",
1129+
"description": "Follow log stream",
1130+
"name": "follow",
1131+
"in": "query"
1132+
}
1133+
],
1134+
"responses": {
1135+
"200": {
1136+
"description": "OK",
1137+
"schema": {
1138+
"type": "array",
1139+
"items": {
1140+
"$ref": "#/definitions/codersdk.ProvisionerJobLog"
1141+
}
1142+
}
1143+
}
1144+
}
1145+
}
1146+
},
10441147
"/templateversions/{id}/schema": {
10451148
"get": {
10461149
"security": [
@@ -1079,6 +1182,197 @@ const docTemplate = `{
10791182
}
10801183
}
10811184
},
1185+
"/templateversions/{templateversionid}/dry-run/{jobid}": {
1186+
"get": {
1187+
"security": [
1188+
{
1189+
"CoderSessionToken": []
1190+
}
1191+
],
1192+
"consumes": [
1193+
"application/json"
1194+
],
1195+
"produces": [
1196+
"application/json"
1197+
],
1198+
"tags": [
1199+
"Templates"
1200+
],
1201+
"summary": "Get template version dry-run by job ID",
1202+
"operationId": "get-template-version-dry-run-by-job-id",
1203+
"parameters": [
1204+
{
1205+
"type": "string",
1206+
"format": "uuid",
1207+
"description": "Template version ID",
1208+
"name": "templateversionid",
1209+
"in": "path",
1210+
"required": true
1211+
},
1212+
{
1213+
"type": "string",
1214+
"format": "uuid",
1215+
"description": "Job ID",
1216+
"name": "jobid",
1217+
"in": "path",
1218+
"required": true
1219+
}
1220+
],
1221+
"responses": {
1222+
"200": {
1223+
"description": "OK",
1224+
"schema": {
1225+
"$ref": "#/definitions/codersdk.ProvisionerJob"
1226+
}
1227+
}
1228+
}
1229+
}
1230+
},
1231+
"/templateversions/{templateversionid}/dry-run/{jobid}/cancel": {
1232+
"patch": {
1233+
"security": [
1234+
{
1235+
"CoderSessionToken": []
1236+
}
1237+
],
1238+
"produces": [
1239+
"application/json"
1240+
],
1241+
"tags": [
1242+
"Templates"
1243+
],
1244+
"summary": "Cancel template version dry-run by job ID",
1245+
"operationId": "cancel-template-version-dry-run-by-job-id",
1246+
"parameters": [
1247+
{
1248+
"type": "string",
1249+
"format": "uuid",
1250+
"description": "Template version ID",
1251+
"name": "id",
1252+
"in": "path",
1253+
"required": true
1254+
}
1255+
],
1256+
"responses": {
1257+
"200": {
1258+
"description": "OK",
1259+
"schema": {
1260+
"$ref": "#/definitions/codersdk.Response"
1261+
}
1262+
}
1263+
}
1264+
}
1265+
},
1266+
"/templateversions/{templateversionid}/dry-run/{jobid}/logs": {
1267+
"get": {
1268+
"security": [
1269+
{
1270+
"CoderSessionToken": []
1271+
}
1272+
],
1273+
"produces": [
1274+
"application/json"
1275+
],
1276+
"tags": [
1277+
"Templates"
1278+
],
1279+
"summary": "Get template version dry-run logs by job ID",
1280+
"operationId": "get-template-version-dry-run-logs-by-job-id",
1281+
"parameters": [
1282+
{
1283+
"type": "string",
1284+
"format": "uuid",
1285+
"description": "Template version ID",
1286+
"name": "templateversionid",
1287+
"in": "path",
1288+
"required": true
1289+
},
1290+
{
1291+
"type": "string",
1292+
"format": "uuid",
1293+
"description": "Job ID",
1294+
"name": "jobid",
1295+
"in": "path",
1296+
"required": true
1297+
},
1298+
{
1299+
"type": "integer",
1300+
"description": "Before Unix timestamp",
1301+
"name": "before",
1302+
"in": "query"
1303+
},
1304+
{
1305+
"type": "integer",
1306+
"description": "After Unix timestamp",
1307+
"name": "after",
1308+
"in": "query"
1309+
},
1310+
{
1311+
"type": "boolean",
1312+
"description": "Follow log stream",
1313+
"name": "follow",
1314+
"in": "query"
1315+
}
1316+
],
1317+
"responses": {
1318+
"200": {
1319+
"description": "OK",
1320+
"schema": {
1321+
"type": "array",
1322+
"items": {
1323+
"$ref": "#/definitions/codersdk.ProvisionerJobLog"
1324+
}
1325+
}
1326+
}
1327+
}
1328+
}
1329+
},
1330+
"/templateversions/{templateversionid}/dry-run/{jobid}/resources": {
1331+
"get": {
1332+
"security": [
1333+
{
1334+
"CoderSessionToken": []
1335+
}
1336+
],
1337+
"produces": [
1338+
"application/json"
1339+
],
1340+
"tags": [
1341+
"Templates"
1342+
],
1343+
"summary": "Get template version dry-run resources by job ID",
1344+
"operationId": "get-template-version-dry-run-resources-by-job-id",
1345+
"parameters": [
1346+
{
1347+
"type": "string",
1348+
"format": "uuid",
1349+
"description": "Template version ID",
1350+
"name": "templateversionid",
1351+
"in": "path",
1352+
"required": true
1353+
},
1354+
{
1355+
"type": "string",
1356+
"format": "uuid",
1357+
"description": "Job ID",
1358+
"name": "jobid",
1359+
"in": "path",
1360+
"required": true
1361+
}
1362+
],
1363+
"responses": {
1364+
"200": {
1365+
"description": "OK",
1366+
"schema": {
1367+
"type": "array",
1368+
"items": {
1369+
"$ref": "#/definitions/codersdk.WorkspaceResource"
1370+
}
1371+
}
1372+
}
1373+
}
1374+
}
1375+
},
10821376
"/updatecheck": {
10831377
"get": {
10841378
"produces": [
@@ -2447,6 +2741,20 @@ const docTemplate = `{
24472741
}
24482742
}
24492743
},
2744+
"codersdk.CreateTemplateVersionDryRunRequest": {
2745+
"type": "object",
2746+
"properties": {
2747+
"parameter_values": {
2748+
"type": "array",
2749+
"items": {
2750+
"$ref": "#/definitions/codersdk.CreateParameterRequest"
2751+
}
2752+
},
2753+
"workspace_name": {
2754+
"type": "string"
2755+
}
2756+
}
2757+
},
24502758
"codersdk.CreateTestAuditLogRequest": {
24512759
"type": "object",
24522760
"properties": {

0 commit comments

Comments
 (0)