maximum-path-item-parameter-name-length

Overview

This rule belongs to the openapi-v3-codegen-linting ruleset and states that:

Parameter name within the path item length must not be equal to or exceed 50 characters.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Parameter name violates maximum length restrictions
Code	OPENAPI3CODEGEN_L173
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Path Items
Products Impacted	Code Generation, Developer Experience Portal
Tags	code generation sdks openapi3 openapi semantic linting apimatic path parameter parameters name length 50 characters

Suggested Fixes

• Shorten the parameter name so that it does not exceed the limit.
• Try to keep the name under 25 characters.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#path-item-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/