github.com/googleapis/api-linter@v1.65.2/rules/aip0131/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 aip0131
    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(131, "method-signature"),
    29  	OnlyIf: utils.IsGetMethod,
    30  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    31  		signatures := utils.GetMethodSignatures(m)
    32  
    33  		// Check if the signature is missing.
    34  		if len(signatures) == 0 {
    35  			return []lint.Problem{{
    36  				Message: fmt.Sprintf(
    37  					"Get methods should include `(google.api.method_signature) = %q`",
    38  					"name",
    39  				),
    40  				Descriptor: m,
    41  			}}
    42  		}
    43  
    44  		// Check if the signature is wrong.
    45  		if !reflect.DeepEqual(signatures[0], []string{"name"}) {
    46  			return []lint.Problem{{
    47  				Message:    `The method signature for Get methods should be "name".`,
    48  				Suggestion: `option (google.api.method_signature) = "name";`,
    49  				Descriptor: m,
    50  				Location:   locations.MethodSignature(m, 0),
    51  			}}
    52  		}
    53  		return nil
    54  	},
    55  }