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
- [x] Each Endpoint has an example on OPENAPI/Swagger
- [x] If applicable, input and output schema's for OPENAPI/Swagger
- [ ] Documentation of known coverage gaps
- [ ] Documentation of where endpoints are located in Repo
- [ ] For workflows, basic error handling / responses
### AMR Extraction
- [x] Each Endpoint has an example on OPENAPI/Swagger
- [x] If applicable, input and output schema's for OPENAPI/Swagger
- [ ] Documentation of known coverage gaps
- [ ] Documentation of where endpoints are located in Repo
- [ ] For workflows, basic error handling / responses
### Program Analysis
- [x] Each Endpoint has an example on OPENAPI/Swagger
- [x] If applicable, input and output schema's for OPENAPI/Swagger
- [ ] Documentation of known coverage gaps for Fortran
- [ ] Documentation of known coverage gaps for Python
- [x] Documentation of where endpoints are located in Repo
- [ ] For workflows, basic error handling / responses
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/docsdirectory which is the source code / markdown for our website.Breakdown by Services: