github.com/googleapis/api-linter@v1.65.2/rules/aip0162/delete_revision_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  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/locations"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // Delete Revision methods should return the resource itself.
    27  var deleteRevisionResponseMessageName = &lint.MethodRule{
    28  	Name:   lint.NewRuleName(162, "delete-revision-response-message-name"),
    29  	OnlyIf: isDeleteRevisionMethod,
    30  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    31  		got := m.GetOutputType().GetName()
    32  		want := strings.TrimPrefix(strings.TrimSuffix(m.GetName(), "Revision"), "Delete")
    33  		if got != want {
    34  			return []lint.Problem{{
    35  				Message:    fmt.Sprintf("Delete Revision methods should return the resource itself (`%s`), not `%s`.", want, got),
    36  				Suggestion: want,
    37  				Descriptor: m,
    38  				Location:   locations.MethodResponseType(m),
    39  			}}
    40  		}
    41  		return nil
    42  	},
    43  }