github.com/googleapis/api-linter@v1.65.2/rules/aip0122/no_self_links.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  	"github.com/googleapis/api-linter/lint"
    19  	"github.com/googleapis/api-linter/rules/internal/utils"
    20  	"github.com/jhump/protoreflect/desc"
    21  	"google.golang.org/protobuf/types/descriptorpb"
    22  )
    23  
    24  var noSelfLinks = &lint.MessageRule{
    25  	Name:   lint.NewRuleName(122, "no-self-links"),
    26  	OnlyIf: utils.IsResource,
    27  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    28  		problems := []lint.Problem{}
    29  		for _, field := range m.GetFields() {
    30  			if field.GetType() == descriptorpb.FieldDescriptorProto_TYPE_STRING &&
    31  				field.GetName() == "self_link" {
    32  				problems = append(problems, lint.Problem{
    33  					Message:    "Resources must not contain self-links.",
    34  					Descriptor: field,
    35  				})
    36  			}
    37  		}
    38  		return problems
    39  	},
    40  }