required-parameter-name
Overview
This rule belongs to the swagger-v2-standards-validation
ruleset and states that:
The Parameter Object must specify a name for the parameter using the name
property. The name is API/service defined and must not be null or empty.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Required property name in Parameter Object is missing. |
Code | SWAGGER20STANDARDS_V095 |
Type | Validation |
Rule System | Semantic |
Broad Category | Parameters |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | swagger2 swagger standards semantic validation name parameter |
Suggested Fixes
- Add missing
name
property in the Parameter object. - Make sure that the
name
property is not null or empty. - The name of the parameter must match exactly with the name of the parameter expected by the API. Names may be compared in a case-sensitive manner.