apiframework

Jun 7, 2026

Changes in this version

+ var ErrBadQueryValue = errors.New("serverops: bad query value")

+ var ErrImmutableGroup = errors.New("serverops: immutable group")

+ func GetErrorParam(err error) string

+ func GetPathParam(r *http.Request, name string, description string) string

+ func GetQueryParam(r *http.Request, name, defaultValue, description string) string

type APIError

+ func BadPathValue(param string, message ...string) *APIError

+ func BadRequest(message ...string) *APIError

+ func Conflict(message ...string) *APIError

+ func FileEmpty(message ...string) *APIError

+ func FileSizeLimitExceeded(message ...string) *APIError

+ func Forbidden(message ...string) *APIError

+ func ImmutableGroup(message ...string) *APIError

+ func ImmutableModel(message ...string) *APIError

+ func InternalServerError(message ...string) *APIError

+ func InvalidChain(message ...string) *APIError

+ func InvalidParameterValue(param string, message ...string) *APIError

+ func MissingParameter(param string, message ...string) *APIError

+ func NewAPIError(err error, message, param string) *APIError

+ func NotFound(message ...string) *APIError

+ func Unauthorized(message ...string) *APIError

+ func UnprocessableEntity(message ...string) *APIError

+ func UnsupportedMediaType(message ...string) *APIError

+ func (e *APIError) Code() string

+ func (e *APIError) Param() string

+ func (e *APIError) Unwrap() error

+ type MessageResponse struct

+ Message string

Aug 14, 2025

Changes in this version

+ var Version string

Aug 14, 2025

Changes in this version

+ func GetVersion() string

+ type AboutServer struct

+ NodeInstanceID string

+ Tenancy string

+ Version string

Aug 9, 2025

Changes in this version

+ var ErrConflict = errors.New("serverops: conflict")

+ var ErrForbidden = errors.New("serverops: forbidden")

+ var ErrInternalServerError = errors.New("serverops: internal server error")

+ var ErrNotFound = errors.New("serverops: not found")

+ var ErrUnauthorized = errors.New("serverops: unauthorized")

+ var ErrUnsupportedMediaType = errors.New("serverops: unsupported media type")

+ func EnforceToken(token string, next http.Handler) http.Handler

+ func TokenMiddleware(next http.Handler) http.Handler

+ func TracingMiddleware(next http.Handler) http.Handler

+ type ContextKey string

+ const ContextTokenKey

Aug 5, 2025

Changes in this version

+ func HandleAPIError(resp *http.Response) error

+ func IsAPIError(err error) bool

+ type APIError struct

+ ErrorProperty string

+ func (e *APIError) Error() string

Aug 5, 2025

Changes in this version

+ var ErrBadPathValue = errors.New("serverops: bad path value")

+ var ErrBadRequest = errors.New("serverops: bad request")

+ var ErrDecodeBase64 = errors.New("serverops: decoding failing, invalid base64 data")

+ var ErrDecodeInvalidJSON = errors.New("serverops: decoding failing, invalid json")

+ var ErrDecodeInvalidYAML = errors.New("serverops: decoding failing, invalid yaml")

+ var ErrEmptyRequest = errors.New("serverops: empty request")

+ var ErrEmptyRequestBody = errors.New("serverops: empty request body")

+ var ErrEncodeInvalidJSON = errors.New("serverops: encoding failing, invalid json")

+ var ErrFileEmpty = errors.New("serverops: file cannot be empty")

+ var ErrFileSizeLimitExceeded = errors.New("serverops: file size limit exceeded")

+ var ErrImmutableModel = errors.New("serverops: immutable model")

+ var ErrImmutablePool = errors.New("serverops: immutable pool")

+ var ErrInvalidChain = errors.New("invalid chain definition")

+ var ErrInvalidParameterValue = errors.New("serverops: invalid parameter value type")

+ var ErrMalformedContentType = errors.New("serverops: malformed Content-Type header")

+ var ErrMissingParameter = errors.New("serverops: missing parameter")

+ var ErrReadingRequestBody = errors.New("serverops: failed to read request body")

+ var ErrUnprocessableEntity = errors.New("serverops: unprocessable entity")

+ var ErrUnsupportedContentType = errors.New("serverops: unsupported content type for decoding")

+ func Decode[T any](r *http.Request) (T, error)

+ func Encode[T any](w http.ResponseWriter, _ *http.Request, status int, v T) error

+ func Error(w http.ResponseWriter, r *http.Request, err error, op Operation) error

+ func RequestIDMiddleware(next http.Handler) http.Handler

+ type Operation uint16

+ const AuthorizeOperation

+ const CreateOperation

+ const DeleteOperation

+ const ExecuteOperation

+ const GetOperation

+ const ListOperation

+ const ServerOperation

+ const UpdateOperation