diff --git a/articles/modeling/openapi-validation.md b/articles/modeling/openapi-validation.md index bf67bc1..7d560ef 100644 --- a/articles/modeling/openapi-validation.md +++ b/articles/modeling/openapi-validation.md @@ -5,7 +5,6 @@ ## What OpenAPI validation is the process of verifying the underlying OpenAPI file syntax by making sure it conforms to the [OpenAPI Specification requirements](https://github.com/OAI/OpenAPI-Specification#the-openapi-specification) provided by the [OpenAPI Initiative](https://www.openapis.org/). Stoplight immediately validates any changes done to a spec to ensure they are in the correct format prior to being saved. - > Stoplight currently supports the OpenAPI v2 specification. We are working on support for OpenAPI v3, and should have more information in the coming months. ## Why @@ -18,7 +17,6 @@ OpenAPI validation is the process of verifying the underlying OpenAPI file synta - Assign a default value to optional properties or parameters with missing values. The server will use the default value when a value is missing or not provided - You can use the keyword **ReadOnly** to designate a property that can be sent in a response and should not be sent in a request - > Using a default value is not recommended when a property or parameter is mandatory - An API can comsume different media types, the accepted media type can be specified using the **consume** keyword at the operational level or root level to define acceptable media types. For example: @@ -33,6 +31,6 @@ application/json - An HTTP response containing a user friendly error description is useful when validation fails *** -**Related** +**Related Articles** * [File Validation](../editor/file-validation.md)