From 5717f8558ab9f1d454eb6fb737c2d0fdf5b92ce3 Mon Sep 17 00:00:00 2001
From: Martin Polanka <PolankaMartin@gmail.com>
Date: Wed, 23 Nov 2016 15:54:15 +0100
Subject: [PATCH] test result and below

---
 Database.md | 68 ++++++++++++++++++++++++++++-------------------------
 1 file changed, 36 insertions(+), 32 deletions(-)

diff --git a/Database.md b/Database.md
index 3fc0d21..af8f694 100644
--- a/Database.md
+++ b/Database.md
@@ -95,47 +95,51 @@ Assignment table represents exercise assignment in a group. It holds keys of the
 
 ## TestResult
 
-- _testName_ --
-- _status_ --
-- _solutionEvaluation_ --
-- _score_ --
-- _memoryExceeded_ --
-- _usedMemoryRatio_ --
-- _timeExceeded_ --
-- _usedTimeRatio_ --
-- _exitCode_ --
-- _message_ --
-- _stats_ --
-- _judgeOutput_ --
+Represents result of one logical test from job configuration.
+
+- _testName_ -- name of test which was stated in job configuration
+- _status_ -- overall status of test
+- _solutionEvaluation_ -- evaluation to which test result belongs
+- _score_ -- score which was assigned to test evaluation by judge
+- _memoryExceeded_ -- true if memory limit was exceeded
+- _usedMemoryRatio_ -- float number from 0.0 to 1.0 which represents percentage of user solution memory usage against memory limit from configuration
+- _timeExceeded_ -- true if time limit was exceeded
+- _usedTimeRatio_ -- float number from 0.0 to 1.0 which represents percentage of user solution time usage against time limit from configuration
+- _exitCode_ -- exit code which whole test returns
+- _message_ -- provided only on non-zero exit code
+- _stats_ -- textual representation of whole information about evaluation of test which arrived from worker
+- _judgeOutput_ -- output textual message from judge
 
 ## UploadedFile
 
-- _name_ --
-- _localFilePath_ --
-- _uploadedAt_ --
-- _fileSize_ --
-- _user_ --
+- _name_ -- original name of file uploaded to api
+- _localFilePath_ -- destination where file is stored on api server
+- _uploadedAt_ -- datetime of file upload
+- _fileSize_ -- size of uploaded file in bytes
+- _user_ -- user which uploaded particular file
 
 ## User
 
-- _degreesBeforeName_ --
-- _firstName_ --
-- _lastName_ --
-- _degreesAfterName_ --
-- _email_ --
-- _avatarUrl_ --
-- _isVerified_ --
-- _isAllowed_ --
-- _createdAt_ --
-- _instance_ --
-- _settings_ --
-- _memberships_ --
-- _exercises_ --
-- _role_ --
+Keeps information about all users which are registered in ReCodEx.
+
+- _degreesBeforeName_ -- degrees before name which user acquired
+- _firstName_ -- first name
+- _lastName_ -- surname
+- _degreesAfterName_ -- degrees after name
+- _email_ -- email address which is used for sending email notifications
+- _avatarUrl_ -- url of profile picture
+- _isVerified_ -- user verified his/hers email address (not used at the moment)
+- _isAllowed_ -- if this field is set to false user cannot sign in to application
+- _createdAt_ -- datetime of user registration
+- _instance_ -- instance to which user belongs to
+- _settings_ -- settings which are connected to this user
+- _memberships_ -- array of groups in which is user assigned
+- _exercises_ -- exercises which user created and is their author
+- _role_ -- role of the user which is used to determine privileges
 
 ## UserAction
 
-Stores information about what routes on api user visited and some additional information about it. This procedure is applied only on logged users.
+Stores information about what routes on api user visited and some additional information about it. This datas should be collected only from logged users.
 
 - _user_ -- which user performed api request
 - _loggedAt_ -- time when action was performed