[FOLIO-2893] Create folio-tools/api-lint to verify RAML or OAS files Created: 01/Dec/20  Updated: 08/Aug/22  Resolved: 11/Dec/20

Status: Closed
Project: FOLIO
Components: None
Affects versions: None
Fix versions: None

Type: Task Priority: TBD
Reporter: David Crossley Assignee: David Crossley
Resolution: Done Votes: 0
Labels: oas, raml, springway
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-3017 List RAML issues with migration to ne... Closed
relates to FOLIO-3382 Upgrade amf-client-js to v5 for api-lint Closed
relates to FOLIO-3486 Upgrade amf-client-js to v5.0.8 for a... Closed
relates to FOLIO-3528 Upgrade amf-client-js to v5.0.10 for ... Closed
relates to FOLIO-3553 Upgrade amf-client-js to v5.2.0 for a... Closed
relates to FOLIO-1497 Improve the lint-raml CI job Closed
relates to FOLIO-2863 pipeline changes required for Spring ... Blocked
Sprint: DevOps: Sprint 103
Development Team: FOLIO DevOps

 Description   

Develop application to discover and process API description files in a module repository. Report non-conformance.

The most likely tool for this is AMF https://github.com/aml-org/amf (see initial investigation in FOLIO-2792 Closed ). These tools can process both RAML and OpenAPI OAS files. So the same application would handle both RAML-using and OAS-using FOLIO projects.

The application would be able to be run locally, and during CI on any branch.



 Comments   
Comment by David Crossley [ 11/Dec/20 ]

Done.

See docs at https://dev.folio.org/guides/api-lint/

Generated at Thu Feb 08 23:24:02 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.