I-O Docs Validation

Overview

Validation checks performed on a I/O Docs Document file.

Property	Value
Id	io-docs-validation
Code	IODOCS_V
Ruleset Type	Validation
Default Severity of All Rules	Error
Rule System	Semantic
Tags	io docs semantic validation

For More Information

• https://github.com/mashery/iodocs
• https://docs.apimatic.io/rulesets/overview/

Categories of Rules

• Basic Structure (IODOCS_V001 - IODOCS_V049)
• API Metadata (IODOCS_V050 - IODOCS_V099)
• Methods (IODOCS_V100 - IODOCS_V199)
• Miscellaneous (IODOCS_V200 - IODOCS_V999)

Basic Structure Rules

• valid-io-docs-syntax (IODOCS_V001)

API Metadata Rules

• required-name (IODOCS_V050)

Methods Rules

• required-method-parameter-name (IODOCS_V100)
• no-request-body-parameter-for-get-http-method (IODOCS_V101)