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

     1  // Copyright 2019 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  	"fmt"
    19  
    20  	"bitbucket.org/creachadair/stringset"
    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  // Update methods should not have unrecognized fields.
    27  var unknownFields = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(134, "request-unknown-fields"),
    29  	OnlyIf: utils.IsUpdateRequestMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) (problems []lint.Problem) {
    31  		resource := extractResource(m.GetName())
    32  		// Rule check: Establish that there are no unexpected fields.
    33  		allowedFields := stringset.New(
    34  			fieldNameFromResource(resource), // AIP-134
    35  			"allow_missing",                 // AIP-134
    36  			"request_id",                    // AIP-155
    37  			"update_mask",                   // AIP-134
    38  			"validate_only",                 // AIP-163
    39  		)
    40  		for _, field := range m.GetFields() {
    41  			if !allowedFields.Contains(field.GetName()) {
    42  				problems = append(problems, lint.Problem{
    43  					Message: fmt.Sprintf(
    44  						"Unexpected field: Update RPCs must only contain fields explicitly described in AIPs, not %q.",
    45  						field.GetName(),
    46  					),
    47  					Descriptor: field,
    48  				})
    49  			}
    50  		}
    51  
    52  		return
    53  	},
    54  }