The api web service has a number of endpoints to fetch projects. They are now documented in api/README.md, but the does not talk about the shape of the response. Also it is missing the enrichment endpoint the web application uses.
The whole api surface can be documented using a OpenAPI specification. The specification should be published statically as /static/openapi.json or dynamicly as /api/openapi. The usage instructions in api/README.md should be moved to manual/developer.md for developers wanting to consume the web service.
sverhoeven
commented
4 years ago
The api web service has a number of endpoints to fetch projects. They are now documented in api/README.md, but the does not talk about the shape of the response. Also it is missing the enrichment endpoint the web application uses.
The whole api surface can be documented using a OpenAPI specification. The specification should be published statically as
/static/openapi.jsonor dynamicly as/api/openapi. The usage instructions inapi/README.mdshould be moved tomanual/developer.mdfor developers wanting to consume the web service.