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

     1  // Copyright 2021 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 aip0158
    16  
    17  import (
    18  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/locations"
    20  	"github.com/jhump/protoreflect/desc"
    21  	"github.com/jhump/protoreflect/desc/builder"
    22  )
    23  
    24  var requestSkipField = &lint.FieldRule{
    25  	Name: lint.NewRuleName(158, "request-skip-field"),
    26  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    27  		return isPaginatedRequestMessage(f.GetOwner()) && f.GetName() == "skip"
    28  	},
    29  	LintField: func(f *desc.FieldDescriptor) (problems []lint.Problem) {
    30  		// Rule check: Ensure that the name page_size is the correct type.
    31  		if f.GetType() != builder.FieldTypeInt32().GetType() || f.IsRepeated() {
    32  			return []lint.Problem{{
    33  				Message:    "`skip` field on List RPCs should be a singular int32",
    34  				Suggestion: "int32",
    35  				Descriptor: f,
    36  				Location:   locations.FieldType(f),
    37  			}}
    38  		}
    39  
    40  		return nil
    41  	},
    42  }