github.com/googleapis/api-linter@v1.65.2/rules/aip0127/http_annotation.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 aip0127
    16  
    17  import (
    18  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/locations"
    20  	"github.com/googleapis/api-linter/rules/internal/utils"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  var hasAnnotation = &lint.MethodRule{
    25  	Name: lint.NewRuleName(127, "http-annotation"),
    26  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    27  		hasHTTPRule := len(utils.GetHTTPRules(m)) > 0
    28  		if hasHTTPRule && m.IsClientStreaming() && m.IsServerStreaming() {
    29  			return []lint.Problem{{
    30  				Message:    "Bi-directional streaming RPCs should omit `google.api.http`.",
    31  				Descriptor: m,
    32  				Location:   locations.MethodHTTPRule(m),
    33  			}}
    34  		}
    35  		if !hasHTTPRule && !(m.IsClientStreaming() && m.IsServerStreaming()) {
    36  			return []lint.Problem{{
    37  				Message:    "RPCs must include HTTP definitions using the `google.api.http` annotation.",
    38  				Descriptor: m,
    39  			}}
    40  		}
    41  		return nil
    42  	},
    43  }