github.com/googleapis/api-linter@v1.65.2/rules/aip0158/request_page_token_field.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 aip0158
    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 requestPaginationPageToken = &lint.MessageRule{
    24  	Name:   lint.NewRuleName(158, "request-page-token-field"),
    25  	OnlyIf: isPaginatedRequestMessage,
    26  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    27  		f, problems := utils.LintFieldPresent(m, "page_token")
    28  		if len(problems) > 0 {
    29  			return problems
    30  		}
    31  		// Checks that page_size is of type string and is not a oneof. These are
    32  		// noops if page_size is not a oneof and is a string.
    33  		problems = append(problems, utils.LintSingularStringField(f)...)
    34  		problems = append(problems, utils.LintNotOneof(f)...)
    35  
    36  		return problems
    37  	},
    38  }