github.com/googleapis/api-linter@v1.65.2/rules/aip0131/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 aip0131
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"bitbucket.org/creachadair/stringset"
    21  
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  )
    26  
    27  var allowedFields = stringset.New(
    28  	"name",       // AIP-131
    29  	"request_id", // AIP-155
    30  	"read_mask",  // AIP-157
    31  	"view",       // AIP-157
    32  )
    33  
    34  // Get methods should not have unrecognized fields.
    35  var unknownFields = &lint.FieldRule{
    36  	Name: lint.NewRuleName(131, "request-unknown-fields"),
    37  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    38  		return utils.IsGetRequestMessage(f.GetOwner())
    39  	},
    40  	LintField: func(field *desc.FieldDescriptor) []lint.Problem {
    41  		if !allowedFields.Contains(field.GetName()) {
    42  			return []lint.Problem{{
    43  				Message: fmt.Sprintf(
    44  					"Unexpected field: Get RPCs must only contain fields explicitly described in https://aip.dev/131, not %q.",
    45  					string(field.GetName()),
    46  				),
    47  				Descriptor: field,
    48  			}}
    49  		}
    50  
    51  		return nil
    52  	},
    53  }