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

CSP Request Details

None

CSP Rejection Details

None

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

Kateryna Senchenko April 11, 2022 at 9:51 AM

Hi , no changes in Karate tests are needed. All the work for mod-data-import-converter-storage is done and we're closing this issue. If such changes are required for other modules, I'll create separate tasks. Thank you!

Ann-Marie Breaux April 11, 2022 at 8:35 AM

Hi Could you and the BE folks confirm the points for this issue?

Also, will we need to update any Karate tests to reflect these changes?

David Crossley April 9, 2022 at 12:56 AM

That is beaut. Thanks.

Khamidulla Abdulkhakimov April 8, 2022 at 6:39 PM
Edited

Hi . I've fixed JSON errors and updated reference to raml-storage on mod-data-import-converter-storage also merged the PR.

cc: ,

Ann-Marie Breaux March 31, 2022 at 11:23 PM

Also, , will this require updates to any Karate automated tests? If yes, then we should add separate task(s) to cover that. Thank you!

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 March 23, 2022 at 11:50 PM
Updated June 28, 2022 at 7:56 PM
Resolved April 11, 2022 at 9:52 AM
TestRail: Cases
TestRail: Runs