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 14, 2022 at 10:15 PM

Done.

David Crossley March 14, 2022 at 12:19 AM

The violations and warnings are straight-forward.

See pull/79

Done

Details

Assignee

Reporter

Priority

Development Team

Prokopovych

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created March 13, 2022 at 11:36 PM
Updated March 14, 2022 at 10:15 PM
Resolved March 14, 2022 at 10:15 PM
TestRail: Cases
TestRail: Runs

Flag notifications