forgejo/vendor/github.com/go-openapi/validate/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