github.com/googleapis/api-linter@v1.65.2/rules/aip0146/any.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 aip0146
    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 any = &lint.FieldRule{
    25  	Name: lint.NewRuleName(146, "any"),
    26  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    27  		return !utils.IsCommonProto(f.GetFile())
    28  	},
    29  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    30  		if utils.GetTypeName(f) == "google.protobuf.Any" {
    31  			return []lint.Problem{{
    32  				Message:    "Avoid using google.protobuf.Any fields in public APIs.",
    33  				Descriptor: f,
    34  				Location:   locations.FieldType(f),
    35  			}}
    36  		}
    37  		return nil
    38  	},
    39  }