github.com/googleapis/api-linter@v1.65.2/rules/aip0131/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 aip0131
    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  // The get request message should not have unrecognized fields.
    27  var requestRequiredFields = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(131, "request-required-fields"),
    29  	OnlyIf: utils.IsGetRequestMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) (problems []lint.Problem) {
    31  		// Rule check: Establish that there are no unexpected fields.
    32  		allowedRequiredFields := stringset.New("name")
    33  
    34  		for _, f := range m.GetFields() {
    35  			if !utils.GetFieldBehavior(f).Contains("REQUIRED") {
    36  				continue
    37  			}
    38  			// add a problem.
    39  			if !allowedRequiredFields.Contains(string(f.GetName())) {
    40  				problems = append(problems, lint.Problem{
    41  					Message:    fmt.Sprintf("Get RPCs must only require fields explicitly described in AIPs, not %q.", f.GetName()),
    42  					Descriptor: f,
    43  				})
    44  			}
    45  		}
    46  
    47  		return problems
    48  	},
    49  }