mirror of
https://github.com/moby/moby.git
synced 2026-08-08 17:11:38 +00:00
123 lines
5.2 KiB
Markdown
123 lines
5.2 KiB
Markdown
# validate
|
|
|
|
<!-- Badges: status -->
|
|
[![Tests][test-badge]][test-url] [![Coverage][cov-badge]][cov-url] [![CI vuln scan][vuln-scan-badge]][vuln-scan-url] [![CodeQL][codeql-badge]][codeql-url]
|
|
<!-- Badges: release & docker images -->
|
|
<!-- Badges: code quality -->
|
|
<!-- Badges: license & compliance -->
|
|
[![Release][release-badge]][release-url] [![Go Report Card][gocard-badge]][gocard-url] [![CodeFactor Grade][codefactor-badge]][codefactor-url] [![License][license-badge]][license-url]
|
|
<!-- Badges: documentation & support -->
|
|
<!-- Badges: others & stats -->
|
|
[![GoDoc][godoc-badge]][godoc-url] [![Discord Channel][discord-badge]][discord-url] [![go version][goversion-badge]][goversion-url] ![Top language][top-badge] ![Commits since latest release][commits-badge]
|
|
|
|
---
|
|
|
|
A validator for OpenAPI v2 specifications and JSON schema draft 4.
|
|
|
|
## Announcements
|
|
|
|
* **2025-12-19** : new community chat on discord
|
|
* a new discord community channel is available to be notified of changes and support users
|
|
|
|
You may join the discord community by clicking the invite link on the discord badge (also above). [![Discord Channel][discord-badge]][discord-url]
|
|
|
|
## Status
|
|
|
|
API is stable.
|
|
|
|
## Import this library in your project
|
|
|
|
```cmd
|
|
go get github.com/go-openapi/validate
|
|
```
|
|
|
|
## Contents
|
|
|
|
This package provides helpers to validate Swagger 2.0. specification (aka OpenAPI 2.0).
|
|
|
|
* 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
|
|
|
|
### 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>
|
|
|
|
## Change log
|
|
|
|
See <https://github.com/go-openapi/validate/releases>
|
|
|
|
## References
|
|
|
|
<https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>
|
|
|
|
## Licensing
|
|
|
|
This library ships under the [SPDX-License-Identifier: Apache-2.0](./LICENSE).
|
|
|
|
## Other documentation
|
|
|
|
* [All-time contributors](./CONTRIBUTORS.md)
|
|
* [Contributing guidelines][contributing-doc-site]
|
|
* [Maintainers documentation][maintainers-doc-site]
|
|
* [Code style][style-doc-site]
|
|
|
|
## Cutting a new release
|
|
|
|
Maintainers can cut a new release by either:
|
|
|
|
* running [this workflow](https://github.com/go-openapi/validate/actions/workflows/bump-release.yml)
|
|
* or pushing a semver tag
|
|
* signed tags are preferred
|
|
* The tag message is prepended to release notes
|
|
|
|
<!-- Badges: status -->
|
|
[test-badge]: https://github.com/go-openapi/validate/actions/workflows/go-test.yml/badge.svg
|
|
[test-url]: https://github.com/go-openapi/validate/actions/workflows/go-test.yml
|
|
[cov-badge]: https://codecov.io/gh/go-openapi/validate/branch/master/graph/badge.svg
|
|
[cov-url]: https://codecov.io/gh/go-openapi/validate
|
|
[vuln-scan-badge]: https://github.com/go-openapi/validate/actions/workflows/scanner.yml/badge.svg
|
|
[vuln-scan-url]: https://github.com/go-openapi/validate/actions/workflows/scanner.yml
|
|
[codeql-badge]: https://github.com/go-openapi/validate/actions/workflows/codeql.yml/badge.svg
|
|
[codeql-url]: https://github.com/go-openapi/validate/actions/workflows/codeql.yml
|
|
<!-- Badges: release & docker images -->
|
|
[release-badge]: https://badge.fury.io/gh/go-openapi%2Fvalidate.svg
|
|
[release-url]: https://badge.fury.io/gh/go-openapi%2Fvalidate
|
|
<!-- Badges: code quality -->
|
|
[gocard-badge]: https://goreportcard.com/badge/github.com/go-openapi/validate
|
|
[gocard-url]: https://goreportcard.com/report/github.com/go-openapi/validate
|
|
[codefactor-badge]: https://img.shields.io/codefactor/grade/github/go-openapi/validate
|
|
[codefactor-url]: https://www.codefactor.io/repository/github/go-openapi/validate
|
|
<!-- Badges: documentation & support -->
|
|
[godoc-badge]: https://pkg.go.dev/badge/github.com/go-openapi/validate
|
|
[godoc-url]: http://pkg.go.dev/github.com/go-openapi/validate
|
|
[discord-badge]: https://img.shields.io/discord/1446918742398341256?logo=discord&label=discord&color=blue
|
|
[discord-url]: https://discord.gg/FfnFYaC3k5
|
|
|
|
<!-- Badges: license & compliance -->
|
|
[license-badge]: http://img.shields.io/badge/license-Apache%20v2-orange.svg
|
|
[license-url]: https://github.com/go-openapi/validate/?tab=Apache-2.0-1-ov-file#readme
|
|
<!-- Badges: others & stats -->
|
|
[goversion-badge]: https://img.shields.io/github/go-mod/go-version/go-openapi/validate
|
|
[goversion-url]: https://github.com/go-openapi/validate/blob/master/go.mod
|
|
[top-badge]: https://img.shields.io/github/languages/top/go-openapi/validate
|
|
[commits-badge]: https://img.shields.io/github/commits-since/go-openapi/validate/latest
|
|
<!-- Organization docs -->
|
|
[contributing-doc-site]: https://go-openapi.github.io/doc-site/contributing/contributing/index.html
|
|
[maintainers-doc-site]: https://go-openapi.github.io/doc-site/maintainers/index.html
|
|
[style-doc-site]: https://go-openapi.github.io/doc-site/contributing/style/index.html
|