github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_annotation.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 aip0123
    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  )
    22  
    23  var resourceAnnotation = &lint.MessageRule{
    24  	Name:   lint.NewRuleName(123, "resource-annotation"),
    25  	OnlyIf: isResourceMessage,
    26  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    27  		if utils.GetResource(m) == nil {
    28  			return []lint.Problem{{
    29  				Message:    "Resource messages should include a `google.api.resource` annotation.",
    30  				Descriptor: m,
    31  			}}
    32  		}
    33  		return nil
    34  	},
    35  }