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

     1  // Copyright 2021 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 aip4232
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // Only the last field in a method signature can be repeated.
    27  var repeatedFields = &lint.MethodRule{
    28  	Name:   lint.NewRuleName(4232, "repeated-fields"),
    29  	OnlyIf: hasMethodSignatures,
    30  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    31  		var problems []lint.Problem
    32  		sigs := utils.GetMethodSignatures(m)
    33  		in := m.GetInputType()
    34  
    35  		for _, sig := range sigs {
    36  			for _, name := range sig {
    37  				if !strings.Contains(name, ".") {
    38  					continue
    39  				}
    40  				chain := strings.Split(name, ".")
    41  
    42  				// Exclude the last one from the look up since it can be repeated.
    43  				for i := range chain[:len(chain)-1] {
    44  					n := strings.Join(chain[:i+1], ".")
    45  					if f := utils.FindFieldDotNotation(in, n); f != nil && f.IsRepeated() {
    46  						problems = append(problems, lint.Problem{
    47  							Message:    fmt.Sprintf("Field %q in method_signature %q: only the last field in a signature argument can be repeated.", name, strings.Join(sig, ",")),
    48  							Descriptor: m,
    49  						})
    50  					}
    51  				}
    52  			}
    53  		}
    54  
    55  		return problems
    56  	},
    57  }