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

     1  // Copyright 2019 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 aip0217
    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 unreachableFieldType = &lint.FieldRule{
    25  	Name: lint.NewRuleName(217, "unreachable-field-type"),
    26  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    27  		return f.GetName() == "unreachable"
    28  	},
    29  	LintField: func(f *desc.FieldDescriptor) (problems []lint.Problem) {
    30  		if !f.IsRepeated() {
    31  			problems = append(problems, lint.Problem{
    32  				Message:    "unreachable field should be repeated.",
    33  				Descriptor: f,
    34  			})
    35  		}
    36  		if utils.GetTypeName(f) != "string" {
    37  			problems = append(problems, lint.Problem{
    38  				Message:    "unreachable field should be a string.",
    39  				Suggestion: "string",
    40  				Descriptor: f,
    41  				Location:   locations.FieldType(f),
    42  			})
    43  		}
    44  		return
    45  	},
    46  }