|
4 | 4 | "version": "version not set", |
5 | 5 | "description": "v2/skaffold.proto" |
6 | 6 | }, |
7 | | - "schemes": [ |
8 | | - "http", |
9 | | - "https" |
10 | | - ], |
11 | 7 | "consumes": [ |
12 | 8 | "application/json" |
13 | 9 | ], |
|
18 | 14 | "/v2/applicationLogs": { |
19 | 15 | "get": { |
20 | 16 | "summary": "Returns all the user application logs of the current Skaffold execution", |
21 | | - "operationId": "ApplicationLogs", |
| 17 | + "operationId": "SkaffoldV2Service_ApplicationLogs", |
22 | 18 | "responses": { |
23 | 19 | "200": { |
24 | 20 | "description": "A successful response.(streaming responses)", |
25 | 21 | "schema": { |
26 | | - "$ref": "#/x-stream-definitions/v2Event" |
| 22 | + "type": "object", |
| 23 | + "properties": { |
| 24 | + "result": { |
| 25 | + "$ref": "#/definitions/v2Event" |
| 26 | + }, |
| 27 | + "error": { |
| 28 | + "$ref": "#/definitions/runtimeStreamError" |
| 29 | + } |
| 30 | + }, |
| 31 | + "description": "Stream result of v2Event" |
| 32 | + } |
| 33 | + }, |
| 34 | + "default": { |
| 35 | + "description": "An unexpected error response.", |
| 36 | + "schema": { |
| 37 | + "$ref": "#/definitions/runtimeError" |
27 | 38 | } |
28 | 39 | } |
29 | 40 | }, |
|
35 | 46 | "/v2/build/auto_execute": { |
36 | 47 | "put": { |
37 | 48 | "summary": "Allows for enabling or disabling automatic build trigger", |
38 | | - "operationId": "AutoBuild", |
| 49 | + "operationId": "SkaffoldV2Service_AutoBuild", |
39 | 50 | "responses": { |
40 | 51 | "200": { |
41 | 52 | "description": "A successful response.", |
42 | 53 | "schema": { |
43 | 54 | "properties": {} |
44 | 55 | } |
| 56 | + }, |
| 57 | + "default": { |
| 58 | + "description": "An unexpected error response.", |
| 59 | + "schema": { |
| 60 | + "$ref": "#/definitions/runtimeError" |
| 61 | + } |
45 | 62 | } |
46 | 63 | }, |
47 | 64 | "parameters": [ |
|
62 | 79 | "/v2/deploy/auto_execute": { |
63 | 80 | "put": { |
64 | 81 | "summary": "Allows for enabling or disabling automatic deploy trigger", |
65 | | - "operationId": "AutoDeploy", |
| 82 | + "operationId": "SkaffoldV2Service_AutoDeploy", |
66 | 83 | "responses": { |
67 | 84 | "200": { |
68 | 85 | "description": "A successful response.", |
69 | 86 | "schema": { |
70 | 87 | "properties": {} |
71 | 88 | } |
| 89 | + }, |
| 90 | + "default": { |
| 91 | + "description": "An unexpected error response.", |
| 92 | + "schema": { |
| 93 | + "$ref": "#/definitions/runtimeError" |
| 94 | + } |
72 | 95 | } |
73 | 96 | }, |
74 | 97 | "parameters": [ |
|
89 | 112 | "/v2/events": { |
90 | 113 | "get": { |
91 | 114 | "summary": "Returns all the events of the current Skaffold execution from the start", |
92 | | - "operationId": "Events", |
| 115 | + "operationId": "SkaffoldV2Service_Events", |
93 | 116 | "responses": { |
94 | 117 | "200": { |
95 | 118 | "description": "A successful response.(streaming responses)", |
96 | 119 | "schema": { |
97 | | - "$ref": "#/x-stream-definitions/v2Event" |
| 120 | + "type": "object", |
| 121 | + "properties": { |
| 122 | + "result": { |
| 123 | + "$ref": "#/definitions/v2Event" |
| 124 | + }, |
| 125 | + "error": { |
| 126 | + "$ref": "#/definitions/runtimeStreamError" |
| 127 | + } |
| 128 | + }, |
| 129 | + "description": "Stream result of v2Event" |
| 130 | + } |
| 131 | + }, |
| 132 | + "default": { |
| 133 | + "description": "An unexpected error response.", |
| 134 | + "schema": { |
| 135 | + "$ref": "#/definitions/runtimeError" |
98 | 136 | } |
99 | 137 | } |
100 | 138 | }, |
|
106 | 144 | "/v2/events/handle": { |
107 | 145 | "post": { |
108 | 146 | "summary": "EXPERIMENTAL. It allows for custom events to be implemented in custom builders for example.", |
109 | | - "operationId": "Handle", |
| 147 | + "operationId": "SkaffoldV2Service_Handle", |
110 | 148 | "responses": { |
111 | 149 | "200": { |
112 | 150 | "description": "A successful response.", |
113 | 151 | "schema": { |
114 | 152 | "properties": {} |
115 | 153 | } |
| 154 | + }, |
| 155 | + "default": { |
| 156 | + "description": "An unexpected error response.", |
| 157 | + "schema": { |
| 158 | + "$ref": "#/definitions/runtimeError" |
| 159 | + } |
116 | 160 | } |
117 | 161 | }, |
118 | 162 | "parameters": [ |
|
133 | 177 | "/v2/execute": { |
134 | 178 | "post": { |
135 | 179 | "summary": "Allows for a single execution of some or all of the phases (build, sync, deploy) in case autoBuild, autoDeploy or autoSync are disabled.", |
136 | | - "operationId": "Execute", |
| 180 | + "operationId": "SkaffoldV2Service_Execute", |
137 | 181 | "responses": { |
138 | 182 | "200": { |
139 | 183 | "description": "A successful response.", |
140 | 184 | "schema": { |
141 | 185 | "properties": {} |
142 | 186 | } |
| 187 | + }, |
| 188 | + "default": { |
| 189 | + "description": "An unexpected error response.", |
| 190 | + "schema": { |
| 191 | + "$ref": "#/definitions/runtimeError" |
| 192 | + } |
143 | 193 | } |
144 | 194 | }, |
145 | 195 | "parameters": [ |
|
160 | 210 | "/v2/state": { |
161 | 211 | "get": { |
162 | 212 | "summary": "Returns the state of the current Skaffold execution", |
163 | | - "operationId": "GetState", |
| 213 | + "operationId": "SkaffoldV2Service_GetState", |
164 | 214 | "responses": { |
165 | 215 | "200": { |
166 | 216 | "description": "A successful response.", |
167 | 217 | "schema": { |
168 | 218 | "$ref": "#/definitions/v2State" |
169 | 219 | } |
| 220 | + }, |
| 221 | + "default": { |
| 222 | + "description": "An unexpected error response.", |
| 223 | + "schema": { |
| 224 | + "$ref": "#/definitions/runtimeError" |
| 225 | + } |
170 | 226 | } |
171 | 227 | }, |
172 | 228 | "tags": [ |
|
177 | 233 | "/v2/sync/auto_execute": { |
178 | 234 | "put": { |
179 | 235 | "summary": "Allows for enabling or disabling automatic sync trigger", |
180 | | - "operationId": "AutoSync", |
| 236 | + "operationId": "SkaffoldV2Service_AutoSync", |
181 | 237 | "responses": { |
182 | 238 | "200": { |
183 | 239 | "description": "A successful response.", |
184 | 240 | "schema": { |
185 | 241 | "properties": {} |
186 | 242 | } |
| 243 | + }, |
| 244 | + "default": { |
| 245 | + "description": "An unexpected error response.", |
| 246 | + "schema": { |
| 247 | + "$ref": "#/definitions/runtimeError" |
| 248 | + } |
187 | 249 | } |
188 | 250 | }, |
189 | 251 | "parameters": [ |
|
647 | 709 | } |
648 | 710 | } |
649 | 711 | }, |
| 712 | + "runtimeError": { |
| 713 | + "type": "object", |
| 714 | + "properties": { |
| 715 | + "error": { |
| 716 | + "type": "string" |
| 717 | + }, |
| 718 | + "code": { |
| 719 | + "type": "integer", |
| 720 | + "format": "int32" |
| 721 | + }, |
| 722 | + "message": { |
| 723 | + "type": "string" |
| 724 | + }, |
| 725 | + "details": { |
| 726 | + "type": "array", |
| 727 | + "items": { |
| 728 | + "$ref": "#/definitions/protobufAny" |
| 729 | + } |
| 730 | + } |
| 731 | + } |
| 732 | + }, |
650 | 733 | "runtimeStreamError": { |
651 | 734 | "type": "object", |
652 | 735 | "properties": { |
|
743 | 826 | "description": "A map of `artifact name -> build-state`.\nArtifact name is defined in the `skaffold.yaml`.\nThe `build-state` can be: <br>\n- `\"NotStarted\"`: not yet started <br>\n- `\"InProgress\"`: build started <br>\n- `\"Complete\"`: build succeeded <br>\n- `\"Failed\"`: build failed" |
744 | 827 | }, |
745 | 828 | "autoTrigger": { |
746 | | - "type": "boolean", |
747 | | - "format": "boolean" |
| 829 | + "type": "boolean" |
748 | 830 | }, |
749 | 831 | "statusCode": { |
750 | 832 | "$ref": "#/definitions/enumsStatusCode" |
|
864 | 946 | "type": "string" |
865 | 947 | }, |
866 | 948 | "autoTrigger": { |
867 | | - "type": "boolean", |
868 | | - "format": "boolean" |
| 949 | + "type": "boolean" |
869 | 950 | }, |
870 | 951 | "statusCode": { |
871 | 952 | "$ref": "#/definitions/enumsStatusCode" |
|
1013 | 1094 | "type": "string" |
1014 | 1095 | }, |
1015 | 1096 | "autoTrigger": { |
1016 | | - "type": "boolean", |
1017 | | - "format": "boolean" |
| 1097 | + "type": "boolean" |
1018 | 1098 | } |
1019 | 1099 | }, |
1020 | 1100 | "description": "`FileSyncState` contains the status of the current file sync" |
|
1040 | 1120 | "type": "object", |
1041 | 1121 | "properties": { |
1042 | 1122 | "build": { |
1043 | | - "type": "boolean", |
1044 | | - "format": "boolean" |
| 1123 | + "type": "boolean" |
1045 | 1124 | }, |
1046 | 1125 | "sync": { |
1047 | | - "type": "boolean", |
1048 | | - "format": "boolean" |
| 1126 | + "type": "boolean" |
1049 | 1127 | }, |
1050 | 1128 | "deploy": { |
1051 | | - "type": "boolean", |
1052 | | - "format": "boolean" |
| 1129 | + "type": "boolean" |
1053 | 1130 | }, |
1054 | 1131 | "devloop": { |
1055 | | - "type": "boolean", |
1056 | | - "format": "boolean" |
| 1132 | + "type": "boolean" |
1057 | 1133 | } |
1058 | 1134 | }, |
1059 | 1135 | "description": "Intent represents user intents for a given phase." |
|
1389 | 1465 | "type": "object", |
1390 | 1466 | "properties": { |
1391 | 1467 | "enabled": { |
1392 | | - "type": "boolean", |
1393 | | - "format": "boolean" |
| 1468 | + "type": "boolean" |
1394 | 1469 | } |
1395 | 1470 | }, |
1396 | 1471 | "description": "TriggerState represents trigger state for a given phase." |
|
1427 | 1502 | }, |
1428 | 1503 | "description": "`VerifyEvent` represents the status of a render, and is emitted by Skaffold\nanytime a render starts or completes, successfully or not." |
1429 | 1504 | } |
1430 | | - }, |
1431 | | - "x-stream-definitions": { |
1432 | | - "v2Event": { |
1433 | | - "type": "object", |
1434 | | - "properties": { |
1435 | | - "result": { |
1436 | | - "$ref": "#/definitions/v2Event" |
1437 | | - }, |
1438 | | - "error": { |
1439 | | - "$ref": "#/definitions/runtimeStreamError" |
1440 | | - } |
1441 | | - }, |
1442 | | - "description": "Stream result of v2Event" |
1443 | | - } |
1444 | 1505 | } |
1445 | 1506 | } |
0 commit comments