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