From 289535b4be4a0d4d0f32314e71316e62dd72d2e9 Mon Sep 17 00:00:00 2001 From: Petr Stefan Date: Thu, 24 Nov 2016 15:41:38 +0100 Subject: [PATCH] API in capital letters --- Submission-flow.md | 12 ++++++------ Web-API.md | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Submission-flow.md b/Submission-flow.md index 7936e33..611c950 100644 --- a/Submission-flow.md +++ b/Submission-flow.md @@ -23,15 +23,15 @@ After user submits solution then web application has to hand over all needed inf ## Broker -Broker gets information about new submission from web api. At this point broker has to find suitable worker for execution of this particular submission. When worker is found and is jobless, then broker send detailed submission to worker to evaluation. More detailed description follows: +Broker gets information about new submission from API server. At this point broker has to find suitable worker for execution of this particular submission. When worker is found and is jobless, then broker send detailed submission to worker to evaluation. More detailed description follows: -1. broker gets message from web api about new submission -2. based on information from web api, broker has to choose suitable worker which matches all submission criteria +1. broker gets message from API about new submission +2. based on information from API, broker has to choose suitable worker which matches all submission criteria 1. if suitable worker is not found then broker notices Web API about this information and all execution stops 2. suitable worker is found 1. worker has no jobs at the moment, broker immediately sends job evaluation request to it 2. otherwise evaluation request is queued to this particular worker and waits until all previous jobs are done -3. broker sends prepared evaluation request to worker with all information which was obtained from web api +3. broker sends prepared evaluation request to worker with all information which was obtained from API ## Worker @@ -72,7 +72,7 @@ Broker gets done message from worker and basically only mark submission as done ## Web API -Web api is notified about job status from broker. After that api is deciding if evaluated submission will be evaluated immediately or on demand. But for the sake of simplicity we will consider only immediately evaluated results. More detailed description follows: +Web API is notified about job status from broker. After that API is deciding if evaluated submission will be evaluated immediately or on demand. But for the sake of simplicity we will consider only immediately evaluated results. More detailed description follows: 1. job arrived with successful evaluation status 1. results of evaluation are downloaded from fileserver where it was uploaded by worker and then unzipped @@ -84,7 +84,7 @@ Web api is notified about job status from broker. After that api is deciding if ## Web Application -Web application has only a simple work to do. It has to obtain results from web api. More detailed description follows: +Web application has only a simple work to do. It has to obtain results from web API. More detailed description follows: 1. web application sends request for results of particular submission 2. if results are available then they are sent back to web application and displayed to user diff --git a/Web-API.md b/Web-API.md index 86eb7d6..e0e8195 100644 --- a/Web-API.md +++ b/Web-API.md @@ -121,7 +121,7 @@ Description of configurable items. All timeouts are in milliseconds if not state - ldapConnection -- parameters for connecting to LDAP, _hostname_, _base_dn_, _port_, _security_ and _bindName_ - fields -- names of LDAP keys for informations as _email_, _firstName_ and _lastName_ - emails -- common configuration for sending email (addresses and template variables) - - apiUrl -- base URL of api server including port (for referencing pictures in messages) + - apiUrl -- base URL of API server including port (for referencing pictures in messages) - footerUrl -- link in the message footer - siteName -- name of frontend (ReCodEx, or KSP for unique instance for KSP course) - githubUrl -- URL to GitHub repository of this project