github.com/googleapis/api-linter@v1.65.2/rules/aip0155/request_id_format.go (about)

     1  // Copyright 2023 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 aip0155
    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  	"google.golang.org/protobuf/types/descriptorpb"
    23  )
    24  
    25  var requestIdFormat = &lint.FieldRule{
    26  	Name: lint.NewRuleName(155, "request-id-format"),
    27  	OnlyIf: func(fd *desc.FieldDescriptor) bool {
    28  		return fd.GetType() == descriptorpb.FieldDescriptorProto_TYPE_STRING &&
    29  			fd.GetName() == "request_id"
    30  	},
    31  	LintField: func(fd *desc.FieldDescriptor) []lint.Problem {
    32  		if !utils.HasFormat(fd) || utils.GetFormat(fd) != annotations.FieldInfo_UUID4 {
    33  			return []lint.Problem{{
    34  				Message:    "The `request_id` field should have a `(google.api.field_info).format = UUID4` annotation.",
    35  				Descriptor: fd,
    36  			}}
    37  		}
    38  
    39  		return nil
    40  	},
    41  }