/
response_resource_field.go
55 lines (48 loc) · 1.93 KB
/
response_resource_field.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
// 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 aip0233
import (
"fmt"
"strings"
"github.com/gertd/go-pluralize"
"github.com/googleapis/api-linter/lint"
"github.com/jhump/protoreflect/desc"
)
// The Batch Create response message should have resource field.
var responseResourceField = &lint.MessageRule{
Name: lint.NewRuleName(233, "response-resource-field"),
OnlyIf: isBatchCreateResponseMessage,
LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
// the singular form the resource name, the first letter is Capitalized.
// Note: Retrieve the resource name from the the batch create response,
// for example: "BatchCreateBooksResponse" -> "Books"
resourceMsgName := pluralize.NewClient().Singular(strings.TrimPrefix(strings.TrimSuffix(m.GetName(), "Response"), "BatchCreate"))
for _, fieldDesc := range m.GetFields() {
if msgDesc := fieldDesc.GetMessageType(); msgDesc != nil && msgDesc.GetName() == resourceMsgName {
if !fieldDesc.IsRepeated() {
return []lint.Problem{{
Message: fmt.Sprintf("The %q type field on Batch Create Response message should be repeated", msgDesc.GetName()),
Descriptor: fieldDesc,
}}
}
return nil
}
}
// Rule check: Establish that a resource field must be included.
return []lint.Problem{{
Message: fmt.Sprintf("Message %q has no %q type field", m.GetName(), resourceMsgName),
Descriptor: m,
}}
},
}