github.com/googleapis/api-linter@v1.65.2/rules/aip0133/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 aip0133
    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(133, "method-signature"),
    31  	OnlyIf: utils.IsCreateMethod,
    32  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    33  		signatures := utils.GetMethodSignatures(m)
    34  
    35  		// Determine what signature we want. The {resource}_id is desired
    36  		// if and only if the field exists on the request.
    37  		resourceField := strcase.SnakeCase(utils.GetResourceMessageName(m, "Create"))
    38  		want := []string{}
    39  		if !hasNoParent(m.GetOutputType()) {
    40  			want = append(want, "parent")
    41  		}
    42  		want = append(want, resourceField)
    43  		if idField := resourceField + "_id"; m.GetInputType().FindFieldByName(idField) != nil {
    44  			want = append(want, idField)
    45  		}
    46  
    47  		// Check if the signature is missing.
    48  		if len(signatures) == 0 {
    49  			return []lint.Problem{{
    50  				Message: fmt.Sprintf(
    51  					"Create methods should include `(google.api.method_signature) = %q`",
    52  					strings.Join(want, ","),
    53  				),
    54  				Descriptor: m,
    55  			}}
    56  		}
    57  
    58  		// Check if the signature is wrong.
    59  		if !reflect.DeepEqual(signatures[0], want) {
    60  			return []lint.Problem{{
    61  				Message: fmt.Sprintf(
    62  					"The method signature for Create methods should be %q.",
    63  					strings.Join(want, ","),
    64  				),
    65  				Suggestion: fmt.Sprintf(
    66  					"option (google.api.method_signature) = %q;",
    67  					strings.Join(want, ","),
    68  				),
    69  				Descriptor: m,
    70  				Location:   locations.MethodSignature(m, 0),
    71  			}}
    72  		}
    73  		return nil
    74  	},
    75  }