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