github.com/googleapis/api-linter@v1.65.2/rules/aip0152/aip0152.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 aip0152 contains rules defined in https://aip.dev/152.
    16  package aip0152
    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  		152,
    30  		httpBody,
    31  		httpMethod,
    32  		httpURISuffix,
    33  		requestMessageName,
    34  		requestNameBehavior,
    35  		requestNameField,
    36  		requestNameReference,
    37  		requestResourceSuffix,
    38  		responseMessageName,
    39  	)
    40  }
    41  
    42  var (
    43  	runMethodRegexp     = regexp.MustCompile(`^Run[A-Za-z0-9]+Job$`)
    44  	runReqMessageRegexp = regexp.MustCompile(`^Run[A-Za-z0-9]+JobRequest$`)
    45  	runURIRegexp        = regexp.MustCompile(`:run$`)
    46  )
    47  
    48  // Returns true if this is an AIP-152 Run method, false otherwise.
    49  func isRunMethod(m *desc.MethodDescriptor) bool {
    50  	return runMethodRegexp.MatchString(m.GetName())
    51  }
    52  
    53  // Returns true if this is an AIP-152 Run request message, false otherwise.
    54  func isRunRequestMessage(m *desc.MessageDescriptor) bool {
    55  	return runReqMessageRegexp.MatchString(m.GetName())
    56  }