github.com/googleapis/api-linter@v1.65.2/rules/aip0235/response_resource_field.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 aip0235
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/gertd/go-pluralize"
    22  	"github.com/googleapis/api-linter/lint"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  // The Batch Delete response message should have resource field.
    27  var responseResourceField = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(235, "response-resource-field"),
    29  	OnlyIf: isBatchDeleteResponseMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		// the singular form the resource name, the first letter is Capitalized.
    32  		// Note: Retrieve the resource name from the the batch update response,
    33  		// for example: "BatchDeleteBooksResponse" -> "Books"
    34  		resourceMsgName := pluralize.NewClient().Singular(strings.TrimPrefix(strings.TrimSuffix(m.GetName(), "Response"), "BatchDelete"))
    35  
    36  		for _, fieldDesc := range m.GetFields() {
    37  			if msgDesc := fieldDesc.GetMessageType(); msgDesc != nil && msgDesc.GetName() == resourceMsgName {
    38  				if !fieldDesc.IsRepeated() {
    39  					return []lint.Problem{{
    40  						Message:    fmt.Sprintf("The %q type field on Batch Delete Response message should be repeated", msgDesc.GetName()),
    41  						Descriptor: fieldDesc,
    42  					}}
    43  				}
    44  
    45  				return nil
    46  			}
    47  		}
    48  
    49  		// Rule check: Establish that a resource field must be included.
    50  		return []lint.Problem{{
    51  			Message:    fmt.Sprintf("Message %q has no %q type field", m.GetName(), resourceMsgName),
    52  			Descriptor: m,
    53  		}}
    54  	},
    55  }