github.com/googleapis/api-linter@v1.65.2/rules/aip0158/response_unary.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/locations"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  var responseUnary = &lint.MethodRule{
    24  	Name:   lint.NewRuleName(158, "response-unary"),
    25  	OnlyIf: isPaginatedMethod,
    26  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    27  		if m.IsServerStreaming() {
    28  			return []lint.Problem{{
    29  				Message:    "Paginated responses must be unary, not streaming.",
    30  				Descriptor: m,
    31  				Location:   locations.MethodResponseType(m),
    32  			}}
    33  		}
    34  		return nil
    35  	},
    36  }