required-operation-nickname

Overview

This rule belongs to the swagger-v1-validation ruleset and states that:

The Operation Object must specify a unique id for the operation that can be used by tools reading the output for further and easier manipulation, using the nickname property.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Required property nickname in Operation Object is missing.
Code	SWAGGER1_V500
Type	Validation
Rule System	Semantic
Broad Category	Operations
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger1 swagger semantic validation nickname operation

Suggested Fixes

• Add missing nickname property in the Operation Object.
• Make sure that the nickname property is not null or empty.
• Assign a brief name that can highlight the main function performed by the operation.
• The nickname must be alphanumeric and may include underscores. Whitespace characters are not allowed.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md#523-operation-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md
• https://docs.apimatic.io/rulesets/overview/