Swagger v1 Validation
Overview
Validation checks performed on the provided Swagger v1 file to check its conformance to rules set by APIMatic and the Swagger v1 official standards document.
Property | Value |
---|---|
Id | swagger-v1-validation |
Code | SWAGGER1_V |
Ruleset Type | Validation |
Default Severity of All Rules | Error |
Rule System | Semantic |
Tags | swagger1 swagger semantic validation |
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md
- https://docs.apimatic.io/rulesets/overview/
Categories of Rules
- Basic Structure (SWAGGER1_V001 - SWAGGER1_V049)
- Resource Listing (SWAGGER1_V050 - SWAGGER1_V099)
- Resources (SWAGGER1_V100 - SWAGGER1_V199)
- API Declaration (SWAGGER1_V200 - SWAGGER1_V299)
- Data Types (SWAGGER1_V300 - SWAGGER1_V399)
- Authorizations (SWAGGER1_V400 - SWAGGER1_V499)
- Operations (SWAGGER1_V500 - SWAGGER1_V599)
- Parameters (SWAGGER1_V600 - SWAGGER1_V699)
- Response Messages (SWAGGER1_V700 - SWAGGER1_V799)
- Miscellaneous (SWAGGER1_V800 - SWAGGER1_V999)
Basic Structure Rules
- required-swagger-version (SWAGGER1_V001)
- valid-swagger-version (SWAGGER1_V002)
- valid-swagger-syntax (SWAGGER1_V003)
Resource Listing Rules
- required-resource-listing-apis (SWAGGER1_V050)
- required-resource-listing-info (SWAGGER1_V051)
- required-resource-listing-info-title (SWAGGER1_V052)
- required-resource-listing-base-path (SWAGGER1_V053)
Resources Rules
API Declaration Rules
- required-api-declaration-apis (SWAGGER1_V200)
- required-api-declaration-base-path (SWAGGER1_V201)
- valid-api-declaration-base-path (SWAGGER1_V202)
Data Types Rules
Authorizations Rules
- required-authorization-type (SWAGGER1_V400)
- valid-authorization-type (SWAGGER1_V401)
- required-api-key-authorization-pass-as (SWAGGER1_V402)
- required-api-key-authorization-key-name (SWAGGER1_V403)
Operations Rules
- required-operation-nickname (SWAGGER1_V500)
- single-operation-body-parameter (SWAGGER1_V501)
- no-body-or-form-parameter-in-get-method-operation (SWAGGER1_V502)