github.com/googleapis/api-linter@v1.65.2/rules/aip0192/aip0192.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 aip0192 contains rules defined in https://aip.dev/192.
    16  package aip0192
    17  
    18  import (
    19  	"github.com/googleapis/api-linter/lint"
    20  	"github.com/jhump/protoreflect/desc"
    21  )
    22  
    23  // AddRules adds all of the AIP-192 rules to the provided registry.
    24  func AddRules(r lint.RuleRegistry) error {
    25  	return r.Register(
    26  		192,
    27  		absoluteLinks,
    28  		deprecatedComment,
    29  		hasComments,
    30  		noHTML,
    31  		noMarkdownHeadings,
    32  		noMarkdownTables,
    33  		onlyLeadingComments,
    34  		trademarkedNames,
    35  	)
    36  }
    37  
    38  // Returns true if this is a deprecated descriptor, false otherwise.
    39  func isDeprecated(d desc.Descriptor) bool {
    40  	switch d := d.(type) {
    41  	case *desc.MethodDescriptor:
    42  		return d.GetMethodOptions().GetDeprecated()
    43  	case *desc.ServiceDescriptor:
    44  		return d.GetServiceOptions().GetDeprecated()
    45  	case *desc.FieldDescriptor:
    46  		return d.GetFieldOptions().GetDeprecated()
    47  	case *desc.EnumDescriptor:
    48  		return d.GetEnumOptions().GetDeprecated()
    49  	case *desc.EnumValueDescriptor:
    50  		return d.GetEnumValueOptions().GetDeprecated()
    51  	case *desc.MessageDescriptor:
    52  		return d.GetMessageOptions().GetDeprecated()
    53  	default:
    54  		return false
    55  	}
    56  }