github.com/googleapis/api-linter@v1.65.2/rules/aip0165/response_purge_count_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 aip0165
    16  
    17  import (
    18  	"fmt"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/locations"
    22  	"github.com/jhump/protoreflect/desc"
    23  	"github.com/jhump/protoreflect/desc/builder"
    24  )
    25  
    26  // The Purge response message should have purge_count field.
    27  var responsePurgeCountField = &lint.MessageRule{
    28  	Name:   lint.NewRuleName(165, "response-purge-count-field"),
    29  	OnlyIf: isPurgeResponseMessage,
    30  	LintMessage: func(m *desc.MessageDescriptor) []lint.Problem {
    31  		// Rule check: Establish that a `purge_count` field is present.
    32  		field := m.FindFieldByName("purge_count")
    33  		if field == nil {
    34  			return []lint.Problem{{
    35  				Message:    fmt.Sprintf("Message %q has no `purge_count` field.", m.GetName()),
    36  				Descriptor: m,
    37  			}}
    38  		}
    39  
    40  		// Rule check: Establish that the purge_count field is a singular int32.
    41  		if field.GetType() != builder.FieldTypeInt32().GetType() || field.IsRepeated() {
    42  			return []lint.Problem{{
    43  				Message:    "`purge_count` field on Purge response message must be a singular int32.",
    44  				Descriptor: field,
    45  				Location:   locations.FieldType(field),
    46  				Suggestion: "int32",
    47  			}}
    48  		}
    49  
    50  		return nil
    51  	},
    52  }