Documentation tasks - NMDC API - Parent Issue

[ssarrafan]

Add to this list of tasks to update, write API documentation:

• https://nmdc-documentation.readthedocs.io/en/latest/howto_guides/api_gui.html
• https://github.com/microbiomedata/nmdc-server/wiki/Search-API-Docs
• https://github.com/microbiomedata/NMDC_documentation/blob/main/docs/howto_guides/api_gui.md
• https://nmdc-documentation.readthedocs.io/en/latest/howto_guides/api_gui.html#retrieving-metadata-using-the-find-and-metadata-api-endpoints

[ssarrafan]

Checked with Emiley, Lee Ann and Shreyas and Shreyas said he can be the owner of API documentation. Assigning this master issue to @shreddd. Shreyas please add links and sub-issues to make sure we have all the necessary documentation covered for this topic.

Note from Shreyas: I think the API docs should probably be re-thought since this information is mostly in swagger. I would want to just have a simple how to use the API page, and then fall back on Swagger for the details since it is self documenting. for

[ssarrafan]

@shreddd @eecavanna what's the status of this? Is this in progress? Can you complete this by Friday? At least the list of sub-tasks? Will you have time to work on this next sprint?

[ssarrafan]

Since @shreddd is out of town this week I will add this to the next sprint.
FYI @eecavanna

[eecavanna]

I'll move this to the next sprint.