github.com/googleapis/api-linter@v1.65.2/rules/aip0159/hardcoded_hyphen.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 aip0159
    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 hardcodedHyphen = &lint.MethodRule{
    27  	Name: lint.NewRuleName(159, "hardcoded-hyphen"),
    28  	LintMethod: func(m *desc.MethodDescriptor) []lint.Problem {
    29  		for _, http := range utils.GetHTTPRules(m) {
    30  			if strings.Contains(http.GetPlainURI(), "/-/") {
    31  				return []lint.Problem{{
    32  					Message:    "URIs must not hard-code a `-` segment.",
    33  					Descriptor: m,
    34  					Location:   locations.MethodHTTPRule(m),
    35  				}}
    36  			}
    37  		}
    38  		return nil
    39  	},
    40  }