Api gui howto guide

[brynnz22]

@mslarae13 @jkelliher-github here is a first draft of some api gui documentation aimed at data consumers. It just includes information and examples for the find and metadata endpoints. Please feel free to give lots of feedback or if its easier to make any edits directly!

Thanks!

[eecavanna]

Looks great so far! I've found it easy to read and digest (as someone who does have experience using Swagger UI, but doesn't have much—in some cases, any—experience with the endpoints covered).

I have only reviewed up to the beginning of the "Metadata Endpoints" section. I'll continue from there another day later today.

[eecavanna]

I finished reviewing the entire document as of commit 454fd99 (and as of commit a05a20e).

[mslarae13]

I didn't really look for typos but have a few sentence re-work suggestions.

Also, we should consider who the documentation is for. I know we discussed it, but I don't recall the decision. And if the decision is both users & developers, we should separate out some of the developer / editing stuff to be more clear about who can have those permissions.. sections?

[brynnz22]

@mslarae13 @dwinston @eecavanna @aclum I Incorporated all of your suggestions. Thank you all for your feedback! It was very helpful. I removed all of the POST endpoints regarding change sheets since after discussion with @mslarae13 this might be confusing for users who can't actually submit change sheets. The [documentation] that @dwinston (https://microbiomedata.github.io/nmdc-runtime/howto-guides/author-changesheets/) created for developers includes that information. I also implemented a spell checker so the typos should be fixed. Apologies for not doing this sooner, but thanks everyone for catching those! Please let me know of any other suggestions/feedback before I finalize this.