Skip to content

Commit e73fa94

Browse files
committed
update api docs with extravolume
1 parent e318d13 commit e73fa94

File tree

1 file changed

+145
-26
lines changed

1 file changed

+145
-26
lines changed

swagger.json

Lines changed: 145 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -554,6 +554,21 @@
554554
}
555555
}
556556
},
557+
"/config/storageclasses": {
558+
"get": {
559+
"tags": [
560+
"UI"
561+
],
562+
"summary": "Get the available storageclasses",
563+
"description": "",
564+
"parameters": [],
565+
"responses": {
566+
"200": {
567+
"description": "OK"
568+
}
569+
}
570+
}
571+
},
557572
"/logs/{pipeline}/{phase}/{app}": {
558573
"get": {
559574
"tags": [
@@ -858,12 +873,12 @@
858873
}
859874
}
860875
},
861-
"/cli/pipelines/{pipeline}": {
862-
"get": {
876+
"/pipelines/{pipeline}": {
877+
"put": {
863878
"tags": [
864-
"Pipeline"
879+
"UI"
865880
],
866-
"summary": "Get a pipeline",
881+
"summary": "Edit a pipeline",
867882
"description": "",
868883
"parameters": [
869884
{
@@ -873,28 +888,95 @@
873888
"schema": {
874889
"type": "string"
875890
}
891+
},
892+
{
893+
"name": "body",
894+
"in": "body",
895+
"schema": {
896+
"type": "object",
897+
"properties": {
898+
"pipelineName": {
899+
"example": "any"
900+
},
901+
"domain": {
902+
"example": "any"
903+
},
904+
"phases": {
905+
"example": "any"
906+
},
907+
"buildpack": {
908+
"example": "any"
909+
},
910+
"reviewapps": {
911+
"example": "any"
912+
},
913+
"git": {
914+
"example": "any"
915+
},
916+
"dockerimage": {
917+
"example": "any"
918+
},
919+
"deploymentstrategy": {
920+
"example": "any"
921+
},
922+
"resourceVersion": {
923+
"example": "any"
924+
}
925+
}
926+
},
927+
"description": "Pipeline object",
928+
"required": true
876929
}
877930
],
878931
"responses": {
879932
"200": {
880933
"description": "OK"
881934
}
882935
},
883-
"security": [
884-
{
885-
"bearerAuth": {
886-
"type": "http",
887-
"scheme": "bearer",
888-
"bearerFormat": "JWT"
936+
"requestBody": {
937+
"content": {
938+
"application/json": {
939+
"schema": {
940+
"type": "object",
941+
"properties": {
942+
"pipelineName": {
943+
"example": "any"
944+
},
945+
"domain": {
946+
"example": "any"
947+
},
948+
"phases": {
949+
"example": "any"
950+
},
951+
"buildpack": {
952+
"example": "any"
953+
},
954+
"reviewapps": {
955+
"example": "any"
956+
},
957+
"git": {
958+
"example": "any"
959+
},
960+
"dockerimage": {
961+
"example": "any"
962+
},
963+
"deploymentstrategy": {
964+
"example": "any"
965+
},
966+
"resourceVersion": {
967+
"example": "any"
968+
}
969+
}
970+
}
889971
}
890972
}
891-
]
973+
}
892974
},
893-
"delete": {
975+
"get": {
894976
"tags": [
895-
"Pipeline"
977+
"UI"
896978
],
897-
"summary": "Delete a pipeline",
979+
"summary": "Get a pipeline",
898980
"description": "",
899981
"parameters": [
900982
{
@@ -910,22 +992,35 @@
910992
"200": {
911993
"description": "OK"
912994
}
913-
},
914-
"security": [
995+
}
996+
},
997+
"delete": {
998+
"tags": [
999+
"UI"
1000+
],
1001+
"summary": "Delete a pipeline",
1002+
"description": "",
1003+
"parameters": [
9151004
{
916-
"bearerAuth": {
917-
"type": "http",
918-
"scheme": "bearer",
919-
"bearerFormat": "JWT"
1005+
"name": "pipeline",
1006+
"in": "path",
1007+
"required": true,
1008+
"schema": {
1009+
"type": "string"
9201010
}
9211011
}
922-
]
1012+
],
1013+
"responses": {
1014+
"200": {
1015+
"description": "OK"
1016+
}
1017+
}
9231018
}
9241019
},
925-
"/pipelines/{pipeline}": {
1020+
"/cli/pipelines/{pipeline}": {
9261021
"get": {
9271022
"tags": [
928-
"UI"
1023+
"Pipeline"
9291024
],
9301025
"summary": "Get a pipeline",
9311026
"description": "",
@@ -943,11 +1038,20 @@
9431038
"200": {
9441039
"description": "OK"
9451040
}
946-
}
1041+
},
1042+
"security": [
1043+
{
1044+
"bearerAuth": {
1045+
"type": "http",
1046+
"scheme": "bearer",
1047+
"bearerFormat": "JWT"
1048+
}
1049+
}
1050+
]
9471051
},
9481052
"delete": {
9491053
"tags": [
950-
"UI"
1054+
"Pipeline"
9511055
],
9521056
"summary": "Delete a pipeline",
9531057
"description": "",
@@ -965,7 +1069,16 @@
9651069
"200": {
9661070
"description": "OK"
9671071
}
968-
}
1072+
},
1073+
"security": [
1074+
{
1075+
"bearerAuth": {
1076+
"type": "http",
1077+
"scheme": "bearer",
1078+
"bearerFormat": "JWT"
1079+
}
1080+
}
1081+
]
9691082
}
9701083
},
9711084
"/pipelines/{pipeline}/{phase}/{app}": {
@@ -1068,6 +1181,9 @@
10681181
"autoscale": {
10691182
"example": "any"
10701183
},
1184+
"extraVolumes": {
1185+
"example": "any"
1186+
},
10711187
"envvars": {
10721188
"example": "any"
10731189
},
@@ -1130,6 +1246,9 @@
11301246
"autoscale": {
11311247
"example": "any"
11321248
},
1249+
"extraVolumes": {
1250+
"example": "any"
1251+
},
11331252
"envvars": {
11341253
"example": "any"
11351254
},

0 commit comments

Comments
 (0)