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

     1  // Copyright 2020 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/rules/internal/utils"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  var resourceIdentifierOnly = &lint.FieldRule{
    24  	Name: lint.NewRuleName(203, "resource-identifier-only"),
    25  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    26  		return utils.GetFieldBehavior(f).Contains("IDENTIFIER")
    27  	},
    28  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    29  		m := f.GetParent().(*desc.MessageDescriptor)
    30  		if nf := utils.GetResourceNameField(utils.GetResource(m)); utils.IsResource(m) && f.GetName() == nf {
    31  			return nil
    32  		}
    33  
    34  		return []lint.Problem{{
    35  			Message:    "The IDENTIFIER `google.api.field_behavior` annotation must only be applied to a resource's name field.",
    36  			Descriptor: f,
    37  		}}
    38  	},
    39  }