github.com/googleapis/api-linter@v1.65.2/rules/aip0128/resource_annotations_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 aip0128
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/googleapis/api-linter/rules/internal/utils"
    23  	"github.com/jhump/protoreflect/desc"
    24  )
    25  
    26  var resourceAnnotationsField = &lint.MessageRule{
    27  	Name:   lint.NewRuleName(128, "resource-annotations-field"),
    28  	OnlyIf: isDeclarativeFriendlyResource,
    29  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    30  		f := m.FindFieldByName("annotations")
    31  		if f == nil {
    32  			return []lint.Problem{{
    33  				Message:    fmt.Sprintf("Declarative-friendly %q has no `annotations` field.", m.GetName()),
    34  				Descriptor: m,
    35  			}}
    36  		}
    37  
    38  		if t := utils.GetTypeName(f); t != "map<string, string>" {
    39  			return []lint.Problem{{
    40  				Message:    fmt.Sprintf("The `annotations` field should be a `map<string, string>`, not %s.", t),
    41  				Descriptor: f,
    42  				Location:   locations.FieldType(f),
    43  				Suggestion: "map<string, string>",
    44  			}}
    45  		}
    46  
    47  		return nil
    48  	},
    49  }