mirror of
https://github.com/moby/buildkit.git
synced 2026-11-06 05:16:45 +00:00
Tonis Tiigi
7281e97ffb
- github.com/Microsoft/hcsshim v0.15.0-rc.4 -> v0.15.0 - google.golang.org/grpc v1.84.0 -> v1.85.0 - golang.org/x/net v0.61.0 -> v0.62.0 - go.opentelemetry.io/otel v1.46.0 -> v1.47.0 - go.opentelemetry.io/contrib v0.71.0 -> v0.72.0 - github.com/prometheus/client_golang v1.24.1 -> v1.25.0 - github.com/prometheus/procfs v0.21.1 -> v0.22.0 - github.com/go-openapi/* to moby versions Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
90 lines
4.6 KiB
Go
90 lines
4.6 KiB
Go
// SPDX-FileCopyrightText: Copyright 2015-2025 go-swagger maintainers
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
// Package validate provides methods to validate a swagger specification,
|
|
// as well as tools to validate data against their schema.
|
|
//
|
|
// This package follows 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.
|
|
//
|
|
// # Validating a specification
|
|
//
|
|
// Validates a spec document (from JSON or YAML) against the JSON schema for swagger,
|
|
// then checks a number of extra rules that can't be expressed in JSON schema.
|
|
//
|
|
// The lists below hold the extra rules only. The meta-schema already settles a great deal on its
|
|
// own, and where it does, no rule is repeated here: collectionFormat, say, must be one of csv, ssv,
|
|
// tsv or pipes, widened with multi for a query or formData parameter, and a body parameter may not
|
|
// carry one at all — all of that comes out of the meta-schema, at every location it applies to.
|
|
//
|
|
// Entry points:
|
|
//
|
|
// - Spec()
|
|
// - [NewSpecValidator]()
|
|
// - [SpecValidator].Validate()
|
|
//
|
|
// Reported as errors:
|
|
//
|
|
// [x] definition can't declare a property that's already defined by one of its ancestors
|
|
// [x] definition's ancestor can't be a descendant of the same model
|
|
// [x] path uniqueness: each api path should be non-verbatim (account for path param names) unique per method. Validation can be laxed by disabling StrictPathParamUniqueness.
|
|
// [x] each security reference should contain only unique scopes
|
|
// [x] each security scope in a security definition should be unique
|
|
// [x] a discriminator must name a property the schema defines and lists as required
|
|
// [x] each security requirement must name a scheme declared in securityDefinitions
|
|
// [x] only an oauth2 security requirement may list scopes: every other scheme type must list none
|
|
// [x] parameters in path must be unique
|
|
// [x] each path parameter must correspond to a parameter placeholder and vice versa
|
|
// [x] each referenceable definition must have references
|
|
// [x] each definition property listed in the required array must be defined in the properties of the model
|
|
// [x] each parameter should have a unique `name` and `type` combination
|
|
// [x] each operation should have only 1 parameter of type body
|
|
// [x] each reference must point to a valid object
|
|
// [x] every default value that is specified must validate against the schema for that property
|
|
// [x] items property is required for all schemas/definitions of type `array`
|
|
// [x] path parameters must be declared a required
|
|
// [x] headers must not contain $ref
|
|
// [x] schema and property examples provided must validate against their respective object's schema
|
|
// [x] examples provided must validate their schema
|
|
//
|
|
// Reported as warnings:
|
|
//
|
|
// [x] path parameters should not contain any of [{,},\w]
|
|
// [x] empty path
|
|
// [x] unused definitions
|
|
// [x] unsupported validation of examples on non-JSON media types
|
|
// [x] examples in response without schema
|
|
// [x] readOnly properties should not be required
|
|
// [x] an oauth2 security requirement names a scope its security scheme does not declare
|
|
// [x] collectionFormat is written on a parameter, header or items whose type is not array
|
|
//
|
|
// # Validating a schema
|
|
//
|
|
// The schema validation toolkit validates data against JSON-schema-draft 04 schema.
|
|
//
|
|
// It is tested against the full json-schema-testing-suite (https://github.com/json-schema-org/JSON-Schema-Test-Suite),
|
|
// except for the optional part (bignum, ECMA regexp, ...).
|
|
//
|
|
// It supports the complete JSON-schema vocabulary, including keywords not supported by Swagger (e.g. additionalItems, ...)
|
|
//
|
|
// Entry points:
|
|
//
|
|
// - [AgainstSchema]()
|
|
// - ...
|
|
//
|
|
// # Known limitations
|
|
//
|
|
// With the current version of this package, the following aspects of swagger are not yet supported:
|
|
//
|
|
// [ ] errors and warnings are not reported with key/line number in spec
|
|
// [ ] default values and examples on responses only support application/json producer type
|
|
// [ ] invalid numeric constraints (such as Minimum, etc..) are not checked except for default and example values
|
|
// [ ] valid js ECMA regexp not supported by Go regexp engine are considered invalid
|
|
// [ ] arbitrary large numbers are not supported: max is math.MaxFloat64
|
|
//
|
|
// Left out by design, rather than pending: a discriminator value is not checked against the schema
|
|
// names it may take. That clause of the swagger rule constrains an instance rather than the
|
|
// document, so there is nothing in a specification for [SpecValidator] to read, and checking it
|
|
// would mean resolving polymorphic payloads, which this package does not do.
|
|
package validate
|