github.com/googleapis/api-linter@v1.65.2/rules/aip0214/resource_expiry.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 aip0214
    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 resourceExpiry = &lint.FieldRule{
    24  	Name: lint.NewRuleName(214, "resource-expiry"),
    25  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    26  		isResource := utils.IsResource(f.GetParent().(*desc.MessageDescriptor))
    27  		isExpireTime := f.GetName() == "expire_time"
    28  		return isResource && isExpireTime
    29  	},
    30  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    31  		// If this field is output only, then there is no user input permitted
    32  		// and therefore having a `ttl` field does not matter.
    33  		if utils.GetFieldBehavior(f).Contains("OUTPUT_ONLY") {
    34  			return nil
    35  		}
    36  
    37  		// If this message does not have a `ttl` field, suggest one.
    38  		if f.GetOwner().FindFieldByName("ttl") == nil {
    39  			return []lint.Problem{{
    40  				Message:    "Resources that let users set expire_time should include an input only `ttl` field.",
    41  				Descriptor: f,
    42  			}}
    43  		}
    44  
    45  		return nil
    46  	},
    47  }