[FOLIO-1645] Configuration of locations of RAMLs and schemas Created: 10/Dec/18  Updated: 03/Jun/20

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

Type: Task Priority: P3
Reporter: David Crossley Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: ci, raml
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Relates
relates to FOLIO-1253 Improve the generate-api-docs CI job In Progress
relates to FOLIO-1497 Improve the lint-raml CI job Closed
relates to OKAPI-687 Report module dependencies as a graph... Closed
relates to RMB-253 Provide machine-readable RAML and Jso... Closed
Sprint:
Development Team: Core: Platform

 Description   

Back-end modules have variety in the location of their RAML and schema files.

Most now do have the RAMLs located under the top-level "./ramls/" directory and the shared ones in "./ramls/raml-util/" sub-directory. Some have schemas located in a sub-directory of "./ramls/" and some have their RAML files in a sub-directory. Some have additional sub-directories that would need to be excluded, if tools need to automatically search for the RAML and Schema files.

For the "lint-raml" and "generate-api-docs" CI jobs we have handled these complications by using the api.yml configuration file. The configuration has increased in complexity over time, as new inconsistencies appear. The file is manually maintained.

We need a way for each module to declare the location of these pieces.

Tools could then directly utilise that metadata. Other tools could aggregate the information for other configuration purposes.



 Comments   
Comment by David Crossley [ 10/Dec/18 ]

In RMB pre-v20 (or a bit later) we needed careful relative filesystem locations of related schema files (via $ref with not too many dot-dots). So now modules could place them in a default "./ramls/schemas/" sub-directory.

Would still need a way to declare a different location.

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