doc: added documentation to all functions
This commit is contained in:
parent
5b016df85d
commit
5f7d7c4780
7 changed files with 32 additions and 9 deletions
|
|
@ -9,6 +9,8 @@ import time
|
|||
import os
|
||||
import util
|
||||
|
||||
// get_logs returns all build logs in the database. A 'repo' query param can
|
||||
// optionally be added to limit the list of build logs to that repository.
|
||||
['/api/logs'; get]
|
||||
fn (mut app App) get_logs() web.Result {
|
||||
if !app.is_authorized() {
|
||||
|
|
@ -24,6 +26,7 @@ fn (mut app App) get_logs() web.Result {
|
|||
return app.json(http.Status.ok, new_data_response(logs))
|
||||
}
|
||||
|
||||
// get_single_log returns the build log with the given id.
|
||||
['/api/logs/:id'; get]
|
||||
fn (mut app App) get_single_log(id int) web.Result {
|
||||
if !app.is_authorized() {
|
||||
|
|
@ -35,8 +38,9 @@ fn (mut app App) get_single_log(id int) web.Result {
|
|||
return app.json(http.Status.ok, new_data_response(log))
|
||||
}
|
||||
|
||||
// get_log_content returns the actual build log file for the given id.
|
||||
['/api/logs/:id/content'; get]
|
||||
fn (mut app App) get_log_contents(id int) web.Result {
|
||||
fn (mut app App) get_log_content(id int) web.Result {
|
||||
if !app.is_authorized() {
|
||||
return app.json(http.Status.unauthorized, new_response('Unauthorized.'))
|
||||
}
|
||||
|
|
@ -58,6 +62,7 @@ fn parse_query_time(query string) ?time.Time {
|
|||
return t
|
||||
}
|
||||
|
||||
// post_log adds a new log to the database.
|
||||
['/api/logs'; post]
|
||||
fn (mut app App) post_log() web.Result {
|
||||
if !app.is_authorized() {
|
||||
|
|
|
|||
Reference in a new issue