Review of Workflow BB API documentation

This is a review of the version 1.0.1 that was last modified 1 month ago.

Structural problems:

• Gitbook

-

• Github

  • one Semantic problem when opening a yaml file in Swagger

Open

Discrepancies and missing info:

 -

API problems:

• GET /processes

  • no headers

  • error responses lack examples and schemas

• GET /processes/{processId}

  • no headers

  • error responses lack examples and schemas

• POST /processes/{processId}/start

  • no headers

  • error responses lack examples and schemas

• GET /instances/

  • no headers

  • error responses lack examples and schemas

• GET /instances/{instanceId}

  • no headers

  • error responses lack examples and schemas

Final conclusions:

• It would be great to have a Readme file

• All parameters follow a common naming convention which is great

• Great to have only paths for endpoints - makes it clearer