required-method-parameter-name

Overview

This rule belongs to the io-docs-validation ruleset and states that:

A parameter defined in the parameters section must specify the name for the parameter using the name property (for legacy I/O Docs versions) or the title property (for I/O Docs Mashery verison). The name is API/service defined and must not be null or empty.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Method parameter name is missing.
Code	IODOCS_V100
Type	Validation
Rule System	Semantic
Broad Category	Methods
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	io docs semantic validation name parameter

Suggested Fixes

• If you are using a legacy I/O Docs Node.js file, add property name in the parameter definition object.
• If you are using I/O Docs Mashery version, add property title in the parameter definition object.
• Make sure that the name value 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.

For More Information

• https://github.com/mashery/iodocs#api-level-config-details
• https://github.com/mashery/iodocs
• https://docs.apimatic.io/rulesets/overview/