mercedes-benz / sechub

SecHub provides a central API to test software with different security tools.
https://mercedes-benz.github.io/sechub/
MIT License
259 stars 58 forks source link

Improve PDS REST API documentation by RestDoc tests #649

Open de-jcup opened 3 years ago

de-jcup commented 3 years ago

Situation

https://daimler.github.io/sechub/latest/sechub-product-delegation-server.html#rest-api Does not contain correct RESTDoc test outputs, but static content - which is not enough

Wanted

For the PDS restcontrollers we create dedicated PDS{restControllerName}DocTest.java pendants - like in SecHub itself. The generated output must be available inside PDS documentation.

de-jcup commented 2 years ago

It must be discussed, if we really need the documentation. PDS is just used internally by SecHub and so currently not a public API which must be documented.

So at least, this is somehting which can be done later.