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

     1  // Copyright 2021 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 aip0162
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  var commitResponseMessageName = &lint.MethodRule{
    26  	Name:   lint.NewRuleName(162, "commit-response-message-name"),
    27  	OnlyIf: isCommitMethod,
    28  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    29  		// Rule check: Establish that for methods such as `CommitBook`, the response
    30  		// message is `Book`.
    31  		want := commitMethodRegexp.FindStringSubmatch(m.GetName())[1]
    32  		got := m.GetOutputType().GetName()
    33  
    34  		// Return a problem if we did not get the expected return name.
    35  		if got != want {
    36  			return []lint.Problem{{
    37  				Message: fmt.Sprintf(
    38  					"Commit RPCs should have response message type %q, not %q.",
    39  					want,
    40  					got,
    41  				),
    42  				Suggestion: want,
    43  				Descriptor: m,
    44  				Location:   locations.MethodResponseType(m),
    45  			}}
    46  		}
    47  		return nil
    48  	},
    49  }