api

package

v0.0.0-...-5733806 Latest Latest Go to latest Published: Oct 10, 2023 License: AGPL-3.0 Imports: 35 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type API struct {
	// contains filtered or unexported fields
}

API is the base struct for the project's API

func New(base *sudoapi.BaseAPI) *API

New declares a new API instance

func (s *API) Handler() http.Handler

Handler is the magic behind the API

func (s *API) MustBeAdmin(next http.Handler) http.Handler

MustBeAdmin is middleware to make sure the user creating the request is an admin

func (s *API) MustBeAuthed(next http.Handler) http.Handler

MustBeAuthed is middleware to make sure the user creating the request is authenticated

func (s *API) MustBeProposer(next http.Handler) http.Handler

MustBeProposer is middleware to make sure the user creating the request is a proposer

func (s *API) MustBeVisitor(next http.Handler) http.Handler

MustBeVisitor is middleware to make sure the user creating the request is not authenticated

func (s *API) SetupSession(next http.Handler) http.Handler

SetupSession adds the user with the specified user ID to context

type Assets struct {
	// contains filtered or unexported fields
}

func NewAssets(base *sudoapi.BaseAPI) *Assets

func (s *Assets) AssetsRouter() http.Handler

func (s *Assets) ServeAttachment(w http.ResponseWriter, r *http.Request)

func (s *Assets) ServeContestLeaderboard(w http.ResponseWriter, r *http.Request)

func (s *Assets) ServeProblemArchive(w http.ResponseWriter, r *http.Request)

func (s *Assets) ServeSubtest(w http.ResponseWriter, r *http.Request)

func (s *Assets) ServeTestInput(w http.ResponseWriter, r *http.Request)

func (s *Assets) ServeTestOutput(w http.ResponseWriter, r *http.Request)