Skip to content

Commit ad634b6

Browse files
committed
Update API documentation
1 parent 565e625 commit ad634b6

2 files changed

Lines changed: 6 additions & 5 deletions

File tree

src/main/java/eu/openanalytics/containerproxy/api/ProxyStatusController.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,10 @@ public class ProxyStatusController {
8080
mediaType = "application/json",
8181
schema = @Schema(implementation = ChangeProxyStatusDto.class),
8282
examples = {
83-
@ExampleObject(name = "Stopping", description = "Stop a proxy.", value = "{\"desiredStatus\": \"Stopping\"}"),
84-
@ExampleObject(name = "Pausing", description = "Pause a proxy.", value = "{\"desiredStatus\": \"Pausing\"}"),
85-
@ExampleObject(name = "Resuming", description = "Resume a proxy.", value = "{\"desiredStatus\": \"Resuming\"}"),
86-
@ExampleObject(name = "Resuming with parameters", description = "Resume a proxy.", value = "{\"desiredStatus\": \"Resuming\", \"parameters\":{\"resources\":\"2 CPU cores - 8G RAM\",\"other_parameter\":\"example\"}}")
83+
@ExampleObject(name = "Stopping", description = "Stop a proxy.", value = "{\"desiredState\": \"Stopping\"}"),
84+
@ExampleObject(name = "Pausing", description = "Pause a proxy.", value = "{\"desiredState\": \"Pausing\"}"),
85+
@ExampleObject(name = "Resuming", description = "Resume a proxy.", value = "{\"desiredState\": \"Resuming\"}"),
86+
@ExampleObject(name = "Resuming with parameters", description = "Resume a proxy.", value = "{\"desiredState\": \"Resuming\", \"parameters\":{\"resources\":\"2 CPU cores - 8G RAM\",\"other_parameter\":\"example\"}}")
8787
}
8888
)
8989
)
@@ -148,7 +148,7 @@ public ResponseEntity<ApiResponse<Void>> changeProxyStatus(@PathVariable String
148148
}
149149
asyncProxyService.stopProxy(proxy, false);
150150
} else {
151-
return ApiResponse.fail("Invalid desiredStatus");
151+
return ApiResponse.fail("Invalid desiredState");
152152
}
153153

154154
return ApiResponse.success();

src/main/java/eu/openanalytics/containerproxy/util/ProxyMappingManager.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,7 @@ public void onApplicationEvent(ContextClosedEvent event) {
190190
}
191191

192192
private final DefaultResponseListener defaultResponseListener = responseExchange -> {
193+
// note: if ShinyProxy was restarted it can take up to one minute for the request to timeout/fail
193194
if (!responseExchange.isResponseChannelAvailable()) {
194195
return false;
195196
}

0 commit comments

Comments
 (0)