required-info-title
Overview
This rule belongs to the openapi-v3-standards-validation
ruleset and states that:
The Info Object must specify a title of the API using the title
property.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Required property title in Info Object is missing. |
Code | OPENAPI3STANDARDS_V010 |
Type | Validation |
Rule System | Semantic |
Broad Category | Info |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi standards semantic validation api title api title info metadata |
Suggested Fixes
- Add missing
title
property in the Info Object. - Make sure that the
title
property value is not null or empty.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#info-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/