-
Notifications
You must be signed in to change notification settings - Fork 138
/
request_unknown_fields.go
54 lines (49 loc) · 1.73 KB
/
request_unknown_fields.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
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package aip0132
import (
"bitbucket.org/creachadair/stringset"
"github.com/googleapis/api-linter/lint"
"github.com/googleapis/api-linter/rules/internal/utils"
"github.com/jhump/protoreflect/desc"
)
var allowedFields = stringset.New(
"parent", // AIP-132
"page_size", // AIP-158
"page_token", // AIP-158
"skip", // AIP-158
"filter", // AIP-132
"order_by", // AIP-132
"show_deleted", // AIP-135
"request_id", // AIP-155
"read_mask", // AIP-157
"view", // AIP-157
"return_partial_success", // AIP-217
)
// List methods should not have unrecognized fields.
var unknownFields = &lint.FieldRule{
Name: lint.NewRuleName(132, "request-unknown-fields"),
OnlyIf: func(f *desc.FieldDescriptor) bool {
return utils.IsListRequestMessage(f.GetOwner())
},
LintField: func(field *desc.FieldDescriptor) []lint.Problem {
if !allowedFields.Contains(field.GetName()) {
return []lint.Problem{{
Message: "List RPCs should only contain fields explicitly described in AIPs.",
Descriptor: field,
}}
}
return nil
},
}