lichess-org/api

Improvement - Board API restrictions (time control) info at each relevant endpoint

tors42 opened this issue ยท 0 comments

Logging this issue based on discussion - https://discord.com/channels/280713822073913354/693123750845218836/1123948648896667728

It is easy to not read the entire documentation... ๐Ÿ˜…
Sometimes one skims the documentation and finds the endpoint which seems relevant, and only reads about that endpoint.

Repeating the Board API section notice about restrictions regarding Time Control,
on each endpoint which is affected by the Time Control restriction could help people from pulling their hair... ๐Ÿ˜…

These are the endpoints I suspect involve Time Control when using the Board API / a token with "board:play" scope:

https://lichess.org/api#tag/Board/operation/apiBoardSeek
https://lichess.org/api#tag/Challenges/operation/challengeCreate
https://lichess.org/api#tag/Challenges/operation/challengeAi
https://lichess.org/api#tag/Challenges/operation/challengeAccept