| Request & Response Validation |
Checking if a request body or response includes an example. |
If a request body is defined in a POST method, this validation checks if an example is provided. |
| Checking if a request body or response includes a schema. |
For a GET method response, this validation checks if a schema is defined for the data being returned. |
| Checking if the example follows the defined schema. |
If a schema is defined for a request body in a POST method, this validation checks if the provided example adheres to the defined schema. |
| Schema Validation |
Checking for the presence of an example for each property. |
For a property 'name' in the schema, this validation checks if an example is provided. |
| Checking if the property example adheres to the schema. |
If a property 'age' in the schema is defined as an integer, this validation checks if the provided example is indeed an integer. |
| Enum Check |
For a property 'status' with defined enum values ['active', 'inactive', 'pending'], this validation checks if the provided example is one of these values. |
| Maximum Length Check |
For a property 'description' with a defined maximum length of 200, this validation checks if the provided example doesn't exceed this length. |
| Path Parameter Validation |
Checking if a defined path parameter is used in the path. |
If a path parameter '{userId}' is defined, this validation checks if it is actually used in the path '/users/{userId}'. |
| Checking if a path parameter is defined for each path variable. |
For a path '/users/{userId}', this validation checks if a path parameter 'userId' is defined. |
| Nullable Property Validation |
Checking if null examples are used for non-nullable properties. |
If a property 'name' is defined as non-nullable, this validation checks if the provided example isn't null. |
| Data Type Validation |
Checks if the data type of a value aligns with the schema definition. |
If schema type is string, the input value should not be an integer like 10. |
| Default Value Validation |
Checks if the provided default values adhere to the defined schema. |
If a property is defined to be of type boolean and the default value is "true" (a string), it would fail this validation. |
| Min/Max Value Validation |
Checks if a numerical property falls within the defined minimum and maximum limits. |
If a property is defined with a minimum value 10 and maximum value 20, a value of 25 would fail this validation. |
| Format Validation |
Checks if the data adheres to the defined formats, like date or email. |
If a property is defined with a format of email, a value like "not an email" would fail this validation. |
| Array Item Schema Validation |
Checks if the items in an array adhere to the defined schema. |
If an array's items are defined to be of type string, an array like [1, 2, 3] would fail this validation. |
| Reference Validation ($ref) |
Checks if all $ref references point to a valid location. |
If a property refers to another schema using $ref, this validation checks whether the reference points to a valid schema. |