Bug 1219748 - Include list of supported commands for Decision Server
Summary: Include list of supported commands for Decision Server
Keywords:
Status: CLOSED EOL
Alias: None
Product: JBoss BRMS Platform 6
Classification: Retired
Component: Documentation
Version: 6.1.0
Hardware: Unspecified
OS: Unspecified
urgent
medium
Target Milestone: ---
: One-off release
Assignee: Vidya
QA Contact: Karel Suta
Dawn Eisner
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-05-08 07:12 UTC by Anton Giertli
Modified: 2020-03-27 20:01 UTC (History)
2 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2020-03-27 20:01:16 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker DROOLS-822 0 Major Pull Request Sent Missing documentation for kie-server-client 2016-09-02 05:28:21 UTC

Description Anton Giertli 2015-05-08 07:12:54 UTC
Document URL: 

There are two URLs related

[1]
15.5.5. CommandExecutor Interface
https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.1/html/Development_Guide/sect-Running_in_KIE.html#Available_API

[2] 10.5. THE REST API FOR MANAGING THE REALTIME DECISION SERVER - [POST]   /containers/{id}

https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BRMS/6.1/html-single/User_Guide/index.html


Section Number and Name: 

Describe the issue: 
User Guide includes following information:
Any valid command (of the type org.kie.api.Command) with correct attributes can be sent.

This is missleading and not true - there is a strict list of supported commands which can be send to Decision Server and it needs to be documented.


Suggestions for improvement: 
In [1] - list of commands should be explicitly written, it can be found here:
http://docs.jboss.org/drools/release/6.2.0.Final/drools-docs/html/ch09.html

Short XML snippet of every command should be included in form of Doc Attachment.

Then, in [2] the [1] should be referenced - saying this is the list of supported commands which can be send to endpoint

[POST]   /containers/{id}

***excluding these four***:
StartProcessCommand
SignalEventCommand
CompleteWorkItemCommand
AbortWorkItemCommand


Also, in this section:

[POST]   /
Using POST HTTP method, you can execute various commands on the Decision Server: create-container, list-containers, dispose-container and call-container.

I'd like to see examples with XML/JSON too.

Additional information:

Comment 2 Anton Giertli 2015-05-08 07:25:51 UTC
Regarding commands which can be sent to [POST] /

I think they are here:
https://github.com/droolsjbpm/droolsjbpm-integration/tree/master/kie-server-parent/kie-server-api/src/main/java/org/kie/server/api/commands

Comment 3 Anton Giertli 2015-05-08 13:17:50 UTC
(In reply to Anton Giertli from comment #2)
> Regarding commands which can be sent to [POST] /
> 
> I think they are here:
> https://github.com/droolsjbpm/droolsjbpm-integration/tree/master/kie-server-
> parent/kie-server-api/src/main/java/org/kie/server/api/commands

this should be definite proof
https://github.com/droolsjbpm/droolsjbpm-integration/blob/6.2.x/kie-server-parent/kie-server-services/src/main/java/org/kie/server/services/impl/KieServerImpl.java#L53-L79

Comment 4 Anton Giertli 2015-06-25 13:06:25 UTC
includes pull request


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