...
| Code Block |
|---|
{
"....currently existing fields...":{},
"timeZone":"US/Pacific",
"rounds":[
{
"id":"bcbd1205-80e9-44c5-85e2-dbcb194e5e76",
"roundStart":1231412213213123123,
"roundEnd":"2020-08-11T16:45:10ā08:00",
"submissionLimit":{
"totalSubmissionLimit":20,
"dailySubmissionLimit":2,
"weeklySubmissionLimit":8,
"monthlySubmissionLimit":{
"dayOfMonth":28,
"limit":10
}
}
},
{
"id":"254110e2-aead-4bf8-9ce4-3786be59a497",
"roundStart":1231412213213123123,
"roundEnd":"2020-08-11T16:45:10ā08:00",
"submissionLimit":{
"totalSubmissionLimit":40,
"dailySubmissionLimit":8,
"weeklySubmissionLimit":12,
"monthlySubmissionLimit":{
"dayOfMonth":31,
"limit":20
}
}
}
]
} |
API endpoints
...
Endpoint
...
Request body
...
Description
...
...
existing endpoint to get evaluation
...
...
EvaluationMaintenance
disallows all submissions
only 1 allowed per queue
| Code Block |
|---|
{
"properties": {
"start": {
"type": "string",
"format": "date-time",
"description": "The date/time at which the maintenance begins.",
"required": true
},
"end":{
"type": "string",
"format": "date-time",
"description":"The date/time at which the maintenance ends.",
"required": true
},
}
} |
API Endpoints
Endpoint | Request body | Return Body | Description |
|---|---|---|---|
None | Evaluation | EXISTING endpoint to get evaluation | |
Evaluation | Evaluation | EXISTING endpoint to create an evaluation | |
Evaluation | Evaluation | EXISTING endpoint to update evaluation | |
POST /evaluation/{evalId}/maintainance | EvaluationMaintenance | None or EvaluationMaintenance | Schedule a maintainance. Additional calls will override the existing maintenance window |
DELETE /evaluation/{evalId}/maintainance | None | None | Delete the existing maintenance window, if any |
API/Database Transition
A SubmissionQuota can easily be mapped into into a list of SubmissionRounds using math, but the reverse is not true.
For the time being, Iām considering making the old deprecated quota field remain stored in the database, but enforce a rule such that user must choose between quota and rounds when configuring a Evaluation. This allows time for clients to implement support for the new rounds field.
Once we fully decide to remove SubmissionQuota, we can perform the conversion and store quotas asSubmissionRound.