[FOLIO-3231] Ensure that each API-using backend module migrates to new CI facilities Created: 08/Jul/21 Updated: 21/Feb/23 Resolved: 04/Oct/22 |
|
| Status: | Closed |
| Project: | FOLIO |
| Components: | None |
| Affects versions: | None |
| Fix versions: | None |
| Type: | Task | Priority: | TBD |
| Reporter: | David Crossley | Assignee: | David Crossley |
| Resolution: | Done | Votes: | 0 |
| Labels: | oas, raml | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original estimate: | Not Specified | ||
| Issue links: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Sprint: | DevOps Sprint 146, DevOps Sprint 137, DevOps Sprint 144, DevOps Sprint 138, DevOps Sprint 139, DevOps Sprint 142, DevOps Sprint 140, DevOps Sprint 141, DevOps Sprint 145, DevOps Sprint 149, DevOps Sprint 150 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Development Team: | FOLIO DevOps | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Description |
|
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):
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: |
| Comments |
| Comment by David Crossley [ 06/Mar/22 ] |
|
Last updated: 2022-10-04 (Also refer to the list at
DONE: edge-patron (
|
| Comment by David Crossley [ 04/Sep/22 ] |
|
This is now blocked on the final one mod-inventory (
|
| Comment by David Crossley [ 04/Oct/22 ] |
|
mod-inventory is now using these new facilities. So all are now done.
|