github.com/mendersoftware/go-lib-micro@v0.0.0-20240304135804-e8e39c59b148/rest_utils/api_error.go (about)

     1  // Copyright 2023 Northern.tech AS
     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  package rest_utils
    15  
    16  import (
    17  	"encoding/json"
    18  	"io"
    19  )
    20  
    21  // ApiError wraps errors returned by our APIs
    22  type ApiError struct {
    23  	Err   string `json:"error"`
    24  	ReqId string `json:"request_id,omitempty"`
    25  }
    26  
    27  func (ae *ApiError) Error() string {
    28  	return ae.Err
    29  }
    30  
    31  func IsApiError(e error) bool {
    32  	_, ok := e.(*ApiError)
    33  	return ok
    34  }
    35  
    36  func ParseApiError(source io.Reader) error {
    37  	jd := json.NewDecoder(source)
    38  
    39  	var aerr ApiError
    40  	if err := jd.Decode(&aerr); err != nil {
    41  		return err
    42  	}
    43  
    44  	return &aerr
    45  }