workflow for Swagger API documentation

[leilaicruz]

• Look at all endpoints from https://docs.google.com/spreadsheets/d/1A-VWxGheyS36Fm6mj7MLnrHO2UvXAMSE7TxJ652bxuw/edit?gid=0#gid=0
• Go to https://docs.figshare.com/ and the source code https://github.com/4TUResearchData/djehuty/blob/main/src/djehuty/web/wsgi.py and look at that specific endpoint , to extract all the parameters and methods associated to it.
• Create the yaml specs using the OpenAPI standard https://editor.swagger.io/
• Copy the yaml into https://github.com/leilaicruz/djehuty-mkdocs/blob/main/documentation/docs/openapi_spec_model.yml
• Serve and deploy with the mkdocs

[leilaicruz]

It is also possible to :

1. Generate docstrings from all python functions of the API

• Implement this in fork of Djehuty and make eventually a pull request to the main repo

2. From the docstrings generate the yaml spec from the open API standard
3. Generate documentation using MKdocs and Swagger UI tools to parse the yaml into an interactive website so users can test out much easily the API capabilities of 4TU.

This implementation is using AI to assist in this process, ChatGPT 4