errors

package
v1.136.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 1, 2025 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatAPIErrorToGo

func FormatAPIErrorToGo(ctx context.Context, errorContext string, resp *http.Response, clientErr error, errorExtract ExtractAPIErrorDescriptionFunc) (err error)

FormatAPIErrorToGo formats an API error into a Go error. errorContext corresponds to the description of what led to the error e.g. `Failed adding a user`. This is to add further details about the error. resp corresponds to the HTTP response from a certain endpoint. Note: the body of such response is not closed by this function. clientErr corresponds to the error which may be returned by the HTTP client when calling the endpoint.

func MapErrorToHTTPResponseCode

func MapErrorToHTTPResponseCode(statusCode int) error

MapErrorToHTTPResponseCode maps a response status code to a common error.

Types

type ExtractAPIErrorDescriptionFunc

type ExtractAPIErrorDescriptionFunc func(ctx context.Context, resp *http.Response) (message string, err error)

ExtractAPIErrorDescriptionFunc defines a function which can extract an error message from a API response.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL