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

     1  // Copyright 2020 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 aip0154
    16  
    17  import (
    18  	"strings"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  var noDuplicateEtag = &lint.FieldRule{
    25  	Name: lint.NewRuleName(154, "no-duplicate-etag"),
    26  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    27  		return f.GetName() == "etag" && strings.HasSuffix(f.GetOwner().GetName(), "Request")
    28  	},
    29  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    30  		for _, otherField := range f.GetOwner().GetFields() {
    31  			if m := otherField.GetMessageType(); m != nil {
    32  				// if strings.Contains("UpdateBookRequest", "Book")
    33  				//
    34  				// If this is a random, unrelated (not the resource) message, we want to ignore it.
    35  				// Ditto for *other* resources, which could be relevant for custom methods,
    36  				// which is why we do a string check and not a google.api.resource check.
    37  				if strings.Contains(f.GetOwner().GetName(), m.GetName()) && m.FindFieldByName("etag") != nil {
    38  					return []lint.Problem{{
    39  						Message:    "Request messages that include the resource should omit etag.",
    40  						Descriptor: f,
    41  						Suggestion: "",
    42  					}}
    43  				}
    44  			}
    45  		}
    46  		return nil
    47  	},
    48  }