RAML Validation
Overview
Validation checks performed on RAML v0.8 or v1.0 files.
| Property | Value |
|---|---|
| Id | raml-validation |
| Code | RAML_V |
| Ruleset Type | Validation |
| Default Severity of All Rules | Error |
| Rule System | Semantic |
| Tags | raml semantic validation |
For More Information
- https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md
- https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md
- https://docs.apimatic.io/rulesets/overview/
Categories of Rules
- Basic Structure (RAML_V001 - RAML_V099)
- API Metadata (RAML_V100 - RAML_V199)
- Types (RAML_V200 - RAML_V399)
- Resources and Methods (RAML_V400 - RAML_V499)
- Resource Types and Traits (RAML_V500 - RAML_V599)
- Security Schemes (RAML_V600 - RAML_V699)
- Includes (RAML_V700 - RAML_V799)
- Libraries (RAML_V800 - RAML_V899)
- Miscellaneous (RAML_V900 - RAML_V999)
Basic Structure Rules
- valid-raml-syntax (RAML_V001)
- valid-json-raml (RAML_V002)
- valid-combined-raml-yaml (RAML_V003)
- valid-property-value-type (RAML_V004)
API Metadata Rules
- required-title (RAML_V100)
- required-base-uri (RAML_V101)
- required-base-uri-parameter-default-value (RAML_V102)
Types Rules
- valid-raml-08-schema-definition (RAML_V200)
- raml-1-0-schemas-and-types-are-mutually-exclusive (RAML_V201)
- valid-type-declaration-type (RAML_V202)
- type-declaration-type-and-schema-are-mutually-exclusive (RAML_V203)
- type-declaration-example-and-examples-are-mutually-exclusive (RAML_V204)
- no-cyclic-dependency-in-type-declaration (RAML_V205)
- common-base-type-of-multiple-inheritance-types (RAML_V206)
Resources and Methods Rules
Resource Types and Traits Rules
Security Schemes Rules
- required-authorization-uri-oauth2-security-scheme-setting (RAML_V600)
- required-access-token-uri-oauth2-security-scheme-setting (RAML_V601)