package
0.0.0-20250322183500-934bfd50bf90
Repository: https://github.com/infomark-org/infomark.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
EnsurePrivacyInEnrollments removes some data from the request to ensure that not everyone has access to personal data.
ErrBadRequestWithDetails returns status 400 with a text.
ErrInternalServerErrorWithDetails returns status 500 with a text.
ErrRender returns status 422 Unprocessable Entity rendering response error.
ErrTimeoutWithDetails returns status 504 with a text.
ErrUnauthorizedWithDetails returns status 403 with a text e.g.
FileServer conveniently sets up a http.FileServer handler to serve static files from a http.FileSystem.
No description provided by the author
No description provided by the author
LimitedDecoder limits the amount of data a client can send in a JSON data request.
No description provided by the author
New configures application resources and routes.
NewAccountResource create and returns a AccountResource.
NewAPI configures and returns application API.
NewAuthResource create and returns a AuthResource.
NewCommonResource create and returns a CommonResource.
NewCourseResource create and returns a CourseResource.
NewExamResource create and returns a ExamResource.
NewGradeResource create and returns a GradeResource.
NewGroupResource create and returns a GroupResource.
NewMaterialResource create and returns a MaterialResource.
NewSheetResource create and returns a SheetResource.
NewStores build all stores and connect them to a database.
NewSubmissionResource create and returns a SubmissionResource.
NewTaskRatingResource create and returns a TaskRatingResource.
NewTaskResource create and returns a TaskResource.
NewUserResource create and returns a UserResource.
NoCache writes required cache headers to all requests.
NowUTC returns the current server time.
OverTime tests if the deadline is missed (alias for publicyet).
PublicYet tests if a given time is now or in the past.
No description provided by the author
SecureMiddleware writes required access headers to all requests.
VersionMiddleware writes the current API version to the headers.
# Variables
DefaultSubmissionProducer is the producer which broadcasts all submissions amongst the workers.
ErrBadRequest returns status 400 Bad Request for malformed request body.
ErrInternalServerError returns status 500 Internal Server Error.
ErrNotFound returns status 404 Not Found for invalid resource request.
ErrUnauthorized returns 401 Unauthorized.
ErrForbidden returns status 403 Forbidden for unauthorized request.
# Structs
AccountRequest is the request when a password/email update is requested.
AccountResource specifies user management handler.
No description provided by the author
API provides application resources and handlers.
AuthResource specifies user management handler.
No description provided by the author
No description provided by the author
CommonResource specifies user management handler.
ConfirmEmailRequest is the request for email verification.
CourseRequest is the request payload for course management.
CourseResource specifies course management handler.
CourseResponse is the response payload for course management.
CreateUserAccountRequest represents the incoming request from a registration form.
EmailRequest is the request payload containing email information.
CourseResponse is the response payload for course management.
ErrResponse renderer type for handling all sorts of errors.
ExamEnrollmentResponse is the response payload for course management.
ExamRequest is the request payload for exam management.
ExamResource specifies exam management handler.
ExamResponse is the response payload for course management.
GradeFromWorkerRequest represents the request a backendwork will sent after completion.
GradeOverviewResponse captures the summary for all grades over all sheets for a subset of users.
GradeRequest is the request payload for submission management.
GradeResource specifies Grade management handler.
GradeResponse is the response payload for Grade management.
No description provided by the author
GroupBidResponse returns the preference of a user to a exercise group.
.............................................................................
GroupRequest is the request payload for course management.
GroupRequest is the request payload for course management.
GroupResource specifies Group management handler.
GroupResponse is the response payload for Group management.
LoginRequest is the request for the login process containing the password and email as identifiers.
MaterialRequest is the request payload for Material management.
MaterialResource specifies Material management handler.
MaterialResponse is the response payload for Material management.
MissingGradeResponse is the response payload for showing tutors which grades are still in the loop.
MissingTaskResponse is the response payload for displaying.
RawResponse is the response payload for course management.
----------------------------------------------------------------------------- ResetPasswordRequest is the request whenever a user forgot his password and wants to receive an email with a new one.
for the swagger build relying on go.ast we need to duplicate code here.
SheetPointsResponse is response for performance on a specific exercise sheet.
SheetRequest is the request payload for Sheet management.
SheetResource specifies Sheet management handler.
SheetResponse is the response payload for Sheet management.
Stores is the collection of stores.
SubmissionResource specifies Submission management handler.
SubmissionResponse is the response payload for Submission management.
TaskPointsResponse returns a performance summary for a task and student.
TaskRatingRequest is the request payload when students give feedback rating.
TaskRatingResource specifies TaskRating management handler.
TaskRatingResponse is the response payload for TaskRating management.
TaskRequest is the request payload for Task management.
TaskResource specifies Task management handler.
TaskResponse is the response payload for Task management.
UpdatePasswordRequest is the request for a password reset.
UserEnrollmentResponse is the response payload for account management.
ExamRequest is the request payload for exam management.
No description provided by the author
UserMeRequest is the request payload for user management.
UserRequest is the request payload for user management.
UserResource specifies user management handler.
UserResponse is the response payload for user management.
VersionResponse is the response payload for course management.
VoidProducer acts like a real producer, but will not trigger any background worker if you do not need these or within tests.
# Interfaces
CourseStore defines course related database queries.
ExamStore defines exam related database queries.
GradeStore defines grades related database queries.
GroupStore specifies required database queries for Task management.
MaterialStore defines material related database queries.
Producer is interface to pipe the workload over AMPQ to the backend workers.
SheetStore specifies required database queries for Sheet management.
SubmissionStore defines submission related database queries.
TaskStore specifies required database queries for Task management.
UserStore defines user related database queries.
# Type aliases
H is a wrapper for convenience.