Live Matches In Club Matches Endpoint: Documentation Out Of Date?

Sort:
stephen_33

I'm not sure how widely known it is that a club's Live team matches are now included at the end of the list of 'finished' matches in the club matches endpoint? You'd certainly be forgiven for missing this after reading the documentation:-


Club Matches

Description: List of daily and club matches, grouped by status (registered, in progress, finished).
URL pattern: https://api.chess.com/pub/club/{ID}/matches

{
    "finished": [
        /** List of matches */
        {
            "name": "match name", //the team match name
            "@id": "URL", // URL pointing to the team match endpoint
            "opponent": "https://api.chess-dev.com/pub/club/testing-teams", // URL pointing to the opponent club endpoint
            "result": "win", // see "Game results codes" section
            "start_time": 1305324926, // timestamp of the match start
            "time_class": "daily"
        }
    ],
    "in_progress": [
        /** List of matches */
       

I completely missed what was meant by 'List of daily and club matches' & wasted some time trying to obtain useful Live match data by other means. And the "time_class" of "daily" gives the clear impression that only Daily matches are included.

So could the documentation please be updated to reflect the fact that both Daily & Live matches are included within the 'finished' category? 

Tricky_Dicky

Useful. Thanks

stephen_33

It's difficult for users of the API to derive full benefit if the documentation isn't up to date. Over the two years or so since the API was released to members, I've noticed quite a few complaints about errors, or lack of detail, in the documentation.

It's great to see the API being expanded further to offer new features but much of that effort is going to be wasted if the documentation isn't amended at the same time!

I noticed that the CHANGELOG hasn't been updated in some time. Is it possible that changes could be posted there because it's a useful first port of call?

Tricky_Dicky

I agree but I don't think staff will see this

stephen_33
Tricky_Dicky wrote:

I agree but I don't think staff will see this

I thought @bcurtis kept an eye on topics because I sometimes see him commenting.

Do I need to PM him?

Tricky_Dicky

Probably best. All dev staff have been swamped this year.

bcurtis

We'll be revising all of it in the coming year, I hope. Depends a lot on how traffic impacts priorities over the next month.

I know some of you have been keeping forum threads going about documentation errata. It's a little presumptuous of me, but if someone could volunteer to compile all the needed changes in one place and get feedback from the key users, then message me, I can get this updated. Right now, we can't muster the hours it would take to read through it all to become as familiar with the shortcomings as you all already are — but cutting and pasting should be easy enough. Let me know. I'd like the API to be as useful as possible.