github.com/googleapis/api-linter@v1.65.2/rules/aip0148/use_uid.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 aip0148
    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  )
    25  
    26  const (
    27  	idStr  = "id"
    28  	uidStr = "uid"
    29  )
    30  
    31  var useUid = &lint.FieldRule{
    32  	Name: lint.NewRuleName(148, "use-uid"),
    33  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    34  		return utils.IsResource(f.GetOwner())
    35  	},
    36  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    37  		if f.GetName() == idStr {
    38  			return []lint.Problem{{
    39  				Message:    fmt.Sprintf("Use %s instead of %s.", uidStr, idStr),
    40  				Descriptor: f,
    41  				Location:   locations.DescriptorName(f),
    42  				Suggestion: uidStr,
    43  			}}
    44  		}
    45  		return nil
    46  	},
    47  }