github.com/googleapis/api-linter@v1.65.2/rules/aip0131/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 aip0131
    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  // Get messages should use the resource as the response message
    27  var responseMessageName = &lint.MethodRule{
    28  	Name:   lint.NewRuleName(131, "response-message-name"),
    29  	OnlyIf: utils.IsGetMethod,
    30  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    31  		// Rule check: Establish that for methods such as `GetFoo`, the response
    32  		// message is named `Foo`.
    33  		if got, want := m.GetOutputType().GetName(), m.GetName()[3:]; got != want {
    34  			return []lint.Problem{{
    35  				Message: fmt.Sprintf(
    36  					"Get RPCs should have the corresponding resource as the response message, such as %q.",
    37  					want,
    38  				),
    39  				Suggestion: want,
    40  				Descriptor: m,
    41  				Location:   locations.MethodResponseType(m),
    42  			}}
    43  		}
    44  
    45  		return nil
    46  	},
    47  }