valid-operation-summary
Overview
This rule belongs to the openapi-v3-codegen-syntax-linting ruleset and states that:
For successful Code Generation, the operation summary must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Operation summary is invalid. |
| Code | OPENAPI3CODEGENSYNTAX_L191 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI Operations |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | code generation sdks openapi3 openapi syntax linting apimatic operation summary |
Suggested Fixes
- Make sure that the summary of the operation does not contain any forbidden characters.
- Use only letters, numbers, underscores and dashes.
- Remove any trailing/leading white-space characters, if present.