From 692d980c32f00a13148350d96003230d9a0d1dfb Mon Sep 17 00:00:00 2001 From: Paul Fauchon Date: Wed, 26 Jun 2024 16:16:35 +0800 Subject: [PATCH] add history endpoint to authenticated-endpoints.md (#433) --- docs/api/authenticated-endpoints.md | 30 +++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/docs/api/authenticated-endpoints.md b/docs/api/authenticated-endpoints.md index 4bb54d4..4b6e161 100644 --- a/docs/api/authenticated-endpoints.md +++ b/docs/api/authenticated-endpoints.md @@ -418,3 +418,33 @@ Example request: ``` Returns 204 on success. + +##### GET `/api/v1/auth/history` + +Get the history of videos played by the user. + +Parameters: + +``` +max_results: Int32 +page: Int32 +``` + +> Schema: + +```javascript +[ + // video IDs +] +``` +##### POST `/api/v1/auth/history/:id` + +Set a video as watched. + +Returns 204 on success. + +##### DELETE `/api/v1/auth/history/:id` + +Delete a video from the user watched history. + +Returns 204 on success. \ No newline at end of file