github.com/googleapis/api-linter@v1.65.2/rules/aip0164/response_message_name.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 aip0164
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/googleapis/api-linter/rules/internal/utils"
    24  	"github.com/jhump/protoreflect/desc"
    25  )
    26  
    27  // Undelete messages should use google.longrunning.Operation
    28  // or the resource itself as the response message.
    29  var responseMessageName = &lint.MethodRule{
    30  	Name:   lint.NewRuleName(164, "response-message-name"),
    31  	OnlyIf: isUndeleteMethod,
    32  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    33  		// Rule check: Establish that for methods such as `UndeleteFoo`, the response
    34  		// message is `Foo` or `google.longrunning.Operation`.
    35  		want := strings.Replace(m.GetName(), "Undelete", "", 1)
    36  		got := m.GetOutputType().GetName()
    37  
    38  		// If the return type is an LRO, use the annotated response type instead.
    39  		if utils.IsOperation(m.GetOutputType()) {
    40  			got = utils.GetOperationInfo(m).GetResponseType()
    41  		}
    42  
    43  		// Return a problem if we did not get the expected return name.
    44  		//
    45  		// Note: If `got` is empty string, this is an unannotated LRO.
    46  		// The AIP-151 rule will whine about that, and this rule should not as it
    47  		// would be confusing.
    48  		if got != want && got != "" {
    49  			return []lint.Problem{{
    50  				Message: fmt.Sprintf(
    51  					"Undelete RPCs should have response message type %q, not %q.",
    52  					want,
    53  					got,
    54  				),
    55  				Suggestion: want,
    56  				Descriptor: m,
    57  				Location:   locations.MethodResponseType(m),
    58  			}}
    59  		}
    60  		return nil
    61  	},
    62  }