eric/onix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: added comments

Browse Source
This commit is contained in:
mayur.popli
2025-03-28 17:51:26 +05:30
parent 84e36a7dae 39934504c5
commit c23223eda4
13 changed files with 1049 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
pkg/model/error.go
View File

@@ -6,7 +6,7 @@ import (
"strings"
)
// Error represents an error response.
// Error represents a standard error response.
type Error struct {
Code string `json:"code"`
Paths string `json:"paths,omitempty"`
@@ -18,7 +18,7 @@ func (e *Error) Error() string {
return fmt.Sprintf("Error: Code=%s, Path=%s, Message=%s", e.Code, e.Paths, e.Message)
}
// SchemaValidationErr represents a collection of schema validation failures.
// SchemaValidationErr occurs when schema validation errors are encountered.
type SchemaValidationErr struct {
Errors []Error
}
@@ -32,6 +32,7 @@ func (e *SchemaValidationErr) Error() string {
return strings.Join(errorMessages, "; ")
}
// BecknError converts the SchemaValidationErr to an instance of Error.
func (e *SchemaValidationErr) BecknError() *Error {
if len(e.Errors) == 0 {
return &Error{
@@ -57,7 +58,7 @@ func (e *SchemaValidationErr) BecknError() *Error {
}
}
// SignValidationErr represents a collection of schema validation failures.
// SignValidationErr occurs when signature validation fails.
type SignValidationErr struct {
error
}
@@ -75,7 +76,7 @@ func (e *SignValidationErr) BecknError() *Error {
}
}
// SignValidationErr represents a collection of schema validation failures.
// BadReqErr occurs when a bad request is encountered.
type BadReqErr struct {
error
}
@@ -93,7 +94,7 @@ func (e *BadReqErr) BecknError() *Error {
}
}
// SignValidationErr represents a collection of schema validation failures.
// NotFoundErr occurs when a requested endpoint is not found.
type NotFoundErr struct {
error
}

6
pkg/model/error_test.go
View File

@@ -10,17 +10,17 @@ import (
"gopkg.in/yaml.v2"
)
// NewSignValidationErrf formats an error message according to a format specifier and arguments,and returns a new instance of SignValidationErr.
// NewSignValidationErrf creates a new SignValidationErr with a formatted error message.
func NewSignValidationErrf(format string, a ...any) *SignValidationErr {
return &SignValidationErr{fmt.Errorf(format, a...)}
}
// NewNotFoundErrf formats an error message according to a format specifier and arguments, and returns a new instance of NotFoundErr.
// NewNotFoundErrf creates a new NotFoundErr with a formatted error message.
func NewNotFoundErrf(format string, a ...any) *NotFoundErr {
return &NotFoundErr{fmt.Errorf(format, a...)}
}
// NewBadReqErrf formats an error message according to a format specifier and arguments, and returns a new instance of BadReqErr.
// NewBadReqErrf creates a new BadReqErr with a formatted error message.
func NewBadReqErrf(format string, a ...any) *BadReqErr {
return &BadReqErr{fmt.Errorf(format, a...)}
}