maximum-operation-id-length
Overview
This rule belongs to the openapi-v3-codegen-linting ruleset and states that:
An Operation ID is a unique identifier for an operation object in an OpenAPI specification. It is used to generate client-side code and provide human-readable documentation. This rule ensures that the length of the Operation ID in the API definition does not exceed 50 characters, which is considered a best practice.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Operation ID should not exceed 50 characters. |
| Code | OPENAPI3CODEGEN_L196 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Operations |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi semantic linting apimatic operationId length 50 characters |
Suggested Fixes
- Ensure that the operation ID is 50 characters or less.