github.com/googleapis/api-linter@v1.65.2/rules/aip0231/response_resource_field.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 aip0231
    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 Get response message should have resource field.
    27  var resourceField = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(231, "response-resource-field"),
    29  	OnlyIf: isBatchGetResponseMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		// The singular form the resource message name; the first letter capitalized.
    32  		plural := strings.TrimSuffix(strings.TrimPrefix(m.GetName(), "BatchGet"), "Response")
    33  		resourceMsgName := pluralize.NewClient().Singular(plural)
    34  
    35  		for _, fieldDesc := range m.GetFields() {
    36  			if msgDesc := fieldDesc.GetMessageType(); msgDesc != nil && msgDesc.GetName() == resourceMsgName {
    37  				if !fieldDesc.IsRepeated() {
    38  					return []lint.Problem{{
    39  						Message:    fmt.Sprintf("The %q type field on Batch Get Response message should be repeated", msgDesc.GetName()),
    40  						Descriptor: fieldDesc,
    41  					}}
    42  				}
    43  
    44  				return nil
    45  			}
    46  		}
    47  
    48  		// Rule check: Establish that a resource field must be included.
    49  		return []lint.Problem{{
    50  			Message:    fmt.Sprintf("Message %q has no %q type field", m.GetName(), resourceMsgName),
    51  			Descriptor: m,
    52  		}}
    53  	},
    54  }