Skip to main content



This rule belongs to the openapi-v3-codegen-linting ruleset and states that:

The OperationId is a unique identifier for an operation, and it should reflect the purpose or functionality of the operation. Using articles like a, an, the in the OperationId can make it unnecessarily long and difficult to read. Therefore, it is recommended to avoid using articles in the OperationId.

Maximum SeverityWarning
MessageOperationId should not contain any article such as a, an or the.
Rule SystemSemantic
Broad CategoryOpenAPI Operations
Products ImpactedCode Generation, Developer Experience Portal
Tagscode generation sdks openapi3 openapi semantic linting apimatic operationId aticals A An The

Suggested Fixes

  • Remove all articles from the OperationId.
  • Make sure that id does not contain any spaces or underscores.

For More Information