github.com/googleapis/api-linter@v1.65.2/rules/aip0134/request_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 aip0134
    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  	"github.com/stoewer/go-strcase"
    25  )
    26  
    27  // The resource field in a update method should named properly.
    28  var requestResourceField = &lint.FieldRule{
    29  	Name: lint.NewRuleName(134, "request-resource-field"),
    30  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    31  		message := f.GetOwner()
    32  		return utils.IsUpdateRequestMessage(message) &&
    33  			f.GetMessageType() != nil &&
    34  			f.GetMessageType().GetName() == extractResource(message.GetName())
    35  	},
    36  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    37  		resourceName := extractResource(f.GetOwner().GetName())
    38  		wantFieldName := strcase.SnakeCase(resourceName)
    39  		if f.GetName() != wantFieldName {
    40  			return []lint.Problem{{
    41  				Message:    fmt.Sprintf("Resource field should be named %q.", wantFieldName),
    42  				Descriptor: f,
    43  				Suggestion: wantFieldName,
    44  				Location:   locations.DescriptorName(f),
    45  			}}
    46  		}
    47  		return nil
    48  	},
    49  }