diff options
Diffstat (limited to 'vendor/github.com/go-openapi/validate/README.md')
| -rw-r--r-- | vendor/github.com/go-openapi/validate/README.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/vendor/github.com/go-openapi/validate/README.md b/vendor/github.com/go-openapi/validate/README.md new file mode 100644 index 000000000..ea2d68cb6 --- /dev/null +++ b/vendor/github.com/go-openapi/validate/README.md @@ -0,0 +1,38 @@ +# Validation helpers +[](https://travis-ci.org/go-openapi/validate) +[](https://ci.appveyor.com/project/fredbi/validate/branch/master) +[](https://codecov.io/gh/go-openapi/validate) +[](https://slackin.goswagger.io) +[](https://raw.githubusercontent.com/go-openapi/validate/master/LICENSE) +[](https://pkg.go.dev/github.com/go-openapi/validate) +[](https://goreportcard.com/report/github.com/go-openapi/validate) + +This package provides helpers to validate Swagger 2.0. specification (aka OpenAPI 2.0). + +Reference can be found here: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md. + +## What's inside? + +* A validator for Swagger specifications +* A validator for JSON schemas draft4 +* Helper functions to validate individual values (used by code generated by [go-swagger](https://github.com/go-swagger/go-swagger)). + * Required, RequiredNumber, RequiredString + * ReadOnly + * UniqueItems, MaxItems, MinItems + * Enum, EnumCase + * Pattern, MinLength, MaxLength + * Minimum, Maximum, MultipleOf + * FormatOf + +[Documentation](https://godoc.org/github.com/go-openapi/validate) + +## FAQ + +* Does this library support OpenAPI 3? + +> No. +> This package currently only supports OpenAPI 2.0 (aka Swagger 2.0). +> There is no plan to make it evolve toward supporting OpenAPI 3.x. +> This [discussion thread](https://github.com/go-openapi/spec/issues/21) relates the full story. +> +> An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3 |