codalab / codalab/codabench

Submissions API architecture

Open
#2,497 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
176
Forks
74
Avg merge
5d 3h
Merged PRs (30d)
21

Description

When you want to upload a submission, it is done is 2 steps:

  1. First a zip file is uploaded using data api
  2. Second the id of the data is used in creating submission.
Problem

In some cases the data upload is successful but the submission creation fails because of some reasons e.g. daily limit is used, phase is not active etc.

Possible solution

Submission api should be one end point that handles both data creation and submission creation. 2 apis for one task sometimes result in inconsistencies.

Note

Other apis e.g. competition creation could have the same problem. To be checked

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the data API upload flow and the submission creation API entry point, then compare their failure cases such as daily limits and inactive phases. Review whether competition creation has the same two-step pattern. Done means the endpoint architecture and consistency requirements are agreed and implemented for submissions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.