resource_identifier_only.go

// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package aip0203

import (
	"github.com/googleapis/api-linter/lint"
	"github.com/googleapis/api-linter/rules/internal/utils"
	"github.com/jhump/protoreflect/desc"
)

var resourceIdentifierOnly = &lint.FieldRule{
	Name: lint.NewRuleName(203, "resource-identifier-only"),
	OnlyIf: func(f *desc.FieldDescriptor) bool {
		return utils.GetFieldBehavior(f).Contains("IDENTIFIER")
	},
	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
		m := f.GetParent().(*desc.MessageDescriptor)
		if nf := utils.GetResourceNameField(utils.GetResource(m)); utils.IsResource(m) && f.GetName() == nf {
			return nil
		}

		return []lint.Problem{{
			Message:    "The IDENTIFIER `google.api.field_behavior` annotation must only be applied to a resource's name field.",
			Descriptor: f,
		}}
	},
}