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

Environment

None

Potential Workaround

None

Checklist

hide

TestRail: Results

Activity

Show:

David Crossley June 14, 2022 at 7:07 AM

Done.

David Crossley April 10, 2022 at 4:19 AM

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

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

 

David Crossley April 10, 2022 at 4:04 AM

All current errors arise from incorrect Boolean values in some JSON Schema in the "acq-models" git submodule.

Some objects have the correct form:
"type": "boolean", "default": false

while others have the incorrect form using quotes around the boolean value:
"type": "boolean", "default": "false"

ramls/acq-models/mod-orders-storage/schemas/ongoing.json – line 13
ramls/acq-models/mod-orders-storage/schemas/piece.json – line 46
ramls/acq-models/mod-orders-storage/schemas/receiving_history.json – line 36

Note that those three are also part of MODORDERS-678

Done

Details

Assignee

Reporter

Priority

Development Team

Thunderjet

TestRail: Cases

Open TestRail: Cases

TestRail: Runs

Open TestRail: Runs
Created April 10, 2022 at 4:02 AM
Updated June 14, 2022 at 7:07 AM
Resolved June 14, 2022 at 7:07 AM
TestRail: Cases
TestRail: Runs