github.com/googleapis/api-linter@v1.65.2/rules/aip0133/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 aip0133
    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  // Create method should use the resource as the output message
    27  var outputName = &lint.MethodRule{
    28  	Name:   lint.NewRuleName(133, "response-message-name"),
    29  	OnlyIf: utils.IsCreateMethod,
    30  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    31  		want := utils.GetResourceMessageName(m, "Create")
    32  
    33  		// If this is an LRO, then use the annotated response type instead of
    34  		// the actual RPC return type.
    35  		got := m.GetOutputType().GetName()
    36  		if utils.IsOperation(m.GetOutputType()) {
    37  			got = utils.GetOperationInfo(m).GetResponseType()
    38  		}
    39  
    40  		// Rule check: Establish that for methods such as `CreateFoo`, the response
    41  		// message should be named `Foo`
    42  		//
    43  		// Note: If `got` is empty string, this is an unannotated LRO.
    44  		// The AIP-151 rule will whine about that, and this rule should not as it
    45  		// would be confusing.
    46  		if got != want && got != "" {
    47  			return []lint.Problem{{
    48  				Message: fmt.Sprintf(
    49  					"Create RPCs should have the corresponding resource as the response message, such as %q.",
    50  					want,
    51  				),
    52  				Suggestion: want,
    53  				Descriptor: m,
    54  				Location:   locations.MethodResponseType(m),
    55  			}}
    56  		}
    57  
    58  		return nil
    59  	},
    60  }