-
-
Notifications
You must be signed in to change notification settings - Fork 39
/
oas2_discriminator.go
97 lines (78 loc) · 2.8 KB
/
oas2_discriminator.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
// Copyright 2022 Dave Shanley / Quobix
// SPDX-License-Identifier: MIT
package openapi
import (
"fmt"
"github.com/daveshanley/vacuum/model"
vacuumUtils "github.com/daveshanley/vacuum/utils"
"github.com/pb33f/libopenapi/utils"
"gopkg.in/yaml.v3"
)
// OAS2Discriminator checks swagger schemas are using discriminators properly.
type OAS2Discriminator struct{}
// GetCategory returns the category of the OperationSingleTag rule.
func (od OAS2Discriminator) GetCategory() string {
return model.FunctionCategoryOpenAPI
}
// GetSchema returns a model.RuleFunctionSchema defining the schema of the OperationSingleTag rule.
func (od OAS2Discriminator) GetSchema() model.RuleFunctionSchema {
return model.RuleFunctionSchema{
Name: "oasDiscriminator",
}
}
// RunRule will execute the OperationSingleTag rule, based on supplied context and a supplied []*yaml.Node slice.
func (od OAS2Discriminator) RunRule(nodes []*yaml.Node, context model.RuleFunctionContext) []model.RuleFunctionResult {
if len(nodes) <= 0 {
return nil
}
var results []model.RuleFunctionResult
schemas := context.Index.GetAllComponentSchemas()
for id, schema := range schemas {
discriminator, dv := utils.FindKeyNode("discriminator", schema.Node.Content)
if discriminator != nil {
// swagger needs this to be a string, openapi wants a map.
_, path := utils.ConvertComponentIdIntoPath(id)
if !utils.IsNodeStringValue(dv) {
results = append(results, model.RuleFunctionResult{
Message: fmt.Sprintf("the schema '%s' uses a non string discriminator", id),
StartNode: discriminator,
EndNode: vacuumUtils.BuildEndNode(dv),
Path: path,
Rule: context.Rule,
})
}
// if there is a discriminator, required must be set and contain the discriminator.
required, rv := utils.FindKeyNode("required", schema.Node.Content)
if required == nil {
// you can't use a discriminator without 'required' being set in the schema.
results = append(results, model.RuleFunctionResult{
Message: fmt.Sprintf("schema '%s' uses a discriminator but has no "+
"'required' property set", id),
StartNode: discriminator,
EndNode: vacuumUtils.BuildEndNode(dv),
Path: path,
Rule: context.Rule,
})
continue // no point going on.
}
reqFound := false
for _, req := range rv.Content {
if req.Value == dv.Value {
reqFound = true
}
}
if !reqFound {
// required values for schema did not contain discriminator
results = append(results, model.RuleFunctionResult{
Message: fmt.Sprintf("schema '%s' uses a discriminator but is not "+
"included in 'required' properties", id),
StartNode: discriminator,
EndNode: vacuumUtils.BuildEndNode(dv),
Path: path,
Rule: context.Rule,
})
}
}
}
return results
}