github.com/googleapis/api-linter@v1.65.2/rules/aip0133/request_id_field.go (about)

     1  // Copyright 2020 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 aip0133
    16  
    17  import (
    18  	"fmt"
    19  	"strings"
    20  
    21  	"github.com/googleapis/api-linter/lint"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  	"github.com/stoewer/go-strcase"
    25  )
    26  
    27  var requestIDField = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(133, "request-id-field"),
    29  	OnlyIf: utils.IsCreateRequestMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		idField := strcase.SnakeCase(strings.TrimPrefix(strings.TrimSuffix(m.GetName(), "Request"), "Create")) + "_id"
    32  		if field := m.FindFieldByName(idField); field == nil || utils.GetTypeName(field) != "string" || field.IsRepeated() {
    33  			return []lint.Problem{{
    34  				Message:    fmt.Sprintf("create methods should contain a singular `string %s` field.", idField),
    35  				Descriptor: m,
    36  			}}
    37  		}
    38  		return nil
    39  	},
    40  }