github.com/googleapis/api-linter@v1.65.2/rules/aip0234/request_unknown_fields.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 aip0234
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"bitbucket.org/creachadair/stringset"
    21  
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // Batch Update methods should not have unrecognized fields.
    27  var requestUnknownFields = &lint.FieldRule{
    28  	Name: lint.NewRuleName(234, "request-unknown-fields"),
    29  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    30  		return isBatchUpdateRequestMessage(f.GetOwner())
    31  	},
    32  	LintField: func(field *desc.FieldDescriptor) []lint.Problem {
    33  		allowedFields := stringset.New(
    34  			"allow_missing", // AIP-134
    35  			"parent",        // AIP-234
    36  			"request_id",    // AIP-155
    37  			"requests",      // AIP-234
    38  			"update_mask",   // AIP-134
    39  			"validate_only", // AIP-163
    40  		)
    41  		if !allowedFields.Contains(field.GetName()) {
    42  			return []lint.Problem{{
    43  				Message: fmt.Sprintf(
    44  					"Unexpected field: Batch Update RPCs must only contain fields explicitly described in https://aip.dev/234, not %q.",
    45  					string(field.GetName()),
    46  				),
    47  				Descriptor: field,
    48  			}}
    49  		}
    50  
    51  		return nil
    52  	},
    53  }