valid-entity-type
Overview
This rule belongs to the api-blueprint-validation ruleset and states that:
Each element in an API Blueprint/Elements file must have a correct type assigned to it as per the standards.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | An entity in the API Blueprint/Elements file could not be parsed. |
| Code | APIBLUEPRINT_V006 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Basic Structure |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | api blueprint api elements api semantic validation type |
Suggested Fixes
- Ensure that each element in an API Blueprint/Elements 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.