github.com/googleapis/api-linter@v1.65.2/rules/aip0164/aip0164.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 aip0164 contains rules defined in https://aip.dev/164.
    16  package aip0164
    17  
    18  import (
    19  	"regexp"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  // AddRules adds all of the AIP-164 rules to the provided registry.
    26  func AddRules(r lint.RuleRegistry) error {
    27  	return r.Register(
    28  		164,
    29  		httpBody,
    30  		httpMethod,
    31  		httpURISuffix,
    32  		requestMessageName,
    33  		requestNameBehavior,
    34  		requestNameField,
    35  		requestNameReference,
    36  		requestUnknownFields,
    37  		resourceExpireTimeField,
    38  		responseLRO,
    39  		responseMessageName,
    40  	)
    41  }
    42  
    43  var (
    44  	undeleteMethodRegexp     = regexp.MustCompile("^Undelete(?:[A-Z]|$)")
    45  	undeleteReqMessageRegexp = regexp.MustCompile("^Undelete[A-Za-z0-9]*Request$")
    46  	undeleteURINameRegexp    = regexp.MustCompile(`{name=[a-zA-Z/*]+}:undelete$`)
    47  )
    48  
    49  // Returns true if this is a AIP-164 Undelete method, false otherwise.
    50  func isUndeleteMethod(m *desc.MethodDescriptor) bool {
    51  	return undeleteMethodRegexp.MatchString(m.GetName())
    52  }
    53  
    54  // Returns true if this is an AIP-164 Undelete request message, false otherwise.
    55  func isUndeleteRequestMessage(m *desc.MessageDescriptor) bool {
    56  	return undeleteReqMessageRegexp.MatchString(m.GetName())
    57  }