valid-combined-raml-yaml
Overview
This rule belongs to the raml-validation ruleset and states that:
A RAML master file may reference one or more of external files (using !include) that are either available locally in a ZIP file or in a public URL. Before the information in the RAML file can be processed further, the data from the various files need to be included/merged into the master RAML file. The resulting master RAML file must contain valid YAML content. This means that individual files contributing their content to the RAML master file must also contain valid JSON/YAML/XML/Markdown content that won't render the merged RAML YAML file as invalid.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Blocking |
| Message | Provided RAML files when combined produce an invalid YAML. |
| Code | RAML_V003 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Basic Structure |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | raml semantic validation yaml |
Suggested Fixes
- Ensure that each external file you reference contains valid YAML/JSON/XML/Markdown content.
- Ensure that the external files do not contain binary data.
- Analyze the errors to determine at which point the YAML became invalid and trace the content back to the original files. Then fix accordingly.