github.com/googleapis/api-linter@v1.65.2/rules/aip0133/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 aip0133
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  	"github.com/jhump/protoreflect/desc/builder"
    25  	"github.com/stoewer/go-strcase"
    26  )
    27  
    28  // The create request message should not have unrecognized fields.
    29  var unknownFields = &lint.MessageRule{
    30  	Name:   lint.NewRuleName(133, "request-unknown-fields"),
    31  	OnlyIf: utils.IsCreateRequestMessage,
    32  	LintMessage: func(m *desc.MessageDescriptor) (problems []lint.Problem) {
    33  		resourceMsgName := getResourceMsgNameFromReq(m)
    34  
    35  		// Rule check: Establish that there are no unexpected fields.
    36  		allowedFields := map[string]*builder.FieldType{
    37  			"parent":        nil, // AIP-133
    38  			"request_id":    nil, // AIP-155
    39  			"validate_only": nil, // AIP-163
    40  			fmt.Sprintf("%s_id", strings.ToLower(strcase.SnakeCase(resourceMsgName))): nil,
    41  		}
    42  
    43  		for _, field := range m.GetFields() {
    44  			// Skip the check with the field that is the body.
    45  			if t := field.GetMessageType(); t != nil && t.GetName() == resourceMsgName {
    46  				continue
    47  			}
    48  			// Check the remaining fields.
    49  			if _, ok := allowedFields[string(field.GetName())]; !ok {
    50  				problems = append(problems, lint.Problem{
    51  					Message: fmt.Sprintf(
    52  						"Create RPCs must only contain fields explicitly described in AIPs, not %q.",
    53  						field.GetName(),
    54  					),
    55  					Descriptor: field,
    56  				})
    57  			}
    58  		}
    59  
    60  		return
    61  	},
    62  }