[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:
Blocks
is blocked by EDGPATRON-83 Migrate to use new api-lint and api-d... Closed
is blocked by MODDICONV-239 Migrate to use new api-lint and api-d... Closed
is blocked by MODINVSTOR-883 Migrate to use new api-lint and api-d... Closed
is blocked by MODKBEKBJ-632 Migrate to use new api-lint and api-d... Closed
is blocked by MODORDERS-678 Migrate to use new api-lint and api-d... Closed
is blocked by MODORDSTOR-293 Migrate to use new api-lint and api-d... Closed
is blocked by MODPATRON-110 Migrate to use new api-lint and api-d... Closed
is blocked by MODSOURMAN-776 Migrate to use new api-lint and api-d... Closed
is blocked by MODCXEKB-134 Migrate to use new api-lint and api-d... Closed
is blocked by MODCXMUX-89 Migrate to use new api-lint and api-d... Closed
is blocked by FOLIO-3570 An api-lint violation with mod-invent... Closed
is blocked by MDEXP-511 Migrate to use new api-lint and api-d... Closed
Gantt End to Start
has to be done before FOLIO-3718 Delete folio-tools/generate-api-docs Closed
has to be done before FOLIO-3719 Remove publishAPI (generate_api_docs.... Closed
Relates
relates to FOLIO-3017 List RAML issues with migration to ne... Closed
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:
https://dev.folio.org/reference/api/#missing-api-documentation
Update 2022-03-06: This list is reduced because many have now been rectified.



 Comments   
Comment by David Crossley [ 06/Mar/22 ]

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 FOLIO-3017 Closed .)

DONE: edge-patron ( EDGPATRON-83 Closed )
edge-search-srs (due to be archived?)
DONE: mod-codex-ekb ( MODCXEKB-134 Closed )
DONE: mod-codex-inventory
DONE: mod-codex-mux ( MODCXMUX-89 Closed )
DONE: mod-data-export ( MDEXP-511 Closed )
DONE: mod-data-import-converter-storage ( MODDICONV-239 Closed )
DONE: mod-finc-config
DONE: mod-inventory ( FOLIO-3570 Closed )
DONE: mod-inventory-storage ( MODINVSTOR-883 Closed )
DONE: mod-kb-ebsco-java ( MODKBEKBJ-632 Closed )
DONE: mod-orders ( MODORDERS-678 Closed )
DONE: mod-orders-storage ( MODORDSTOR-293 Closed )
DONE: mod-patron ( MODPATRON-110 Closed )
DONE: mod-permissions
DONE: mod-pubsub
DONE: mod-source-record-manager ( MODSOURMAN-776 Closed )
DONE: mod-source-record-storage

Comment by David Crossley [ 04/Sep/22 ]

This is now blocked on the final one mod-inventory ( FOLIO-3570 Closed ).

Comment by David Crossley [ 04/Oct/22 ]

mod-inventory is now using these new facilities. So all are now done.

 

Generated at Thu Feb 08 23:26:35 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.