github.com/googleapis/api-linter@v1.65.2/rules/aip0233/aip0233.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 aip0233 contains rules defined in https://aip.dev/233.
    16  package aip0233
    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  		233,
    30  		pluralMethodName,
    31  		requestMessageName,
    32  		responseMessageName,
    33  		httpBody,
    34  		httpURISuffix,
    35  		httpVerb,
    36  		requestParentField,
    37  		requestParentReference,
    38  		requestRequestsBehavior,
    39  		requestRequestsField,
    40  		requestUnknownFields,
    41  		resourceReferenceType,
    42  		responseResourceField,
    43  	)
    44  }
    45  
    46  var (
    47  	batchCreateMethodRegexp     = regexp.MustCompile("^BatchCreate(?:[A-Za-z0-9]|$)")
    48  	batchCreateReqMessageRegexp = regexp.MustCompile("^BatchCreate[A-Za-z0-9]*Request$")
    49  	batchCreateResMessageRegexp = regexp.MustCompile("^BatchCreate[A-Za-z0-9]*Response$")
    50  	batchCreateURINameRegexp    = regexp.MustCompile(`:batchCreate$`)
    51  )
    52  
    53  // Returns true if this is a AIP-233 Batch Create method, false otherwise.
    54  func isBatchCreateMethod(m *desc.MethodDescriptor) bool {
    55  	return batchCreateMethodRegexp.MatchString(m.GetName())
    56  }
    57  
    58  // Returns true if this is an AIP-233 Batch Create request message, false otherwise.
    59  func isBatchCreateRequestMessage(m *desc.MessageDescriptor) bool {
    60  	return batchCreateReqMessageRegexp.MatchString(m.GetName())
    61  }
    62  
    63  // Returns true if this is an AIP-233 Batch Create response message, false otherwise.
    64  func isBatchCreateResponseMessage(m *desc.MessageDescriptor) bool {
    65  	return batchCreateResMessageRegexp.MatchString(m.GetName())
    66  }