github.com/googleapis/api-linter@v1.65.2/rules/aip0163/declarative_friendly_required.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 aip0163
    16  
    17  import (
    18  	"strings"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/utils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  var declarativeFriendlyRequired = &lint.MessageRule{
    26  	Name: lint.NewRuleName(163, "declarative-friendly-required"),
    27  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    28  		// We only want to look at request methods, not the resources themselves.
    29  		if name := m.GetName(); strings.HasSuffix(name, "Request") && utils.IsDeclarativeFriendlyMessage(m) {
    30  			// If the corresponding method is a GET method, it does not need
    31  			// validate_only.
    32  			method := utils.FindMethod(m.GetFile(), strings.TrimSuffix(name, "Request"))
    33  			for _, http := range utils.GetHTTPRules(method) {
    34  				if http.Method == "GET" {
    35  					return false
    36  				}
    37  			}
    38  			return true
    39  		}
    40  		return false
    41  	},
    42  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    43  		if vo := m.FindFieldByName("validate_only"); vo == nil || utils.GetTypeName(vo) != "bool" || vo.IsRepeated() {
    44  			return []lint.Problem{{
    45  				Message:    "Declarative-friendly mutate requests should include a singular `bool validate_only` field.",
    46  				Descriptor: m,
    47  			}}
    48  		}
    49  		return nil
    50  	},
    51  }