github.com/googleapis/api-linter@v1.65.2/rules/aip0217/synonyms.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  	"bitbucket.org/creachadair/stringset"
    19  	"github.com/googleapis/api-linter/lint"
    20  	"github.com/googleapis/api-linter/locations"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  var synSet = stringset.New(
    25  	"unreachable_locations",
    26  )
    27  
    28  var synonyms = &lint.FieldRule{
    29  	Name: lint.NewRuleName(217, "synonyms"),
    30  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    31  		return f.GetOwner().FindFieldByName("next_page_token") != nil
    32  	},
    33  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    34  		if synSet.Contains(f.GetName()) {
    35  			return []lint.Problem{{
    36  				Message:    "Use `unreachable` to express unreachable resources when listing.",
    37  				Suggestion: "unreachable",
    38  				Descriptor: f,
    39  				Location:   locations.DescriptorName(f),
    40  			}}
    41  		}
    42  		return nil
    43  	},
    44  }