From cbf9be31dce67d487015bb24b36330b261196c1e Mon Sep 17 00:00:00 2001
From: Matthew Tave <tavematthew@gmail.com>
Date: Fri, 9 Feb 2024 15:25:09 -0500
Subject: [PATCH] Added documentation for the /broadcast/by/:user endpoint

---
 doc/specs/lichess-api.yaml                    |  3 ++
 .../tags/broadcasts/broadcast-by-user.yaml    | 28 +++++++++++++++++++
 2 files changed, 31 insertions(+)
 create mode 100644 doc/specs/tags/broadcasts/broadcast-by-user.yaml

diff --git a/doc/specs/lichess-api.yaml b/doc/specs/lichess-api.yaml
index 1848d86..0d2d6c2 100644
--- a/doc/specs/lichess-api.yaml
+++ b/doc/specs/lichess-api.yaml
@@ -426,6 +426,9 @@ paths:
   /broadcast/new:
     $ref: './tags/broadcasts/broadcast-new.yaml'
 
+  /broadcast/by/{username}:
+    $ref: './tags/broadcasts/broadcast-by-user.yaml'
+
   /broadcast/{slug}/{broadcastTournamentId}:
     $ref: './tags/broadcasts/broadcast-slug-broadcastTournamentId.yaml'
 
diff --git a/doc/specs/tags/broadcasts/broadcast-by-user.yaml b/doc/specs/tags/broadcasts/broadcast-by-user.yaml
new file mode 100644
index 0000000..d1a4f66
--- /dev/null
+++ b/doc/specs/tags/broadcasts/broadcast-by-user.yaml
@@ -0,0 +1,28 @@
+get:
+  operationId: broadcastByUser
+  summary: Get broadcasts by a user
+  description: |
+    Returns all of the tournaments being broadcast by a user. Results are paginated.
+  tags:
+    - Broadcasts
+  security: []
+  parameters:
+    - in: path
+      name: username
+      required: true
+      schema:
+        type: string
+    - in: path
+      name: page
+      required: false
+      description: Selects the desired page of results.
+      schema:
+        type: integer
+        minimum: 1
+        maximum: 19
+        default: 1
+  responses:
+    "200":
+      description: The list of tournaments being broadcast by a user. Returns html for the webpage that shows all tournaments that are being broadcast by the user.
+      content:
+        text/html: any