History

6543 d1353e1f7c Vendor Update (#14496 ) * update code.gitea.io/sdk/gitea v0.13.1 -> v0.13.2 * update github.com/go-swagger/go-swagger v0.25.0 -> v0.26.0 * update github.com/google/uuid v1.1.2 -> v1.2.0 * update github.com/klauspost/compress v1.11.3 -> v1.11.7 * update github.com/lib/pq 083382b7e6fc -> v1.9.0 * update github.com/markbates/goth v1.65.0 -> v1.66.1 * update github.com/mattn/go-sqlite3 v1.14.4 -> v1.14.6 * update github.com/mgechev/revive 246eac737dc7 -> v1.0.3 * update github.com/minio/minio-go/v7 v7.0.6 -> v7.0.7 * update github.com/niklasfasching/go-org v1.3.2 -> v1.4.0 * update github.com/olivere/elastic/v7 v7.0.21 -> v7.0.22 * update github.com/pquerna/otp v1.2.0 -> v1.3.0 * update github.com/xanzy/go-gitlab v0.39.0 -> v0.42.0 * update github.com/yuin/goldmark v1.2.1 -> v1.3.1		2021-01-28 17:56:38 +01:00
..
.editorconfig	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
.gitignore	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
.golangci.yml	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
.travis.yml	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
CODE_OF_CONDUCT.md	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
context.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
debug.go	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
default_validator.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
doc.go	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
example_validator.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
formats.go	[Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670 )	2020-09-01 10:01:23 -04:00
go.mod	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
go.sum	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
helpers.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
LICENSE	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
object_validator.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
options.go	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
README.md	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
result.go	[Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670 )	2020-09-01 10:01:23 -04:00
rexp.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
schema_messages.go	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
schema_option.go	[Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670 )	2020-09-01 10:01:23 -04:00
schema_props.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
schema.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
slice_validator.go	[Vendor] update go-swagger v0.21.0 -> v0.25.0 (#12670 )	2020-09-01 10:01:23 -04:00
spec_messages.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
spec.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
type.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
update-fixtures.sh	Use vendored go-swagger (#8087 )	2019-09-04 22:53:54 +03:00
validator.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00
values.go	Vendor Update (#14496 )	2021-01-28 17:56:38 +01:00

README.md

Validation helpers

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).
- Required, RequiredNumber, RequiredString
- ReadOnly
- UniqueItems, MaxItems, MinItems
- Enum, EnumCase
- Pattern, MinLength, MaxLength
- Minimum, Maximum, MultipleOf
- FormatOf

Documentation

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 relates the full story.

An early attempt to support Swagger 3 may be found at: https://github.com/go-openapi/spec3