search

microbiomedata / NMDC_documentation

Document workflows, schemas, and portal
https://nmdc-documentation.readthedocs.io
2 stars 3 forks source link

Api gui howto guide #27

Closed brynnz22 closed 1 year ago

brynnz22 commented 1 year ago

@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!

brynnz22 commented 1 year ago

@dwinston @aclum @eecavanna Please let me know if there is any inaccuracies or feedback you have! Thanks!

brynnz22 commented 1 year ago

@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.