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 (see some migration issues at FOLIO-3017).

Relevant parties:

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

David Crossley March 24, 2022 at 11:03 PM

Done.

David Crossley March 24, 2022 at 12:31 AM

See pull/319
where i have configured the new tools, and also addressed the current violations which arise from basic JSON errors in some samples.

Please review those JSON changes.

Done

Details

Assignee

Reporter

Priority

Development Team

Firebird

Fix versions

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created March 24, 2022 at 12:14 AM
Updated April 5, 2022 at 9:27 AM
Resolved March 24, 2022 at 11:03 PM
TestRail: Cases
TestRail: Runs