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

     1  // Copyright 2023 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  	"bitbucket.org/creachadair/stringset"
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  	"github.com/stoewer/go-strcase"
    26  )
    27  
    28  // The create request message should not have unrecognized fields.
    29  var requestRequiredFields = &lint.MethodRule{
    30  	Name:   lint.NewRuleName(133, "request-required-fields"),
    31  	OnlyIf: utils.IsCreateMethodWithResolvedReturnType,
    32  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    33  		ot := utils.GetResponseType(m)
    34  		r := utils.GetResource(ot)
    35  		resourceMsgName := utils.GetResourceSingular(r)
    36  
    37  		// Rule check: Establish that there are no unexpected fields.
    38  		allowedRequiredFields := stringset.New(
    39  			"parent",
    40  			fmt.Sprintf("%s_id", strings.ToLower(strcase.SnakeCase(resourceMsgName))),
    41  		)
    42  
    43  		problems := []lint.Problem{}
    44  		for _, f := range m.GetInputType().GetFields() {
    45  			if !utils.GetFieldBehavior(f).Contains("REQUIRED") {
    46  				continue
    47  			}
    48  			// Skip the check with the field that is the resource, which for
    49  			// Standard Create, is the output type.
    50  			if t := f.GetMessageType(); t != nil && t.GetName() == ot.GetName() {
    51  				continue
    52  			}
    53  			// Iterate remaining fields. If they're not in the allowed list,
    54  			// add a problem.
    55  			if !allowedRequiredFields.Contains(string(f.GetName())) {
    56  				problems = append(problems, lint.Problem{
    57  					Message:    fmt.Sprintf("Create RPCs must only require fields explicitly described in AIPs, not %q.", f.GetName()),
    58  					Descriptor: f,
    59  				})
    60  			}
    61  		}
    62  		return problems
    63  	},
    64  }