FAIRDataTeam / FAIRDataPoint

https://www.fairdatapoint.org
MIT License
59 stars 37 forks source link

Some API endpoints seems to be missing from Swagger and OpenAPI documentation or not documented at all. #511

Open mgaggero opened 6 months ago

mgaggero commented 6 months ago

What components are related to the issue?

API

Which FDP are you using?

My local instance

Version

Server
Version v1.17.1~9604e79
Built at    9. 8. 2023, 15:53
Client
Version v1.17.0~4af79dd
Built at    14. 7. 2023, 10:56

What happened?

Hello, upon reviewing Swagger and OpenAPI documentation, it appears that certain FDP APIs are missing and remain undocumented. These include endpoints such as /catalog, /dataset, /meta/state, and others. Additionally, upon inspecting the source code, it seems that some of these endpoints are intentionally excluded or "hidden" from the Swagger/OpenAPI documentation.

Where can I locate documentation for these missing endpoints?

Relevant log output

No response