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

Priority

Environment

None

Template

None

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: and

Development Team

Spitfire

Release

Morning Glory (R2 2022)

Story Points

Sprint

Checklist

hide

TestRail: Results

Activity

Show:

David Crossley May 11, 2022 at 12:19 AM

Now merged. Thanks.

David Crossley April 16, 2022 at 8:05 AM

See pull/404 where i have configured the new tools, and fixed those new violations.

David Crossley April 16, 2022 at 8:05 AM

All current errors arise from JSON examples which use incorrect string or null values, rather than their declared type of integer or number.

Done

Details

RCA Group

TBD

Assignee

Reporter

Fix versions

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created April 16, 2022 at 7:31 AM
Updated June 1, 2022 at 3:19 PM
Resolved May 11, 2022 at 12:20 AM
TestRail: Cases
TestRail: Runs