github.com/googleapis/api-linter@v1.65.2/rules/aip0128/aip0128.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 aip0128 contains rules defined in https://aip.dev/128.
    16  package aip0128
    17  
    18  import (
    19  	"github.com/googleapis/api-linter/lint"
    20  	"github.com/googleapis/api-linter/rules/internal/utils"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  // AddRules accepts a register function and registers each of
    25  // this AIP's rules to it.
    26  func AddRules(r lint.RuleRegistry) error {
    27  	return r.Register(
    28  		128,
    29  		resourceAnnotationsField,
    30  		resourceReconcilingBehavior,
    31  		resourceReconcilingField,
    32  	)
    33  }
    34  
    35  func isDeclarativeFriendlyResource(m *desc.MessageDescriptor) bool {
    36  	// IsDeclarativeFriendly returns true for both
    37  	// resources and request messages, but we only care about resources.
    38  	resource := utils.DeclarativeFriendlyResource(m)
    39  	return resource != nil && resource == m
    40  }