github.com/googleapis/api-linter@v1.65.2/rules/aip0131/request_name_required.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 aip0131
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/utils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  // The Get standard method should have some required fields.
    26  var requestNameRequired = &lint.MessageRule{
    27  	Name:   lint.NewRuleName(131, "request-name-required"),
    28  	OnlyIf: utils.IsGetRequestMessage,
    29  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    30  		if m.FindFieldByName("name") == nil {
    31  			return []lint.Problem{{
    32  				Message:    fmt.Sprintf("Method %q has no `name` field", m.GetName()),
    33  				Descriptor: m,
    34  			}}
    35  		}
    36  
    37  		return nil
    38  	},
    39  }