gitea/vendor/github.com/go-openapi/validate
2021-02-28 18:08:33 -05: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
appveyor.yml go1.16 (#14783) 2021-02-28 18:08:33 -05: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 go1.16 (#14783) 2021-02-28 18:08:33 -05:00
go.sum go1.16 (#14783) 2021-02-28 18:08:33 -05: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 go1.16 (#14783) 2021-02-28 18:08:33 -05: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

Validation helpers

Build Status
Build status
codecov
Slack Status
license
Go Reference
Go Report Card

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