This rule belongs to the
io-docs-validation ruleset and states that:
An I/O Docs file must not contain any syntax/semantic issues and use only valid JSON. Each property in the file must have a type as defined in the standard.
|Message||Provided I/O Docs file is not valid.|
|Broad Category||Basic Structure|
|Products Impacted||API Transformer, Code Generation, Developer Experience Portal|
- Ensure that the file uses valid JSON.
- Ensure that each element in the I/O Docs file has the expected type.
- Ensure that an array is not defined as an object or vice versa.
- Ensure that where a number is expected, a string value is not provided, etc.
- For objects, ensure that each property has a correct type assigned to it.