Ensure that each API-using backend module migrates to new CI facilities
Description
Environment
Potential Workaround
has to be done before
is blocked by
relates to
Checklist
hideTestRail: Results
Activity
David Crossley October 4, 2022 at 2:05 AM
mod-inventory is now using these new facilities. So all are now done.
David Crossley September 4, 2022 at 11:14 PM
This is now blocked on the final one mod-inventory ().
David Crossley March 6, 2022 at 7:52 AMEdited
Last updated: 2022-10-04
This is the list of repositories that still needs to migrate to the new api-lint and api-doc CI tools. (Many others have already migrated.)
(Also refer to the list at .)
DONE: edge-patron ()
edge-search-srs (due to be archived?)
DONE: mod-codex-ekb ()
DONE: mod-codex-inventory
DONE: mod-codex-mux ()
DONE: mod-data-export ()
DONE: mod-data-import-converter-storage ()
DONE: mod-finc-config
DONE: mod-inventory ()
DONE: mod-inventory-storage ()
DONE: mod-kb-ebsco-java ()
DONE: mod-orders ()
DONE: mod-orders-storage ()
DONE: mod-patron ()
DONE: mod-permissions
DONE: mod-pubsub
DONE: mod-source-record-manager ()
DONE: mod-source-record-storage
Every backend module which has API descriptions, using RAML or OpenAPI (OAS), needs to migrate to the new CI facilities (api-lint and api-doc).
The old facilities are out-of-date, deprecated, and have vulnerabilities.
Using api-doc ensures that API documentation is generated and deployed to https://dev.folio.org/reference/api/ so that other developers know how to utilise the module.
Using api-lint ensures that API descriptions do not violate their specification.
To migrate an old configuration (or to implement a new one) refer to the following guide sections (and see the remainder of each document for further explanation):
api-lint: https://dev.folio.org/guides/api-lint/#jenkinsfile
api-doc: https://dev.folio.org/guides/api-doc/#jenkinsfile
Refer to the list below of those RAML-using projects that do still need to migrate.
There is also a list of new (mostly OAS) modules that are missing the configuration for generating and publishing their API documentation:
https://dev.folio.org/reference/api/#missing-api-documentation
Update 2022-03-06: This list is reduced because many have now been rectified.