mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 21:19:28 -06:00
6a19278f23
* API keys: redirecting of create endpont * update naming and using admonition * fmt * Apply suggestions from code review Co-authored-by: Ieva <ieva.vasiljeva@grafana.com> --------- Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
142 lines
3.9 KiB
Go
142 lines
3.9 KiB
Go
package api
|
|
|
|
// A GenericError is the default error message that is generated.
|
|
// For certain status codes there are more appropriate error structures.
|
|
//
|
|
// swagger:response genericError
|
|
type GenericError struct {
|
|
// The response message
|
|
// in: body
|
|
Body ErrorResponseBody `json:"body"`
|
|
}
|
|
|
|
type ErrorResponseBody struct {
|
|
// a human readable version of the error
|
|
// required: true
|
|
Message string `json:"message"`
|
|
|
|
// Error An optional detailed description of the actual error. Only included if running in developer mode.
|
|
Error string `json:"error"`
|
|
|
|
// Status An optional status to denote the cause of the error.
|
|
//
|
|
// For example, a 412 Precondition Failed error may include additional information of why that error happened.
|
|
Status string `json:"status"`
|
|
}
|
|
|
|
// swagger:model
|
|
type SuccessResponseBody struct {
|
|
Message string `json:"message,omitempty"`
|
|
}
|
|
|
|
// An OKResponse is returned if the request was successful.
|
|
//
|
|
// swagger:response okResponse
|
|
type OKResponse struct {
|
|
// in: body
|
|
Body SuccessResponseBody `json:"body"`
|
|
}
|
|
|
|
// ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
|
|
//
|
|
// swagger:response forbiddenError
|
|
type ForbiddenError GenericError
|
|
|
|
// NotFoundError is returned when the requested resource was not found.
|
|
//
|
|
// swagger:response notFoundError
|
|
type NotFoundError GenericError
|
|
|
|
// BadRequestError is returned when the request is invalid and it cannot be processed.
|
|
//
|
|
// swagger:response badRequestError
|
|
type BadRequestError GenericError
|
|
|
|
// ConflictError
|
|
//
|
|
// swagger:response conflictError
|
|
type ConflictError GenericError
|
|
|
|
// PreconditionFailedError
|
|
//
|
|
// swagger:response preconditionFailedError
|
|
type PreconditionFailedError GenericError
|
|
|
|
// UnprocessableEntityError
|
|
//
|
|
// swagger:response unprocessableEntityError
|
|
type UnprocessableEntityError GenericError
|
|
|
|
// InternalServerError is a general error indicating something went wrong internally.
|
|
//
|
|
// swagger:response internalServerError
|
|
type InternalServerError GenericError
|
|
|
|
// UnauthorizedError is returned when the request is not authenticated.
|
|
//
|
|
// swagger:response unauthorisedError
|
|
type UnauthorizedError GenericError
|
|
|
|
// AcceptedResponse
|
|
//
|
|
// swagger:response acceptedResponse
|
|
type AcceptedResponse GenericError
|
|
|
|
// StatusMovedPermanently
|
|
//
|
|
// swagger:response statusMovedPermanently
|
|
type StatusMovedPermanentlyRedirect GenericError
|
|
|
|
// documentation for PublicError defined in errutil.Error
|
|
|
|
// swagger:response publicErrorResponse
|
|
type PublicErrorResponse struct {
|
|
// The response message
|
|
// in: body
|
|
Body PublicError `json:"body"`
|
|
}
|
|
|
|
// PublicError is derived from Error and only contains information
|
|
// available to the end user.
|
|
// swagger:model publicError
|
|
type PublicError struct {
|
|
// StatusCode The HTTP status code returned
|
|
// required: true
|
|
StatusCode int `json:"statusCode"`
|
|
|
|
// MessageID A unique identifier for the error
|
|
// required: true
|
|
MessageID string `json:"messageId"`
|
|
|
|
// Message A human readable message
|
|
Message string `json:"message"`
|
|
|
|
// Extra Additional information about the error
|
|
Extra map[string]any `json:"extra"`
|
|
}
|
|
|
|
// NotFoundPublicError is returned when the requested resource was not found.
|
|
//
|
|
// swagger:response notFoundPublicError
|
|
type NotFoundPublicError PublicErrorResponse
|
|
|
|
// BadRequestPublicError is returned when the request is invalid and it cannot be processed.
|
|
//
|
|
// swagger:response badRequestPublicError
|
|
type BadRequestPublicError PublicErrorResponse
|
|
|
|
// UnauthorisedPublicError is returned when the request is not authenticated.
|
|
//
|
|
// swagger:response unauthorisedPublicError
|
|
type UnauthorisedPublicError PublicErrorResponse
|
|
|
|
// ForbiddenPublicError is returned if the user/token has insufficient permissions to access the requested resource.
|
|
//
|
|
// swagger:response forbiddenPublicError
|
|
type ForbiddenPublicError PublicErrorResponse
|
|
|
|
// InternalServerPublicError is a general error indicating something went wrong internally.
|
|
//
|
|
// swagger:response internalServerPublicError
|
|
type InternalServerPublicError PublicErrorResponse
|