github.com/googleapis/api-linter@v1.65.2/rules/aip0154/field_type.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 aip0154
    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  var fieldType = &lint.FieldRule{
    27  	Name: lint.NewRuleName(154, "field-type"),
    28  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    29  		return f.GetName() == "etag"
    30  	},
    31  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    32  		if t := utils.GetTypeName(f); t != "string" || f.IsRepeated() {
    33  			return []lint.Problem{{
    34  				Message:    fmt.Sprintf("The etag field should be a singular string, not %s.", t),
    35  				Descriptor: f,
    36  				Location:   locations.FieldType(f),
    37  				Suggestion: "string",
    38  			}}
    39  		}
    40  		return nil
    41  	},
    42  }