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

RCA Group

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

 

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

Khamidulla Abdulkhakimov April 26, 2022 at 4:07 PM
Edited

Hi . I've fixed JSON error and merged the PR. Thank you.

cc:

David Crossley April 13, 2022 at 3:20 AM

See pull/617 where i have configured the new tools.

Would someone please fix the JSON errors as described in the previous comment, and then update the "raml-storage" git submodule in that branch.

 

David Crossley April 13, 2022 at 2:41 AM

All current errors arise from one broken JSON sample record which has missing comma.

ramls/raml-storage/examples/mod-source-record-manager/jobExecution.sample line 69

Done

Details

Assignee

Reporter

Labels

Priority

Story Points

Sprint

Development Team

Folijet

Parent

Fix versions

Release

Morning Glory (R2 2022)

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created April 13, 2022 at 2:33 AM
Updated July 5, 2022 at 1:27 PM
Resolved April 27, 2022 at 1:03 AM
TestRail: Cases
TestRail: Runs