[FOLIO-1908] Enhance lint-raml to process ModuleDescriptor and RAML files, correlate for interface and version Created: 26/Mar/19  Updated: 03/Jun/20

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

Type: New Feature Priority: P3
Reporter: David Crossley Assignee: David Crossley
Resolution: Unresolved Votes: 0
Labels: platform-backlog, raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Blocks
blocks FOLIO-1767 Ensure that ModuleDescriptor and RAML... Open
is blocked by FOLIO-1909 Add dev doc guides/raml-interface-ver... Open
Relates
relates to FOLIO-1911 Enhance generate-api-docs to record m... Open
Sprint:
Development Team: Core: Platform

 Description   

With the folio-tools/lint-raml CI job.
This job runs after the Jenkins Checkout phase and before the software Build phase. It finds and processes the RAML files. It writes messages to the output report. If there are RAML/Schema errors, then it also sends the report to the PR page. It does not stop the pipeline.

  • Parse MD with jq to extract list of "interface" name and "version" pairs for this repo.
  • Extract "interface" name and "version" pairs from each RAML file and match with MD.
  • Report mis-match.

For most repositories, the MD template is in the "./descriptors/" directory.
For current Gradle-based repositories, it is in the "./service/src/main/okapi" directory.
Otherwise, we need metadata to declare its location.

Acceptance criteria:
Missing or mis-matched information is reported by the lint-raml CI job.


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