markResolved(
@@ -1642,12 +1642,12 @@ public GsonUTCDateAdapter() {
*
*
*/
- @ApiOperation(value = "Updates the enabled/disabled status of a process definition on a worker", tags = {"Processes", "Worker"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "workerId", description = "ID of the worker to update.", required = true),
- @Parameter(name = "procDefKey", description = "Key of the process definition to update.", required = true),
- @Parameter(name = "enabledFlag", description = "Flag to set the process definition to.", required = true),
- @Parameter(name = "processVariables", description = "Process variables to update.", required = false)
+ @ApiOperation(value = "Updates the enabled/disabled status of a process definition on a worker", tags = {"Processes", "Workers"}, produces = "application/json")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "workerId", value = "ID of the worker to update.", required = true, paramType = "path"),
+ @ApiImplicitParam(name = "procDefKey", value = "Key of the process definition to update.", required = true, paramType = "path"),
+ @ApiImplicitParam(name = "enabledFlag", value = "Flag to set the process definition to.", required = true, paramType = "path"),
+ @ApiImplicitParam(name = "processVariables", value = "Process variables to update.", required = false, paramType = "query")
})
@RequestMapping(value = "/worker/{workerId}/{procDefKey}/updateWorkerProcDefEnabled/{enabledFlag}", method = POST)
public @ResponseBody String updateWorkerProcDefEnabled(
@@ -1678,8 +1678,8 @@ public GsonUTCDateAdapter() {
*
*/
@ApiOperation(value = "Suspends a process definition given its procDefId.", tags = {"Processes"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "procDefId", description = "ID of the process definition to suspend.", required = true)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "procDefId", value = "ID of the process definition to suspend.", required = true, paramType = "path")
})
@RequestMapping(value = "/deployments/suspend/{procDefId}", method = POST)
public @ResponseBody String suspendProcDefId(
@@ -1694,8 +1694,8 @@ public GsonUTCDateAdapter() {
*
*/
@ApiOperation(value = "Activates a suspended process definition given its procDefId.", tags = {"Processes"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "procDefId", description = "ID of the process definition to activate.", required = true)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "procDefId", value = "ID of the process definition to activate.", required = true, paramType = "path")
})
@RequestMapping(value = "/deployments/activate/{procDefId}", method = POST)
public @ResponseBody String activateProcDefId(
@@ -1711,8 +1711,8 @@ public GsonUTCDateAdapter() {
* Accepts an array of procInstIds and expects all of them to be running.
*/
@ApiOperation(value = "Deletes running process instances (Only pass running instances into this endpoint)", tags = {"Processes"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "procInstIds", description = "IDs of the process instances to delete. Expects all of the process instances in the list to be running.", required = true)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "procInstIds", value = "IDs of the process instances to delete. Expects all of the process instances in the list to be running.", required = true, paramType = "body")
})
@RequestMapping(value = "/processes/delete", method = POST)
public @ResponseBody String deleteRunningProcInsts(
@@ -1728,9 +1728,9 @@ public GsonUTCDateAdapter() {
*
*/
@ApiOperation(value = "Updates the number of job executor threads for a worker", tags = {"Workers"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "workerId", description = "ID of the worker to update.", required = true),
- @Parameter(name = "numThreads", description = "Number of threads to set for the worker.", required = true)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "workerId", value = "ID of the worker to update.", required = true, paramType = "path"),
+ @ApiImplicitParam(name = "numThreads", value = "Number of threads to set for the worker.", required = true, paramType = "path")
})
@RequestMapping(value = "/worker/{workerId}/updateNumJobExecThreads/{numThreads}", method = POST)
public @ResponseBody String updateWorkerNumJobExecThreads(
@@ -1811,6 +1811,9 @@ public GsonUTCDateAdapter() {
*
*/
@ApiOperation(value = "Validates CWS token.", tags = {"Security"}, produces = "application/json")
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "cwsToken", value = "CWS token to validate.", required = true, paramType = "query")
+ })
@RequestMapping(value = "/validateCwsToken", method = POST)
public @ResponseBody String validateCwsToken(
final HttpSession session,
@@ -1831,8 +1834,8 @@ public GsonUTCDateAdapter() {
*
*/
@ApiOperation(value = "Posts a message to an AMQ queue.", tags = {"Messaging"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "payload", description = "Payload to post to the queue.", required = true)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "payload", value = "Payload to post to the queue.", required = true, paramType = "query")
})
@RequestMapping(value = "/postAmqTopic", method = GET)
public @ResponseBody String postAmqTopic(@RequestParam(value = "payload", required=true) final String payload) {
@@ -1854,9 +1857,9 @@ public Message createMessage(Session session) throws JMSException {
*
*/
@ApiOperation(value = "Makes an external HTTP GET request.", tags = {"External"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "url", description = "URL to make the GET request to.", required = true),
- @Parameter(name = "acceptType", description = "Accept type for the request.", required = false)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "url", value = "URL to make the GET request to.", required = true, paramType = "query"),
+ @ApiImplicitParam(name = "acceptType", value = "Accept type for the request.", required = false, paramType = "query")
})
@RequestMapping(value = "/externalGetReq", method = GET)
public @ResponseBody String externalGetReq(
@@ -1886,9 +1889,9 @@ public Message createMessage(Session session) throws JMSException {
*
*/
@ApiOperation(value = "Makes an external HTTP POST request.", tags = {"External"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "url", description = "URL to make the POST request to.", required = true),
- @Parameter(name = "contentType", description = "Content type for the request.", required = false)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "url", value = "URL to make the POST request to.", required = true, paramType = "query"),
+ @ApiImplicitParam(name = "contentType", value = "Content type for the request.", required = false, paramType = "query")
})
@RequestMapping(value = "/externalPostReq", method = POST)
public @ResponseBody String externalPostReq(
@@ -1922,9 +1925,10 @@ public Message createMessage(Session session) throws JMSException {
*
*/
@ApiOperation(value = "Makes an external HTTP PUT request.", tags = {"External"}, produces = "application/json")
- @Parameters({
- @Parameter(name = "url", description = "URL to make the PUT request to.", required = true),
- @Parameter(name = "contentType", description = "Content type for the request.", required = false)
+ @ApiImplicitParams({
+ @ApiImplicitParam(name = "url", value = "URL to make the PUT request to.", required = true, paramType = "query"),
+ @ApiImplicitParam(name = "contentType", value = "Content type for the request.", required = false, paramType = "query"),
+ @ApiImplicitParam(name = "payload", value = "Payload to post to the queue.", required = true, paramType = "body")
})
@RequestMapping(value = "/externalPutReq", method = PUT)
public @ResponseBody String externalPutReq(
diff --git a/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java b/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java
index ffeb6f0e..32e61df8 100644
--- a/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java
+++ b/cws-service/src/main/java/jpl/cws/controller/SwaggerConfig.java
@@ -22,7 +22,8 @@ public Docket api() {
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
- .apiInfo(apiInfo());
+ .apiInfo(apiInfo())
+ .pathMapping("/rest/");
}
private ApiInfo apiInfo() {
diff --git a/install/cws-ui/documentation.ftl b/install/cws-ui/documentation.ftl
index f19e67f9..cf5b4cfb 100644
--- a/install/cws-ui/documentation.ftl
+++ b/install/cws-ui/documentation.ftl
@@ -82,6 +82,9 @@
API Documentation |
+
+ Camunda API Documentation |
+
diff --git a/pom.xml b/pom.xml
index 998d4bb0..dd19393b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -116,6 +116,11 @@
JBoss.org Maven repository
https://repository.jboss.org/nexus/content/groups/public
+
+ redhat
+ Redhat Maven Repository Public
+ https://maven.repository.redhat.com/ga/
+