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