API Blueprint Validation
Overview
Validation checks performed on an API Blueprint or API Elements file.
| Property | Value |
|---|---|
| Id | api-blueprint-validation |
| Code | APIBLUEPRINT_V |
| Ruleset Type | Validation |
| Default Severity of All Rules | Error |
| Rule System | Semantic |
| Tags | api blueprint api elements api semantic validation |
For More Information
- https://apiblueprint.org/documentation/specification.html
- https://apiary.io/
- https://docs.apimatic.io/rulesets/overview/
Categories of Rules
- Basic Structure (APIBLUEPRINT_V001 - APIBLUEPRINT_V099)
- API Resources (APIBLUEPRINT_V100 - APIBLUEPRINT_V299)
- Data Structures (APIBLUEPRINT_V300 - APIBLUEPRINT_V499)
- Miscellaneous (APIBLUEPRINT_V500 - APIBLUEPRINT_V999)
Basic Structure Rules
- no-tab-indentation (APIBLUEPRINT_V001)
- required-metadata-format (APIBLUEPRINT_V002)
- valid-metadata-format (APIBLUEPRINT_V003)
- no-large-payload (APIBLUEPRINT_V004)
- valid-apiary-file (APIBLUEPRINT_V005)
- valid-entity-type (APIBLUEPRINT_V006)
API Resources Rules
- no-request-body-in-resource-get-method (APIBLUEPRINT_V100)
- supported-response-code (APIBLUEPRINT_V101)