[M12] Skema Service Documentation

[Free-Quarks]

This an issue to track aspects of our service that may need more documentation before the hand-off. The location where we are pooling all our documentation is in the skema/docs directory which is the source code / markdown for our website.

Breakdown by Services:

Text Reading

Beta Give feedback

1. Each Endpoint has an example on OPENAPI/Swagger
2. If applicable, input and output schema's for OPENAPI/Swagger
3. Documentation of known coverage gaps
4. Documentation of where endpoints are located in Repo
5. For workflows, basic error handling / responses

AMR Extraction

Beta Give feedback

1. Each Endpoint has an example on OPENAPI/Swagger
2. If applicable, input and output schema's for OPENAPI/Swagger
3. Documentation of known coverage gaps
4. Documentation of where endpoints are located in Repo
5. For workflows, basic error handling / responses

Program Analysis

Beta Give feedback

1. Each Endpoint has an example on OPENAPI/Swagger
2. If applicable, input and output schema's for OPENAPI/Swagger
3. Documentation of known coverage gaps for Fortran
4. Documentation of known coverage gaps for Python
5. Documentation of where endpoints are located in Repo
6. For workflows, basic error handling / responses