github.com/googleapis/api-linter@v1.65.2/rules/aip0151/lro_metadata_type.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
    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 lroMetadata = &lint.MethodRule{
    25  	Name:   lint.NewRuleName(151, "lro-metadata-type"),
    26  	OnlyIf: isAnnotatedLRO,
    27  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    28  		lro := utils.GetOperationInfo(m)
    29  
    30  		// Ensure the response type is set.
    31  		if lro.GetMetadataType() == "" {
    32  			return []lint.Problem{{
    33  				Message:    "Methods returning an LRO must set the metadata type.",
    34  				Descriptor: m,
    35  				Location:   locations.MethodOperationInfo(m),
    36  			}}
    37  		}
    38  
    39  		// The netadata type should not be Empty.
    40  		if t := lro.GetMetadataType(); t == "Empty" || t == "google.protobuf.Empty" {
    41  			return []lint.Problem{{
    42  				Message:    "Methods returning an LRO should create a blank message rather than using Empty.",
    43  				Descriptor: m,
    44  				Location:   locations.MethodOperationInfo(m),
    45  			}}
    46  		}
    47  
    48  		return nil
    49  	},
    50  }