github.com/googleapis/api-linter@v1.65.2/rules/aip0156/forbidden_methods.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 aip0156
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var forbiddenMethods = &lint.MethodRule{
    27  	Name: lint.NewRuleName(156, "forbidden-methods"),
    28  	OnlyIf: func(m *desc.MethodDescriptor) bool {
    29  		// If the `name` variable in the URI ends in something other than
    30  		// "*", that indicates that this is a singleton.
    31  		//
    32  		// For example:
    33  		//   publishers/*/books/* -- not a singleton, many books
    34  		//   publishers/*/settings -- a singleton; one settings object per publisher
    35  		for _, http := range utils.GetHTTPRules(m) {
    36  			if name, ok := http.GetVariables()["name"]; ok {
    37  				if !strings.HasSuffix(name, "*") {
    38  					return true
    39  				}
    40  			}
    41  		}
    42  		return false
    43  	},
    44  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    45  		// Singletons should not use Create, or Delete.
    46  		for _, badPrefix := range []string{"Create", "Delete"} {
    47  			if strings.HasPrefix(m.GetName(), badPrefix) {
    48  				return []lint.Problem{{
    49  					Message:    fmt.Sprintf("Singletons must not define %q methods.", badPrefix),
    50  					Descriptor: m,
    51  				}}
    52  			}
    53  		}
    54  		return nil
    55  	},
    56  }