github.com/googleapis/api-linter@v1.65.2/rules/aip0235/aip0235.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 aip0235 contains rules defined in https://aip.dev/235.
    16  package aip0235
    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  		235,
    30  		httpBody,
    31  		httpMethod,
    32  		httpURISuffix,
    33  		pluralMethodName,
    34  		requestMessageName,
    35  		requestNamesBehavior,
    36  		requestNamesField,
    37  		requestNamesReference,
    38  		requestParentField,
    39  		requestParentReference,
    40  		requestRequestsBehavior,
    41  		requestUnknownFields,
    42  		responseMessageName,
    43  		responseResourceField,
    44  	)
    45  }
    46  
    47  var (
    48  	batchDeleteMethodRegexp          = regexp.MustCompile("^BatchDelete(?:[A-Z]|$)")
    49  	batchDeleteReqMessageRegexp      = regexp.MustCompile("^BatchDelete[A-Za-z0-9]*Request$")
    50  	batchDeleteResponseMessageRegexp = regexp.MustCompile("^BatchDelete[A-Za-z0-9]*Response$")
    51  	batchDeleteURIRegexp             = regexp.MustCompile(`:batchDelete$`)
    52  )
    53  
    54  // Returns true if this is a AIP-235 Batch Delete method, false otherwise.
    55  func isBatchDeleteMethod(m *desc.MethodDescriptor) bool {
    56  	return batchDeleteMethodRegexp.MatchString(m.GetName())
    57  }
    58  
    59  // Returns true if this is an AIP-235 Batch Delete request message, false otherwise.
    60  func isBatchDeleteRequestMessage(m *desc.MessageDescriptor) bool {
    61  	return batchDeleteReqMessageRegexp.MatchString(m.GetName())
    62  }
    63  
    64  // Returns true if this is an AIP-235 Batch Delete response message, false otherwise.
    65  func isBatchDeleteResponseMessage(m *desc.MessageDescriptor) bool {
    66  	return batchDeleteResponseMessageRegexp.MatchString(m.GetName())
    67  }