openapi-tags-uniqueness
Each tag must have a unique name.
- Applies to
tags- Selects
$.tags- Function
uniquenessTags- Specs
- OpenAPI 2.0OpenAPI 3.0OpenAPI 3.1OpenAPI 3.2
- Message
{{error}}
Use it
This rule ships with OpenLint in spectral:oas. Extending the ruleset turns it on:
extends: spectral:oas
rules:
openapi-tags-uniqueness: error # or off, or another severity
Definition
As defined in @openlint/openlint-rulesets. Functions show by name.
openapi-tags-uniqueness:
description: Each tag must have a unique name.
message: '{{error}}'
severity: error
recommended: true
given: $.tags
then:
function: uniquenessTags
About this rule
OpenAPI object must not have duplicated tag names (identifiers).
Bad Example
tags:
- name: "Badger"
- name: "Badger"
Good Example
tags:
- name: "Aardvark"
- name: "Badger"