Document flair and description parameters of POST /api/study. - #664
Merged
ornicar merged 3 commits intoJul 29, 2026
Merged
Conversation
Contributor
|
Thanks. I think we should turn that into a boolean rather than solidifying it in documentation. It was a string to allow more values but it didn't prove to be useful. |
Contributor
Author
Ok, will do. Do you want me to also do the same for |
Contributor
|
Yes please |
ornicar
added a commit
to lichess-org/lila
that referenced
this pull request
Jul 29, 2026
ornicar
added a commit
to lichess-org/lila
that referenced
this pull request
Jul 29, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR documents the final two missing parameters of the
POST /api/study:Note that in the backend code
descriptionis an optional string that can currently betrueorfalse(or actuallytrueand<something else>IIUC), hence why I didn't choose a boolean. This behavior is similar to the already documentstickyparameter. But suggestions welcome of course. EDIT: changed to boolean.