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

     1  // Copyright 2023 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  	"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  var embeddedResource = &lint.MessageRule{
    26  	Name:   lint.NewRuleName(122, "embedded-resource"),
    27  	OnlyIf: utils.IsResource,
    28  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    29  		var problems []lint.Problem
    30  		for _, f := range m.GetFields() {
    31  			mt := f.GetMessageType()
    32  			if mt == nil || !utils.IsResource(mt) {
    33  				continue
    34  			}
    35  
    36  			r := utils.GetResource(mt)
    37  			if utils.IsResourceRevision(m) && utils.IsRevisionRelationship(r, utils.GetResource(m)) {
    38  				continue
    39  			}
    40  
    41  			suggestion := fmt.Sprintf(`string %s = %d [(google.api.resource_reference).type = %q];`, f.GetName(), f.GetNumber(), r.GetType())
    42  			if f.IsRepeated() {
    43  				suggestion = fmt.Sprintf("repeated %s", suggestion)
    44  			}
    45  			problems = append(problems, lint.Problem{
    46  				Message:    "refer to a resource by name, not by embedding the resource message",
    47  				Descriptor: f,
    48  				Suggestion: suggestion,
    49  			})
    50  		}
    51  
    52  		return problems
    53  	},
    54  }