unique-tag-name
Overview
This rule belongs to the openapi-v3-standards-validation
ruleset and states that:
The list of root OpenAPI Object level tags
must have a unique name assigned to them in the Tag Object definition using the name
property.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Duplicate name for tag found. |
Code | OPENAPI3STANDARDS_V301 |
Type | Validation |
Rule System | Semantic |
Broad Category | Tags |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi standards semantic validation name tags tag |
Suggested Fixes
- Make sure that all Tag Object definitions in the
tags
list have unique names assigned to them. - Remove entries of tags that have equal names.
- Tag names are compared in a case-sensitive manner.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#openapi-object:~:text=Each%20tag%20name%20in%20the%20list%20MUST%20be%20unique.
- 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#openapi-object:~:text=Each%20tag%20name%20in%20the%20list%20MUST%20be%20unique.
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#tagObject
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/