API Endpoint for creating contests

[chipbell4]

I would assume we would pass the API Key as a header: X-Judge-API-Key: ABC123, and then the POST body might contain something like:

{
    "name": "Practice 1/2/2018",
    "starts_at": "2018-01-02 01:02:03-05:00",
    "ends_at": "2018-01-02 01:02:03-05:00",
    "problems": [
        {
            "name" : "Problem A",
            "judging_input": "RAW TEXT",
            "judging_output": "RAW TEXT"
        },
        ...
    ]
}

Response value should probably be a 200:

{
    "contest_id": 234,
    "problem_id": [2, 5, ...]
}

where the problem ids are in the order of the problems you provided.

Validation should require at least one problem, and all fields to be provided. This endpoint is useless if there's no contest problems created

And the endpoint should maybe live at POST /api/v1/contests

[ssfinney]

Just curious, is there any advantage to passing the API key through the header instead of through the POST body?

[chipbell4]

Well, I think it creates a faux "separation of concerns" where the POST body contains new contest information, and the header represents "metadata" about the request, including who's creating it. This also aligns with OAuth. That's the ideal authentication method, but it's a lot of work for this tiny thing.

[ssfinney]

Gotcha, sounds good.

[ssfinney]

@chipbell4 It's worth noting that Laravel Passport can create and handle API keys for you using JWT tokens in the HTTP requests.

It's only for Laravel 5.3+ though. Any interest in updating this repo to L5? Or would you rather not risk breaking/complicating stuff?

I was thinking of tackling this, but wanted to ask your opinion of that ^ first.

[chipbell4]

I think the app should be updated for laravel 5, although I'm not sure about the JWT tokens... yet...

…

On Apr 21, 2017 8:05 PM, "Stephen Finney" ***@***.***> wrote: @chipbell4 <https://github.com/chipbell4> It's worth noting that Laravel Passport <https://github.com/laravel/passport> can create and handle API keys for you using JWT tokens in the HTTP requests. It's only for Laravel 5.3+ though. Any interest in updating this repo to L5? Or would you rather not risk breaking/complicating stuff? I was thinking of tackling this, but wanted to ask your opinion of that ^ first. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#102 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AChRmaXNW-8_ympw4Lio0nzVkhyGxkHiks5ryUQwgaJpZM4L-MJG> .

[ssfinney]

@chipbell4 Hey dude! Just stopping by to see how Judge is going. Let me know if you'd like to revisit any of these items. I've been tinkering on our repos lately so I thought of this one.