github.com/googleapis/api-linter@v1.65.2/rules/aip0135/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 aip0135
    16  
    17  import (
    18  	"fmt"
    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  // Delete methods should not have unrecognized fields.
    26  var unknownFields = &lint.MessageRule{
    27  	Name:   lint.NewRuleName(135, "request-unknown-fields"),
    28  	OnlyIf: utils.IsDeleteRequestMessage,
    29  	LintMessage: func(m *desc.MessageDescriptor) (problems []lint.Problem) {
    30  		// Rule check: Establish that there are no unexpected fields.
    31  		allowedFields := map[string]struct{}{
    32  			"name":          {}, // AIP-135
    33  			"force":         {}, // AIP-135
    34  			"allow_missing": {}, // AIP-135
    35  			"etag":          {}, // AIP-154
    36  			"request_id":    {}, // AIP-155
    37  			"validate_only": {}, // AIP-163
    38  		}
    39  		for _, field := range m.GetFields() {
    40  			if _, ok := allowedFields[string(field.GetName())]; !ok {
    41  				problems = append(problems, lint.Problem{
    42  					Message: fmt.Sprintf(
    43  						"Unexpected field: Delete RPCs must only contain fields explicitly described in AIPs, not %q.",
    44  						string(field.GetName()),
    45  					),
    46  					Descriptor: field,
    47  				})
    48  			}
    49  		}
    50  
    51  		return
    52  	},
    53  }