github.com/googleapis/api-linter@v1.65.2/rules/aip0151/aip0151.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 aip0151 contains rules defined in https://aip.dev/151.
    16  package aip0151
    17  
    18  import (
    19  	"github.com/googleapis/api-linter/lint"
    20  	"github.com/googleapis/api-linter/rules/internal/utils"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  // AddRules adds all of the AIP-151 rules to the provided registry.
    25  func AddRules(r lint.RuleRegistry) error {
    26  	return r.Register(
    27  		151,
    28  		lroAnnotationExists,
    29  		lroMetadata,
    30  		lroMetadataReachable,
    31  		lroResponse,
    32  		lroResponseReachable,
    33  		responseUnary,
    34  	)
    35  }
    36  
    37  func isLRO(m *desc.MethodDescriptor) bool {
    38  	return m.GetOutputType().GetFullyQualifiedName() == "google.longrunning.Operation"
    39  }
    40  
    41  func isAnnotatedLRO(m *desc.MethodDescriptor) bool {
    42  	return isLRO(m) && utils.GetOperationInfo(m) != nil
    43  }