forked from googleapis/api-linter
/
method_signature.go
55 lines (49 loc) · 1.63 KB
/
method_signature.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 aip0131
import (
"fmt"
"reflect"
"github.com/commure/api-linter/lint"
"github.com/commure/api-linter/locations"
"github.com/commure/api-linter/rules/internal/utils"
"github.com/jhump/protoreflect/desc"
)
var methodSignature = &lint.MethodRule{
Name: lint.NewRuleName(131, "method-signature"),
OnlyIf: isGetMethod,
LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
signatures := utils.GetMethodSignatures(m)
// Check if the signature is missing.
if len(signatures) == 0 {
return []lint.Problem{{
Message: fmt.Sprintf(
"Get methods should include `(google.api.method_signature) = %q`",
"resource_name",
),
Descriptor: m,
}}
}
// Check if the signature is wrong.
if !reflect.DeepEqual(signatures[0], []string{"resource_name"}) {
return []lint.Problem{{
Message: `The method signature for Get methods should be "resource_name".`,
Suggestion: `option (google.api.method_signature) = "resource_name";`,
Descriptor: m,
Location: locations.MethodSignature(m, 0),
}}
}
return nil
},
}