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).
For mod-inventory-storage most of the 52 API descriptions yield no errors. However there are two noted at FOLIO-3017 which do have violations (required media-type for 200 body response).
Also note that someone partially configured api-doc last month (missing the Jenkinsfile declaration for the required properties). This causes failures for the generation of API documentation during each merge to mainline branch (see the Jenkins artifact ApiDocReport). So no API documentation has been updated since 2022-02-15.
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).
For mod-inventory-storage most of the 52 API descriptions yield no errors. However there are two noted at FOLIO-3017 which do have violations (required media-type for 200 body response).
Also note that someone partially configured api-doc last month (missing the Jenkinsfile declaration for the required properties). This causes failures for the generation of API documentation during each merge to mainline branch (see the Jenkins artifact ApiDocReport). So no API documentation has been updated since 2022-02-15.