github.com/googleapis/api-linter@v1.65.2/rules/aip0132/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 aip0132
    16  
    17  import (
    18  	"fmt"
    19  	"reflect"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  )
    26  
    27  var methodSignature = &lint.MethodRule{
    28  	Name: lint.NewRuleName(132, "method-signature"),
    29  	OnlyIf: func(m *desc.MethodDescriptor) bool {
    30  		return utils.IsListMethod(m) && m.GetInputType().FindFieldByName("parent") != nil
    31  	},
    32  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    33  		signatures := utils.GetMethodSignatures(m)
    34  
    35  		// Check if the signature is missing.
    36  		if len(signatures) == 0 {
    37  			return []lint.Problem{{
    38  				Message: fmt.Sprintf(
    39  					"List methods should include `(google.api.method_signature) = %q`",
    40  					"parent",
    41  				),
    42  				Descriptor: m,
    43  			}}
    44  		}
    45  
    46  		// Check if the signature is wrong.
    47  		if !reflect.DeepEqual(signatures[0], []string{"parent"}) {
    48  			return []lint.Problem{{
    49  				Message:    `The method signature for List methods should be "parent".`,
    50  				Suggestion: `option (google.api.method_signature) = "parent";`,
    51  				Descriptor: m,
    52  				Location:   locations.MethodSignature(m, 0),
    53  			}}
    54  		}
    55  		return nil
    56  	},
    57  }