|
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.
|