Details
-
Task
-
Status: Draft (View Workflow)
-
TBD
-
Resolution: Unresolved
-
-
Bienenvolk
Description
FOLIO publishes API documentation at https://dev.folio.org/reference/api/
However, mod-agreements' API documentation is at https://github.com/ostephens/folio-erm-agreements-api-os/ , it is not easy to find (side note: and developers cannot update both the implementation and documentation in a single pull request when working on a feature), and several steps (clone, npm) are needed to convert the raw openapi documentation into the final HTML documentation (see https://github.com/ostephens/folio-erm-agreements-api-os/blob/main/README.md ).
As of 2023-03-16:
- 112 pathPattern API entries in https://github.com/folio-org/mod-licenses/blob/master/service/src/main/okapi/ModuleDescriptor-template.json
- 31 path API entries in https://github.com/ostephens/folio-erm-agreements-api-os/tree/main/openapi/paths
One option is to move the documentation into the mod-agreements repository and use Jenkins' API documentation deploy feature: https://dev.folio.org/guides/api-lint/#jenkinsfile-for-oas
Acceptance criteria:
- mod-agreements' API documentation is listed (content or link) on https://dev.folio.org/reference/api/
- all APIs are documented
(This ticket may be split into smaller tasks.)
TestRail: Results
Attachments
Issue Links
- relates to
-
ERM-476 Autogenerate API Documentation
-
- Closed
-