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

     1  // Copyright 2023 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 aip0203
    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  	fpb "google.golang.org/genproto/googleapis/api/annotations"
    23  )
    24  
    25  var resourceNameIdentifier = &lint.MessageRule{
    26  	Name: lint.NewRuleName(203, "resource-name-identifier"),
    27  	OnlyIf: func(m *desc.MessageDescriptor) bool {
    28  		return utils.IsResource(m) && m.FindFieldByName(utils.GetResourceNameField(utils.GetResource(m))) != nil
    29  	},
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		f := m.FindFieldByName(utils.GetResourceNameField(utils.GetResource(m)))
    32  		fb := utils.GetFieldBehavior(f)
    33  		if len(fb) == 0 || !fb.Contains(fpb.FieldBehavior_IDENTIFIER.String()) {
    34  			return []lint.Problem{{
    35  				Message:    "resource name field must have field_behavior IDENTIFIER",
    36  				Descriptor: f,
    37  				Location:   locations.FieldOption(f, fpb.E_FieldBehavior),
    38  			}}
    39  		}
    40  
    41  		return nil
    42  	},
    43  }