Bug 988343 - REST API root should not throw an exception, but offer a basic help
REST API root should not throw an exception, but offer a basic help
Status: CLOSED NOTABUG
Product: JBoss BPMS Platform 6
Classification: JBoss
Component: Business Central (Show other bugs)
6.0.0
Unspecified Unspecified
low Severity medium
: ---
: ---
Assigned To: Marco Rietveld
Marián Macik
: Regression
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2013-07-25 07:25 EDT by Jiri Svitak
Modified: 2016-09-20 01:06 EDT (History)
7 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Last Closed: 2015-12-07 08:31:03 EST
Type: Feature Request
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Jiri Svitak 2013-07-25 07:25:19 EDT
When accessing an address
http://localhost:8080/business-central/rest
I get an ugly exception:

FAILURE /business-central/rest Could not find resource for relative : /business-central/rest of full path: http://localhost:8080/business-central/rest org.jboss.resteasy.spi.NotFoundException: Could not find resource for relative : /business-central/rest of full path: http://localhost:8080/business-central/rest at org.jboss.resteasy.core.registry.RootSegment.matchChildren(RootSegment.java:360) at
...

The root of the REST API and perhaps other REST API incomplete URLs should rather offer a basic navigation and list of available commands like in this wiki:
https://github.com/mrietveld/droolsjbpm-integration/wiki/Rest-API

BRMS 5.3.x business central REST API was able to offer a basic help, so this can be considered a regression.
Comment 1 Marco Rietveld 2013-07-25 11:48:19 EDT
Good idea, Jiri.
Comment 2 Marco Rietveld 2013-08-06 18:39:13 EDT
Setting to new, so that I can tell which bz's are modified ("ASSIGNED") and which aren't ("NEW").
Comment 3 Maciej Swiderski 2013-09-13 10:25:24 EDT
Marco, might be of use - I added something similar for execution server (lie-wb without UI) that for the root of the application will show simple table with REST operations

Here you can find the jsp page that shows the operations (it's built based on the rest wiki)
https://github.com/droolsjbpm/kie-wb-distributions/blob/master/kie-wb/kie-wb-webapp/src/main/webapp/rest-api.jsp

and here is how it binds to the web application 
https://github.com/droolsjbpm/kie-wb-distributions/blob/master/kie-wb/kie-wb-distribution-wars/src/main/eap6_1/WEB-INF/web-exec-server.xml#L76
Comment 4 Prakash Aradhya 2013-09-16 17:20:33 EDT
Internal Whiteboard: Beta Blocker → Blocker
Not critical for Beta, but need to address for GA
Comment 9 Jiri Svitak 2014-06-25 07:38:41 EDT
This issue still persists in BPMS 6.0.2.CR2.

As Maciej mentions, exec-server profile of business central already has such basic help screen for REST operations.
Comment 10 Marco Rietveld 2014-09-25 08:42:51 EDT
Work is being done to add swagger-ui to BPMS and BRMS.
Comment 11 Jiri Svitak 2014-10-01 08:47:17 EDT
I have checked with BPMS 6.1.0.DR3 and on page
http://localhost:8080/business-central
can be seen a help page listing basic REST API commands.

However the reported page
http://localhost:8080/business-central/rest
still shows the same error as in bug description.

New basic help screen in exec-server profile definitely improved the situation, but is there more work to be done? What is meant by swagger-ui?

Thanks,
Jiri
Comment 12 Marco Rietveld 2014-10-13 05:28:15 EDT
Unfortunately, the Swagger UI for both the kie-server and kie-remote REST interfaces did not make it into 6.2. 

For more info about Swagger, see: https://helloreverb.com/developers/swagger
Comment 15 Marco Rietveld 2015-12-07 08:31:03 EST
Closing as not a bug. 

1. This is a feature request
2. We are working on other documentation solutions.

Note You need to log in before you can comment on or make changes to this bug.