required-title
Overview
This rule belongs to the raml-validation ruleset and states that:
The root object of RAML document must specify a short user-friendly title of the API using the title property. If title information is not provided, a default value will be assigned to it automatically during import/transformations in APIMatic.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required property title in root object is missing. |
| Code | RAML_V100 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | API Metadata |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | raml semantic validation title basic metadata |
Suggested Fixes
- Add missing
titleproperty in the root object. - Make sure that the
titleproperty value is not null or empty.
For More Information
- https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#the-root-of-the-document
- https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#api-title
- 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/