Skip to main content



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.

Maximum SeverityError
MessageRequired property nickname in Operation Object is missing.
Rule SystemSemantic
Broad CategoryOperations
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsswagger1 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