[Feature] [OPEA API] content is missing in automatically generated RESTful API spec

[lianhao]

Priority

Undecided

OS type

Ubuntu

Hardware type

Xeon-GNR

Running nodes

Single Node

Description

Many of the OPEA microservices rely on the fastAPI's automatic API doc generation feature to generate RESTful API spec. However, the explanations of the input and/or output parameters of some of the APIs are missing.

Take dataprep as an example, please note that the input parameter of API /v1/dataprep/ingest is missing.

We should make sure the automatically generated API spec has all the content the developers need:

1. Full RESTful API spec with explanations of all input/output parameters
2. If we could provide some API usage examples that would be much better