github.com/googleapis/api-linter@v1.65.2/rules/aip0134/request_allow_missing_field.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 aip0134
    16  
    17  import (
    18  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/rules/internal/utils"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  var allowMissing = &lint.MessageRule{
    24  	Name: lint.NewRuleName(134, "request-allow-missing-field"),
    25  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    26  		if !utils.IsUpdateRequestMessage(m) {
    27  			return false
    28  		}
    29  		r := utils.DeclarativeFriendlyResource(m)
    30  		return r != nil && !utils.IsSingletonResource(r)
    31  	},
    32  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    33  		for _, field := range m.GetFields() {
    34  			if field.GetName() == "allow_missing" && utils.GetTypeName(field) == "bool" && !field.IsRepeated() {
    35  				return nil
    36  			}
    37  		}
    38  		return []lint.Problem{{
    39  			Descriptor: m,
    40  			Message:    "Update requests on declarative-friendly resources should include a singular `bool allow_missing` field.",
    41  		}}
    42  	},
    43  }