operation-id-exists
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The Operation Object must specify a unique identifier for the operation in the API document using the operationId property. This id is used by the code generation engine to generate relevant components tied to an endpoint.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required operation id is missing from the operation object. |
| Code | OPENAPI3APIMATIC_L230 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Operations |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting operation id id operation |
Suggested Fixes
- Ensure that the Operation Object contains a non-null and non-empty id in the
operationIdproperty.