github.com/googleapis/api-linter@v1.65.2/rules/aip0135/response_lro.go (about)

     1  // Copyright 2020 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 aip0135
    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 responseLRO = &lint.MethodRule{
    25  	Name: lint.NewRuleName(135, "response-lro"),
    26  	OnlyIf: func(m *desc.MethodDescriptor) bool {
    27  		return utils.IsDeleteMethod(m) && utils.IsDeclarativeFriendlyMethod(m)
    28  	},
    29  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    30  		if !utils.IsOperation(m.GetOutputType()) {
    31  			return []lint.Problem{{
    32  				Message:    "Declarative-friendly delete methods should use an LRO.",
    33  				Descriptor: m,
    34  				Location:   locations.MethodResponseType(m),
    35  				Suggestion: "google.longrunning.Operation",
    36  			}}
    37  		}
    38  		return nil
    39  	},
    40  }