github.com/googleapis/api-linter@v1.65.2/rules/aip0216/state_field_output_only.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 aip0216
    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/genproto/googleapis/api/annotations"
    22  	"strings"
    23  )
    24  
    25  var stateFieldOutputOnly = &lint.FieldRule{
    26  	Name: lint.NewRuleName(216, "state-field-output-only"),
    27  	OnlyIf: func(f *desc.FieldDescriptor) bool {
    28  		// We care about the name of the State enum type.
    29  		// AIP 0216 makes no mention of the state field name.
    30  		et := f.GetEnumType()
    31  		if et == nil {
    32  			return false
    33  		}
    34  
    35  		if !strings.HasSuffix(et.GetName(), "State") {
    36  			return false
    37  		}
    38  
    39  		return true
    40  	},
    41  	LintField: func(f *desc.FieldDescriptor) []lint.Problem {
    42  		behaviors := utils.GetFieldBehavior(f)
    43  		if !behaviors.Contains(annotations.FieldBehavior_OUTPUT_ONLY.String()) {
    44  			return []lint.Problem{
    45  				{
    46  					Message:    "state fields must have field_behavior OUTPUT_ONLY",
    47  					Descriptor: f,
    48  				},
    49  			}
    50  		}
    51  		return nil
    52  	},
    53  }