github.com/googleapis/api-linter@v1.65.2/rules/aip0132/request_field_types.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  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/rules/internal/utils"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  var knownFields = map[string]func(*desc.FieldDescriptor) []lint.Problem{
    24  	"filter":       utils.LintSingularStringField,
    25  	"order_by":     utils.LintSingularStringField,
    26  	"show_deleted": utils.LintSingularBoolField,
    27  }
    28  
    29  // List fields should have the correct type.
    30  var requestFieldTypes = &lint.FieldRule{
    31  	Name: lint.NewRuleName(132, "request-field-types"),
    32  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    33  		return utils.IsListRequestMessage(f.GetOwner()) && knownFields[f.GetName()] != nil
    34  	},
    35  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    36  		return knownFields[f.GetName()](f)
    37  	},
    38  }