github.com/googleapis/api-linter@v1.65.2/rules/aip0122/camel_case_uris.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 aip0122
    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  // HTTP URL pattern shouldn't include underscore("_")
    27  var httpURICase = &lint.MethodRule{
    28  	Name: lint.NewRuleName(122, "camel-case-uris"),
    29  	LintMethod: func(m *desc.MethodDescriptor) (problems []lint.Problem) {
    30  		// Establish that the URI does not include a `_` character.
    31  		for _, httpRule := range utils.GetHTTPRules(m) {
    32  			if strings.Contains(httpRule.GetPlainURI(), "_") {
    33  				problems = append(problems, lint.Problem{
    34  					Message:    "HTTP URI patterns should use camel case, not snake case.",
    35  					Descriptor: m,
    36  					Location:   locations.MethodHTTPRule(m),
    37  				})
    38  			}
    39  			for v := range httpRule.GetVariables() {
    40  				if strings.ToLower(v) != v {
    41  					problems = append(problems, lint.Problem{
    42  						Message:    "Variable names in URI patterns should use snake case, not camel case.",
    43  						Descriptor: m,
    44  						Location:   locations.MethodHTTPRule(m),
    45  					})
    46  				}
    47  			}
    48  
    49  			// FIXME: We intentionally only return at most one of each type of `Problem` here.
    50  			// When we can attach problems to the particular annotation, remove this.
    51  			if len(problems) > 0 {
    52  				return
    53  			}
    54  		}
    55  		return
    56  	},
    57  }