github.com/googleapis/api-linter@v1.65.2/rules/aip0144/aip0144.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 aip0144 contains rules defined in https://aip.dev/144.
    16  package aip0144
    17  
    18  import (
    19  	"regexp"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  // AddRules accepts a register function and registers each of
    26  // this AIP's rules to it.
    27  func AddRules(r lint.RuleRegistry) error {
    28  	return r.Register(
    29  		144,
    30  		httpBody,
    31  		httpMethod,
    32  		requestMessageName,
    33  	)
    34  }
    35  
    36  var addRemoveMethodRegexp = regexp.MustCompile("^(?:Add|Remove)(?:[A-Z]|$)")
    37  
    38  // Returns true if this is an AIP-144 Add/Remove method, false otherwise.
    39  func isAddRemoveMethod(m *desc.MethodDescriptor) bool {
    40  	return addRemoveMethodRegexp.MatchString(m.GetName())
    41  }