github.com/googleapis/api-linter@v1.65.2/rules/aip0134/http_body.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 aip0134
    16  
    17  import (
    18  	"fmt"
    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  	"github.com/stoewer/go-strcase"
    25  )
    26  
    27  // Update methods should have an HTTP body.
    28  var httpBody = &lint.MethodRule{
    29  	Name:   lint.NewRuleName(134, "http-body"),
    30  	OnlyIf: utils.IsUpdateMethod,
    31  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    32  		fieldName := strcase.SnakeCase(m.GetName()[6:])
    33  		// Establish that the RPC has HTTP body equal to fieldName.
    34  		for _, httpRule := range utils.GetHTTPRules(m) {
    35  			if httpRule.Body != fieldName {
    36  				return []lint.Problem{{
    37  					Message:    fmt.Sprintf("Update methods should have an HTTP body equal to `%q`.", fieldName),
    38  					Descriptor: m,
    39  					Location:   locations.MethodHTTPRule(m),
    40  				}}
    41  			}
    42  		}
    43  
    44  		return nil
    45  	},
    46  }