non-empty-parameter-name-in-path-url-template-expression

Overview

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

In OpenAPI specifications, path parameters are defined by enclosing the parameter name in curly braces {} within the URL path. This rule enforces the requirement that path parameter declarations cannot be empty, as an empty path parameter declaration does not provide any useful information about the parameter.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Empty path parameter declaration found.
Code	OPENAPI3APIMATICSYNTAX_L181
Type	Linting
Rule System	Syntax
Broad Category	OpenAPI Paths
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi syntax linting apimatic path parameter empty declaration

Suggested Fixes

• Check the OpenAPI specification to identify any path parameter declarations that are empty.
• If any path parameter declarations are empty, update them with a valid parameter name.

For More Information

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