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