Implement missing API endpoints

benediktwerner commented 1 year ago

The list below shows API endpoints that are currently still missing from berserk (generated by the check-endpoints.py script).

Feel free to choose any one and implement it.

See https://github.com/lichess-org/berserk/tree/master/berserk/clients for existing endpoint implementations.

New endpoints should have their responses typed. See https://github.com/lichess-org/berserk/blob/master/berserk/clients/opening_explorer.py/#L35 for an example of how to type dictionary responses.

For more info on the details of any specific endpoint, see https://lichess.org/api.

Also see the Get Started contributing section.

[x] /api/board/game/{gameId}/claim-victory
[x] /api/broadcast
[x] /api/broadcast/round/{broadcastRoundId}.pgn
[x] /api/broadcast/{broadcastTournamentId}.pgn
[x] /api/bulk-pairing
[x] /api/bulk-pairing/{id}
[x] /api/bulk-pairing/{id}/start-clocks
[x] /api/challenge
[x] /api/challenge/{challengeId}/cancel
[x] /api/challenge/{gameId}/start-clocks
[x] /api/cloud-eval
[x] /api/external-engine
[x] /api/external-engine/{id}
[x] /api/player
[x] /api/player/autocomplete
[x] /api/player/top/{nb}/{perfType}
[x] /api/puzzle/daily
[x] /api/puzzle/dashboard/{days}
[x] /api/racer
[x] /api/round/{gameId}/add-time/{seconds}
[x] /api/storm/dashboard/{username}
[x] /api/stream/broadcast/round/{broadcastRoundId}.pgn
[x] /api/streamer/live
[x] /api/swiss/{id}
[x] /api/swiss/{id}/edit
[x] /api/swiss/{id}/join
[x] /api/swiss/{id}/results
[x] /api/swiss/{id}/schedule-next-round
[x] /api/swiss/{id}/terminate
[x] /api/swiss/{id}/withdraw
[x] /api/team/all
[x] /api/team/of/{username}
[x] /api/team/search
[x] /api/team/{teamId}
[x] /api/team/{teamId}/request/{userId}/accept
[x] /api/team/{teamId}/request/{userId}/decline
[x] /api/team/{teamId}/requests
[ ] ~~/api/token~~ Do not implement for the moment https://github.com/lichess-org/berserk/pull/55
[x] /api/token/admin-challenge
[x] /api/tournament/team-battle/{id}
[x] /api/tournament/{id}/join
[x] /api/tournament/{id}/teams
[x] /api/tournament/{id}/terminate
[x] /api/tournament/{id}/withdraw
[x] /broadcast/{broadcastTournamentId}/edit
[x] ~~/oauth~~ Do not implement for the moment https://github.com/lichess-org/berserk/pull/55
[x] /study/by/{username}/export.pgn
[x] /swiss/{id}.trf
[x] /team/{teamId}/pm-all
[ ] https://engine.lichess.ovh/api/external-engine/work check feedback given in https://github.com/lichess-org/berserk/pull/66 before
[ ] https://engine.lichess.ovh/api/external-engine/work/{id} check feedback given in https://github.com/lichess-org/berserk/pull/66 before
[ ] https://engine.lichess.ovh/api/external-engine/{id}/analyse check feedback given in https://github.com/lichess-org/berserk/pull/66 before
[x] https://explorer.lichess.ovh/lichess
[ ] https://explorer.lichess.ovh/lichess/history (to be confirmed)
[x] https://explorer.lichess.ovh/master/pgn/{gameId}
[x] https://explorer.lichess.ovh/masters
[x] https://tablebase.lichess.ovh/antichess
[x] https://tablebase.lichess.ovh/atomic
[x] https://tablebase.lichess.ovh/standard

Virinas-code commented 1 year ago

I might start working on this issue, thanks for the list!

AKBuggy commented 1 year ago

@Virinas-code May I work with you on this. I want to learn how you are implementing.

Virinas-code commented 1 year ago

Literrally copy pasting code and changing endpoints and docs...

Virinas-code commented 1 year ago

(I'm testing it after. It isn't that hard to understand, you just need a bit of python knowledge.)

AKBuggy commented 1 year ago

Yes, I realise that since I am doing it for the first time, I am a little unsure on how to determine whether the code is functioning. I don't just mean coding; I mean the entire process. That's why I am requesting you, if possible, please teach me. Thank you.

thegrapesoda commented 1 year ago

@Virinas-code - do you have plans to implement /api/broadcast? If not, I have an implementation ready to go.

Virinas-code commented 1 year ago

If you have an implementation add it then, I'm not working on berserk right now, but I'll get back to it.

Virinas-code commented 1 year ago

I'll get back to berserk dev soon. What should I start with?

benediktwerner commented 1 year ago

I'd say just pick any endpoint or group of endpoints that sound useful or interesting.

Virinas-code commented 1 year ago

Ok, gonna fork it again and work on tablebase I think.

Virinas-code commented 1 year ago

I confirm I'm working on it right now.

skanjalkar commented 1 year ago

Hi,

I opened a PR #30 addressing some of these.

shaikhmudassir commented 1 year ago

Hi @benediktwerner I am starting to work on this checklist. Have any changes been made to it? It hasn't been updated since last month. Also, the above link for clients.py is broken.

benediktwerner commented 1 year ago

@shaikhmudassir I updated the list, two more endpoints have been implemented since. Though I guess still check the code before you add any new ones, it's always possible the list isn't 100% accurate. And the clients are now split into multiple files, I changed the link to the directory instead.

rpesche commented 1 year ago

I implemented one opening explorer endpoints: https://github.com/lichess-org/berserk/pull/32

Virinas-code commented 1 year ago

#43 Adding bulk pairing endpoints

[x] GET /api/bulk-pairing
[x] POST /api/bulk-pairing
[x] POST /api/bulk-pairing/{id}/start-clocks
[x] DEL /api/bulk-pairing/{id}

No new tests were implemented. See #43 for more informations.

Virinas-code commented 1 year ago

What is the /api/racer endpoint? I can't find it in the docs.

benediktwerner commented 1 year ago

https://lichess.org/api#tag/Puzzles/operation/racerPost

Anupya commented 1 year ago

A majority of the still unchecked items (as of Nov 2nd 2023, 7:46 pm ET) have already been implemented and exist!

Here's what's still left:

/api/cloud-eval
/api/token (I think this cannot be implemented due to #55)
/broadcast/{broadcastTournamentId}/edit (there's a clients.broadcasts.update already but the path is /broadcast/{slug}/{broadcast_id} which does not exist anymore in the API docs)
/swiss/{id}.trf
https://engine.lichess.ovh/api/external-engine/work
https://engine.lichess.ovh/api/external-engine/work/{id}
https://engine.lichess.ovh/api/external-engine/{id}/analyse
https://explorer.lichess.ovh/lichess/history (this does not exist in the API docs)

kraktus commented 1 year ago

thanks, double checked and updated

jacksonthall22 commented 1 year ago

FYI, seems like client.analysis.get_cloud_evaluation() is not implemented (though it says it is in the readme): AttributeError: 'Client' object has no attribute 'analysis'

benediktwerner commented 12 months ago

That wasn't released yet, I released v0.13.2 with the recent changes.

rdev99 commented 8 months ago

Is this issue still open ?

If its open, how much api's are left

kraktus commented 8 months ago

Is this issue still open ?

If its open, how much api's are left

Hey, yes the endpoints not ticked are left to grab .

rdev99 commented 8 months ago

Thanks, I will work on it if anyone else is not working

kraktus commented 8 months ago

Cool, if you want to implement external-engine endpoints, make sure to check feedback given in #66 before

rdev99 commented 8 months ago

Hey,

I think these api's are already completed in the code but not ticked here.

https://explorer.lichess.ovh/master/pgn/{gameId}
https://explorer.lichess.ovh/masters

Also what is to be confirmed in https://explorer.lichess.ovh/lichess/history

FriedrichtenHagen commented 1 month ago

@kraktus I opened a pr that implements the advice given in #66. Could you take a look?

lichess-org / berserk

Implement missing API endpoints #6

#43 Adding bulk pairing endpoints