diff --git a/pkg/api/server/README.md b/pkg/api/server/README.md new file mode 100644 index 0000000..1adf7f8 --- /dev/null +++ b/pkg/api/server/README.md @@ -0,0 +1,53 @@ +# Server API Documentation + +```go +/* +Relative API Path: + api/server/status +Request: + N/A +Response(): + N/A +*/ +func Status(res http.ResponseWriter, req *http.Request) bool + +/* +Relative API Path: + api/server/start +Request: + N/A +Response(): + N/A +*/ +func Start(res http.ResponseWriter, req *http.Request) bool + +/* +Relative API Path: + api/server/Shutdown +Request: + N/A +Response(): + N/A +*/ +func Shutdown(res http.ResponseWriter, req *http.Request) bool + +/* +Relative API Path: + api/server/Restart +Request: + N/A +Response(): + N/A +*/ +func Restart(res http.ResponseWriter, req *http.Request) bool + +/* +Relative API Path: + api/server/maintenance +Request: + N/A +Response(): + N/A +*/ +func Maintenance(res http.ResponseWriter, req *http.Request) bool +``` diff --git a/pkg/api/server/maintenance.go b/pkg/api/server/maintenance.go new file mode 100644 index 0000000..6eb08ff --- /dev/null +++ b/pkg/api/server/maintenance.go @@ -0,0 +1,8 @@ +// Package server is a child of package api to handle api calls concerning the server +package server + +import "net/http" + +func Maintenance(res http.ResponseWriter, req *http.Request) bool { + return true +} diff --git a/pkg/api/server/restart.go b/pkg/api/server/restart.go new file mode 100644 index 0000000..a010e93 --- /dev/null +++ b/pkg/api/server/restart.go @@ -0,0 +1,8 @@ +// Package server is a child of package api to handle api calls concerning the server +package server + +import "net/http" + +func Restart(res http.ResponseWriter, req *http.Request) bool { + return true +} diff --git a/pkg/api/server/server.go b/pkg/api/server/server.go new file mode 100644 index 0000000..9d01ff0 --- /dev/null +++ b/pkg/api/server/server.go @@ -0,0 +1,2 @@ +// Package server is a child of package api to handle api calls concerning the server +package server diff --git a/pkg/api/server/shutdown.go b/pkg/api/server/shutdown.go new file mode 100644 index 0000000..76d5566 --- /dev/null +++ b/pkg/api/server/shutdown.go @@ -0,0 +1,8 @@ +// Package server is a child of package api to handle api calls concerning the server +package server + +import "net/http" + +func Shutdown(res http.ResponseWriter, req *http.Request) bool { + return true +} diff --git a/pkg/api/server/start.go b/pkg/api/server/start.go new file mode 100644 index 0000000..2b9b035 --- /dev/null +++ b/pkg/api/server/start.go @@ -0,0 +1,8 @@ +// Package server is a child of package api to handle api calls concerning the server +package server + +import "net/http" + +func Start(res http.ResponseWriter, req *http.Request) bool { + return true +} diff --git a/pkg/api/server/status.go b/pkg/api/server/status.go new file mode 100644 index 0000000..7b4014d --- /dev/null +++ b/pkg/api/server/status.go @@ -0,0 +1,8 @@ +// Package server is a child of package api to handle api calls concerning the server +package server + +import "net/http" + +func Status(res http.ResponseWriter, req *http.Request) bool { + return true +} diff --git a/pkg/api/user/README.md b/pkg/api/user/README.md index a1f74ef..3991c6b 100644 --- a/pkg/api/user/README.md +++ b/pkg/api/user/README.md @@ -12,7 +12,7 @@ Request: Response(204, 400, 401, 405, 500): N/A */ -func UserAuthentication(res http.ResponseWriter, req *http.Request) bool +func Auth(res http.ResponseWriter, req *http.Request) bool /* Relative API Path: @@ -25,7 +25,7 @@ Request: Response (204, 400, 405, 500): N/A */ -func UserRegistration(res http.ResponseWriter, req *http.Request) bool +func Register(res http.ResponseWriter, req *http.Request) bool /* Relative API Path: @@ -35,5 +35,5 @@ Request: Response (204, 405, 500): N/A */ -func UserLogout(res http.ResponseWriter, req *http.Request) bool +func Logout(res http.ResponseWriter, req *http.Request) bool ```