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

     1  // Copyright 2021 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 resourceReferenceType = &lint.FieldRule{
    25  	Name: lint.NewRuleName(123, "resource-reference-type"),
    26  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    27  		return utils.GetResourceReference(f) != nil
    28  	},
    29  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    30  		if utils.GetTypeName(f) != "string" {
    31  			// We assume that the likely mistake is probably that the annotation
    32  			// is wrong (and should not be there), and not that the type is wrong,
    33  			// because this is what we have observed in real life.
    34  			return []lint.Problem{{
    35  				Message:    "Resource references should only be applied to strings.",
    36  				Descriptor: f,
    37  				Location:   locations.FieldResourceReference(f),
    38  				Suggestion: "",
    39  			}}
    40  		}
    41  		return nil
    42  	},
    43  }