Add validation for the keywords dealing with JSON arrays.
We call the elements of an array its "items."
The unevaluatedItems keyword introduces some complexity. Its schema
applies to all items in the array that have not been successfully
validated ("evaluated" is the spec's misleading term) by this schema or
subschemas acting on the same array. The logic keywords like allOf and
anyOf thus contribute to the set of evaluated items.
Following the spec, we say that a schema produces "annotations" that
describe the items it has evaluated. The annotations type collects this
information. For the "contains" keyword we need to represent the set
of evaluated items, but for others we can optimize with an integer or
boolean. For example, the "items" keyword applies its schema to every
item in the array. If even one fails to validate, the array fails to
validate, and the validate call exits before reaching unevaluatedItems.
Therefore, if "items" succeeds, it has successfully validated every
item, so unevaluatedItems does not apply. A boolean annotation suffices
to record this fact.
The logic of "anyOf" must change so it can track all evaluated items.
It must still visit the remaining subschemas even after a subschema
succeeds.
Anticipating the next CL, which deals with JSON objects (maps), the
annotations struct supports properties as well as items.
Change-Id: I98283d36c9a55f4cae97636cbec20c4886daea11
Reviewed-on: https://go-review.googlesource.com/c/tools/+/668235
Reviewed-by: Alan Donovan <adonovan@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
72 lines
2.1 KiB
Go
72 lines
2.1 KiB
Go
// Copyright 2025 The Go MCP SDK Authors. All rights reserved.
|
|
// Use of this source code is governed by an MIT-style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package jsonschema
|
|
|
|
import "maps"
|
|
|
|
// An annotations tracks certain properties computed by keywords that are used by validation.
|
|
// ("Annotation" is the spec's term.)
|
|
// In particular, the unevaluatedItems and unevaluatedProperties keywords need to know which
|
|
// items and properties were evaluated (validated successfully).
|
|
type annotations struct {
|
|
allItems bool // all items were evaluated
|
|
endIndex int // 1+largest index evaluated by prefixItems
|
|
evaluatedIndexes map[int]bool // set of indexes evaluated by contains
|
|
evaluatedProperties map[string]bool // set of properties evaluated by various keywords
|
|
}
|
|
|
|
// noteIndex marks i as evaluated.
|
|
func (a *annotations) noteIndex(i int) {
|
|
if a.evaluatedIndexes == nil {
|
|
a.evaluatedIndexes = map[int]bool{}
|
|
}
|
|
a.evaluatedIndexes[i] = true
|
|
}
|
|
|
|
// noteEndIndex marks items with index less than end as evaluated.
|
|
func (a *annotations) noteEndIndex(end int) {
|
|
if end > a.endIndex {
|
|
a.endIndex = end
|
|
}
|
|
}
|
|
|
|
// noteProperty marks prop as evaluated.
|
|
func (a *annotations) noteProperty(prop string) {
|
|
if a.evaluatedProperties == nil {
|
|
a.evaluatedProperties = map[string]bool{}
|
|
}
|
|
a.evaluatedProperties[prop] = true
|
|
}
|
|
|
|
// noteProperties marks all the properties in props as evaluated.
|
|
func (a *annotations) noteProperties(props map[string]bool) {
|
|
a.evaluatedProperties = merge(a.evaluatedProperties, props)
|
|
}
|
|
|
|
// merge adds b's annotations to a.
|
|
// a must not be nil.
|
|
func (a *annotations) merge(b *annotations) {
|
|
if b == nil {
|
|
return
|
|
}
|
|
if b.allItems {
|
|
a.allItems = true
|
|
}
|
|
if b.endIndex > a.endIndex {
|
|
a.endIndex = b.endIndex
|
|
}
|
|
a.evaluatedIndexes = merge(a.evaluatedIndexes, b.evaluatedIndexes)
|
|
a.evaluatedProperties = merge(a.evaluatedProperties, b.evaluatedProperties)
|
|
}
|
|
|
|
// merge adds t's keys to s and returns s.
|
|
// If s is nil, it returns a copy of t.
|
|
func merge[K comparable](s, t map[K]bool) map[K]bool {
|
|
if s == nil {
|
|
return maps.Clone(t)
|
|
}
|
|
maps.Copy(s, t)
|
|
return s
|
|
}
|