github.com/googleapis/api-linter@v1.65.2/rules/aip0134/method_signature.go (about)

     1  // Copyright 2019 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0134
    16  
    17  import (
    18  	"fmt"
    19  	"reflect"
    20  	"strings"
    21  
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/googleapis/api-linter/locations"
    24  	"github.com/googleapis/api-linter/rules/internal/utils"
    25  	"github.com/jhump/protoreflect/desc"
    26  	"github.com/stoewer/go-strcase"
    27  )
    28  
    29  var methodSignature = &lint.MethodRule{
    30  	Name:   lint.NewRuleName(134, "method-signature"),
    31  	OnlyIf: utils.IsUpdateMethod,
    32  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    33  		signatures := utils.GetMethodSignatures(m)
    34  		want := []string{
    35  			strcase.SnakeCase(strings.TrimPrefix(m.GetName(), "Update")),
    36  			"update_mask",
    37  		}
    38  
    39  		// Check if the signature is missing.
    40  		if len(signatures) == 0 {
    41  			return []lint.Problem{{
    42  				Message: fmt.Sprintf(
    43  					"Update methods should include `(google.api.method_signature) = %q`",
    44  					strings.Join(want, ","),
    45  				),
    46  				Descriptor: m,
    47  			}}
    48  		}
    49  
    50  		// Check if the signature is wrong.
    51  		if !reflect.DeepEqual(signatures[0], want) {
    52  			return []lint.Problem{{
    53  				Message: fmt.Sprintf(
    54  					"The method signature for Update methods should be %q.",
    55  					strings.Join(want, ","),
    56  				),
    57  				Suggestion: fmt.Sprintf(
    58  					"option (google.api.method_signature) = %q;",
    59  					strings.Join(want, ","),
    60  				),
    61  				Descriptor: m,
    62  				Location:   locations.MethodSignature(m, 0),
    63  			}}
    64  		}
    65  		return nil
    66  	},
    67  }