github.com/googleapis/api-linter@v1.65.2/rules/aip0158/response_plural_first_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 aip0158
    16  
    17  import (
    18  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/locations"
    20  	"github.com/googleapis/api-linter/rules/internal/utils"
    21  	"github.com/jhump/protoreflect/desc"
    22  	"github.com/stoewer/go-strcase"
    23  )
    24  
    25  var responsePluralFirstField = &lint.MessageRule{
    26  	Name: lint.NewRuleName(158, "response-plural-first-field"),
    27  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    28  		return isPaginatedResponseMessage(m) && len(m.GetFields()) > 0
    29  	},
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		// Throw a linter warning if, the first field in the message is not named
    32  		// according to plural(message_name.to_snake().split('_')[1:-1]).
    33  		firstField := m.GetFields()[0]
    34  
    35  		// If the field is a resource, use the `plural` annotation to decide the
    36  		// appropriate plural field name.
    37  		want := utils.GetResourcePlural(utils.GetResource(firstField.GetMessageType()))
    38  		if want != "" {
    39  			want = strcase.SnakeCase(want)
    40  		} else {
    41  			want = utils.ToPlural(firstField.GetName())
    42  		}
    43  
    44  		if want != firstField.GetName() {
    45  			return []lint.Problem{{
    46  				Message:    "First field of Paginated RPCs' response should be plural.",
    47  				Suggestion: want,
    48  				Descriptor: firstField,
    49  				Location:   locations.DescriptorName(firstField),
    50  			}}
    51  		}
    52  
    53  		return nil
    54  	},
    55  }