github.com/googleapis/api-linter@v1.65.2/rules/aip0123/name_never_optional.go (about)

     1  // Copyright 2022 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 aip0123
    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  )
    23  
    24  var nameNeverOptional = &lint.MessageRule{
    25  	Name: lint.NewRuleName(123, "name-never-optional"),
    26  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    27  		f := "name"
    28  		if nf := utils.GetResource(m).GetNameField(); nf != "" {
    29  			f = nf
    30  		}
    31  		return utils.IsResource(m) && m.FindFieldByName(f) != nil
    32  	},
    33  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    34  		f := "name"
    35  		if nf := utils.GetResource(m).GetNameField(); nf != "" {
    36  			f = nf
    37  		}
    38  		field := m.FindFieldByName(f)
    39  
    40  		if field.IsProto3Optional() {
    41  			return []lint.Problem{{
    42  				Message:    "Resource name fields must never be labeled with proto3_optional",
    43  				Descriptor: field,
    44  				Location:   locations.FieldLabel(field),
    45  				Suggestion: "",
    46  			}}
    47  		}
    48  
    49  		return nil
    50  	},
    51  }