flowable / flowable/flowable-engine
Error in API docs?
- Dominant language
- Java
- Stars
- 9.5k
- Forks
- 2.9k
- Avg merge
- 7h 8m
- Merged PRs (30d)
- 2
Description
**Describe the bug**
The REST API docs for the [List of process definitions API](https://www.flowable.com/open-source/docs/bpmn/ch14-REST/#list-of-process-definitions) state the following for the "latest" parameter:
> Only return the latest process definition versions. Can only be used together with 'key', 'keyLike', 'resourceName' and 'resourceNameLike' parameters, using any other parameter will result in a 400-response.
This does not seem to be true in practice. If you omit those parameters but still use "latest=true" you do get the latest version of each process definition with an HTTP error 200 status code.
I assume the "Latest version" filter in Flowable UI > Admin > Process Engine > Definitions uses the same API and there it also works.
**Expected behavior**
I guess if this is known to consistently work, the docs should be adapted. If not, I guess responding with an actual HTTP 4** error response would be better.
**Additional context**
Tested against Flowable 6.7.2 and 6.8.0.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reproducing the List of process definitions API request with latest=true and without the documented filter parameters, using the behavior described for Flowable 6.7.2 and 6.8.0. Compare the result with the API documentation linked in the issue; done means the implementation and documentation agree about whether the request is valid and what response it should produce.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100