Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

Migrate to use new api-lint and api-doc CI tools

Description

As explained at FOLIO-3231, 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.

There are instructions at each documentation, including examples to modify the Jenkinsfile.

As noted in the api-lint documentation, the new tool is more thorough than our previous CI tool (based on raml-cop and its underlying raml-1-parser). So some projects might find new violations being reported.

Relevant parties: and

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

David Crossley July 15, 2022 at 3:10 AM

The PR is merged.

David Crossley July 12, 2022 at 11:59 AM

I reckon merge this PR so that we get it off the old configuration system.

Then follow https://dev.folio.org/faqs/how-to-archive-repository/

Khalilah Gambrell July 12, 2022 at 11:47 AM

Hey . This module is not used. What should we do in cases where a module is not used? And I know this might be a question for another audience. 

 

cc:  

David Crossley July 12, 2022 at 3:49 AM
Edited

Configuring the new tools does reveal one api-lint violation. This is a basic JSON error with file: ramls/raml-util/examples/codex/packageCollection.sample

This was fixed in the shared raml repo at raml/pull/129 on 2020-10-09.

The mod-codex-mux raml-util submodule was last updated on 2020-05-22.

I have a PR at mod-codex-mux/pull/96 which configures the new tools. It also updates the ramls/raml-util submodule, only to the specific commit of that raml/pull/129. The raml-util changes between 2020-05-22 and 2020-10-09 do seem to be benign.

Done

Details

Assignee

Reporter

Labels

Priority

Development Team

Spitfire

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created July 12, 2022 at 3:30 AM
Updated July 15, 2022 at 3:10 AM
Resolved July 15, 2022 at 3:10 AM
Configure
TestRail: Cases
TestRail: Runs