go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/auth/integration/localauth/rpcs/base.go (about)

     1  // Copyright 2017 The LUCI Authors.
     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  //      http://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 rpcs
    16  
    17  import (
    18  	"go.chromium.org/luci/common/errors"
    19  )
    20  
    21  // BaseRequest defines fields included in all requests.
    22  type BaseRequest struct {
    23  	Secret    []byte `json:"secret"`
    24  	AccountID string `json:"account_id"`
    25  }
    26  
    27  // Validate checks that the request is structurally valid.
    28  func (r *BaseRequest) Validate() error {
    29  	switch {
    30  	case len(r.Secret) == 0:
    31  		return errors.New(`field "secret" is required`)
    32  	case r.AccountID == "":
    33  		return errors.New(`field "account_id" is required`)
    34  	}
    35  	return nil
    36  }
    37  
    38  // BaseResponse defines optional fields included in all responses.
    39  type BaseResponse struct {
    40  	ErrorCode    int    `json:"error_code,omitempty"`
    41  	ErrorMessage string `json:"error_message,omitempty"`
    42  }