github.com/googleapis/api-linter@v1.65.2/rules/aip0136/http_method.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 aip0136
    16  
    17  import (
    18  	"strings"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var httpMethod = &lint.MethodRule{
    27  	Name:   lint.NewRuleName(136, "http-method"),
    28  	OnlyIf: isCustomMethod,
    29  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    30  		// DeleteFooRevision is still a custom method, but delete is expected
    31  		// (enforced in AIP-162 rules).
    32  		n := m.GetName()
    33  		if strings.HasPrefix(n, "Delete") && strings.HasSuffix(n, "Revision") {
    34  			return nil
    35  		}
    36  
    37  		// Run the normal check for POST or GET.
    38  		for _, httpRule := range utils.GetHTTPRules(m) {
    39  			if httpRule.Method != "POST" && httpRule.Method != "GET" {
    40  				return []lint.Problem{{
    41  					Message:    "Custom methods should use the HTTP POST or GET method.",
    42  					Descriptor: m,
    43  					Location:   locations.MethodHTTPRule(m),
    44  				}}
    45  			}
    46  		}
    47  		return nil
    48  	},
    49  }