Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

(GSS) [7.44.x] [RHPAM-3219] No Model definition in KIE Server Swagger API #2274

Merged
merged 4 commits into from Nov 11, 2020
Merged

(GSS) [7.44.x] [RHPAM-3219] No Model definition in KIE Server Swagger API #2274

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b64efe
[JBPM-9410] No Model definition in KIE Server Swagger API
fjtirado Oct 5, 2020
8fa8cf5
JBPM-9410 - No Model definition in KIE Server Swagger API - revapi fix
MarianMacik Oct 26, 2020
ce2c121
JBPM-9410 - No Model definition in KIE Server Swagger API - revapi fix
fjtirado Nov 4, 2020
b553d0e
[JBPM-9410] Add test and fix missing methods (#2300)
gmunozfe Nov 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 35 additions & 0 deletions .../kie-server-remote/kie-server-rest/kie-server-rest-case-mgmt/src/build/revapi-config.json
View file
Open in desktop
Expand Up @@ -29,6 +29,41 @@
"revapi": {
"_comment": "Changes between 7.39.0.Final and the current branch. These changes are desired and thus ignored.",
"ignore": [
{
"code": "java.annotation.attributeRemoved",
"annotationType": "io.swagger.annotations.ApiOperation",
"attribute": "response",
"elementKind": "method",
"justification": "[JBPM-9410] No Model definition in KIE Server Swagger API"
},
{
"code": "java.annotation.added",
"annotationType": "io.swagger.annotations.ApiOperation",
"elementKind": "method",
"classSimpleName": "CaseQueryResource",
"justification": "[JBPM-9410] No Model definition in KIE Server Swagger API"
},
{
"code": "java.annotation.attributeRemoved",
"annotationType": "io.swagger.annotations.ApiOperation",
"attribute": "code",
"elementKind": "method",
"justification": "[JBPM-9410] No Model definition in KIE Server Swagger API"
},
{
"code": "java.annotation.attributeValueChanged",
"annotationType": "io.swagger.annotations.ApiResponses",
"attribute": "value",
"elementKind": "method",
"justification": "[JBPM-9410] No Model definition in KIE Server Swagger API"
},
{
"code": "java.annotation.attributeAdded",
"annotationType": "io.swagger.annotations.ApiOperation",
"attribute": "response",
"elementKind": "method",
"justification": "[JBPM-9410] No Model definition in KIE Server Swagger API"
},
{
"code": "java.method.numberOfParametersChanged",
"old": "method javax.ws.rs.core.Response org.kie.server.remote.rest.casemgmt.CaseAdminResource::getCaseInstances(javax.ws.rs.core.HttpHeaders, java.util.List<java.lang.String>, java.lang.Integer, java.lang.Integer, java.lang.String, boolean)",
Expand Down
10 changes: 4 additions & 6 deletions ...r-rest-case-mgmt/src/main/java/org/kie/server/remote/rest/casemgmt/CaseAdminResource.java
View file
Open in desktop
Expand Up @@ -79,10 +79,9 @@ public CaseAdminResource(
this.caseAdminServiceBase = caseAdminServiceBase;
}

@ApiOperation(value="Returns case instances without authentication checks.",
response=CaseInstanceList.class, code=200)
@ApiOperation(value="Returns case instances without authentication checks.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = CaseInstanceList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=CASE_INSTANCES_JSON)}))})
@GET
@Path(ADMIN_CASE_ALL_INSTANCES_GET_URI)
Expand Down Expand Up @@ -119,11 +118,10 @@ public Response getCaseInstances(@javax.ws.rs.core.Context HttpHeaders headers,
});
}

@ApiOperation(value="Migrates a specified case instance to another KIE container and case definition.",
response=CaseMigrationReportInstance.class, code=201)
@ApiOperation(value="Migrates a specified case instance to another KIE container and case definition.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 404, message = "Case instance or Container Id not found"),
@ApiResponse(code = 201, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 201, response = CaseMigrationReportInstance.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=CASE_MIGRATION_REPORT_JSON)})) })
@PUT
@Path(MIGRATE_CASE_INST_PUT_URI)
Expand Down
49 changes: 20 additions & 29 deletions ...r-rest-case-mgmt/src/main/java/org/kie/server/remote/rest/casemgmt/CaseQueryResource.java
View file
Open in desktop
Expand Up @@ -96,10 +96,9 @@ public CaseQueryResource(
super(caseManagementRuntimeDataServiceBase, context);
}

@ApiOperation(value="Returns cases instances with authentication checks.",
response=CaseInstanceList.class, code=200)
@ApiOperation(value="Returns cases instances with authentication checks.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = CaseInstanceList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=CASE_INSTANCES_JSON)}))})
@GET
@Path(CASE_ALL_INSTANCES_GET_URI)
Expand Down Expand Up @@ -141,10 +140,9 @@ public Response getCaseInstances(@javax.ws.rs.core.Context HttpHeaders headers,
});
}

@ApiOperation(value="Returns cases instances that involve the querying user in a specified role.",
response=CaseInstanceList.class, code=200)
@ApiOperation(value="Returns cases instances that involve the querying user in a specified role.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = CaseInstanceList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=CASE_INSTANCES_JSON)}))})
@GET
@Path(CASE_INSTANCES_BY_ROLE_GET_URI)
Expand Down Expand Up @@ -175,10 +173,9 @@ public Response getCaseInstancesByRole(@javax.ws.rs.core.Context HttpHeaders hea
* case definition methods
*/

@ApiOperation(value="Returns a specified case definition from all KIE containers.",
response=CaseDefinitionList.class, code=200)
@ApiOperation(value="Returns a specified case definition from all KIE containers.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, message = "Successful response", response = CaseDefinitionList.class, examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=CASE_DEFINITIONS_JSON)}))})
@GET
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
Expand All @@ -205,10 +202,9 @@ public Response getCaseDefinitions(@javax.ws.rs.core.Context HttpHeaders headers
/*
* process definition methods
*/
@ApiOperation(value="Returns a specified process associated with case definitions from all KIE containers.",
response=ProcessDefinitionList.class, code=200)
@ApiOperation(value="Returns a specified process associated with case definitions from all KIE containers.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = ProcessDefinitionList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_PROCESS_DEFS_RESPONSE_JSON)}))})
@GET
@Path(CASE_ALL_PROCESSES_INSTANCES_GET_URI)
Expand All @@ -233,10 +229,9 @@ public Response getProcessDefinitions(@javax.ws.rs.core.Context HttpHeaders head
});
}

@ApiOperation(value="Returns processes associated with case definitions in a specified KIE container.",
response=ProcessDefinitionList.class, code=200)
@ApiOperation(value="Returns processes associated with case definitions in a specified KIE container.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = ProcessDefinitionList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_PROCESS_DEFS_RESPONSE_JSON)}))})
@GET
@Path(CASE_PROCESSES_BY_CONTAINER_INSTANCES_GET_URI)
Expand Down Expand Up @@ -265,10 +260,9 @@ public Response getProcessDefinitionsByContainer(@javax.ws.rs.core.Context HttpH
* Case tasks
*/

@ApiOperation(value="Returns tasks for potential owners in a specified case instance.",
response=TaskSummaryList.class, code=200)
@ApiOperation(value="Returns tasks for potential owners in a specified case instance.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = TaskSummaryList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_TASK_SUMMARY_RESPONSE_JSON)}))})
@GET
@Path(CASE_TASKS_AS_POT_OWNER_GET_URI)
Expand All @@ -294,10 +288,9 @@ public Response getCaseInstanceTasksAsPotentialOwner(@javax.ws.rs.core.Context H
});
}

@ApiOperation(value="Returns tasks for business administrators in a specified case instance.",
response=TaskSummaryList.class, code=200)
@ApiOperation(value="Returns tasks for business administrators in a specified case instance.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = TaskSummaryList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_TASK_SUMMARY_RESPONSE_JSON)}))})
@GET
@Path(CASE_TASKS_AS_ADMIN_GET_URI)
Expand All @@ -323,10 +316,9 @@ public Response getCaseInstanceTasksAsAdmin(@javax.ws.rs.core.Context HttpHeader
});
}

@ApiOperation(value="Returns tasks for stakeholders in a specified case instance.",
response=TaskSummaryList.class, code=200)
@ApiOperation(value="Returns tasks for stakeholders in a specified case instance.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = TaskSummaryList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_TASK_SUMMARY_RESPONSE_JSON)}))})
@GET
@Path(CASE_TASKS_AS_STAKEHOLDER_GET_URI)
Expand All @@ -352,10 +344,9 @@ public Response getCaseInstanceTasksAsStakeholder(@javax.ws.rs.core.Context Http
});
}

@ApiOperation(value="Returns case file data items for a specified case instance.",
response=CaseFileDataItemList.class, code=200)
@ApiOperation(value="Returns case file data items for a specified case instance.")
@ApiResponses(value = { @ApiResponse(code = 500, message = "Unexpected error"),
@ApiResponse(code = 200, message = "Successfull response", examples=@Example(value= {
@ApiResponse(code = 200, response = CaseFileDataItemList.class, message = "Successful response", examples=@Example(value= {
@ExampleProperty(mediaType=JSON, value=GET_CASE_FILE_DATA_RESPONSE_JSON)}))})
@GET
@Path(CASE_FILE_GET_URI)
Expand All @@ -378,7 +369,7 @@ public Response getCaseInstanceDataItems(@javax.ws.rs.core.Context HttpHeaders h
});
}

@ApiOperation(value = "Queries cases by variables and tasks")
@ApiOperation(value = "Queries cases by variables and tasks", response = CaseInstanceCustomVarsList.class)
@POST
@Path(RestURI.VARIABLES_CASES_URI)
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
Expand All @@ -404,7 +395,7 @@ public Response queryCaseByVariables(@Context HttpHeaders headers, String payloa

}

@ApiOperation(value = "Queries cases tasks by variables")
@ApiOperation(value = "Queries cases tasks by variables", response = CaseUserTaskWithVariablesList.class)
@POST
@Path(RestURI.VARIABLES_TASKS_CASES_URI)
@Consumes({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
Expand Down