unique-parameter-name
Overview
This rule belongs to the openapi-v3-apimatic-linting
ruleset and states that:
Operation level parameter names and requestBody
schema property names should be unique. You can use parameter-level x-unique-name
to provide unique display name to conflicting parameter.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Duplicate parameter names found. |
Code | OPENAPI3APIMATIC_L331 |
Type | Linting |
Rule System | Semantic |
Broad Category | OpenAPI Parameters |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi apimatic semantic linting parameter name unique x-unique-name |
Suggested Fixes
- Use parameter-level
x-unique-name
to provide unique display name. - Make sure all parameters have unique names.
- If a
requestBody
object exists, make sure no parameter name is equal to any schema property key in therequestBody
.