server: add routes to md

2026-06-03 01:17:31 +00:00
parent 92ddff0917
commit 007e61bca1
5 changed files with 172 additions and 0 deletions
@@ -0,0 +1,150 @@
+# git.dubyatp.xyz/williamp/scannerbot
+
+ScannerBot Server API routes
+
+## Routes
+
+<details>
+<summary>`/`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/**
+	- _GET_
+		- [Start.func1]()
+
+</details>
+<details>
+<summary>`/channels`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/channels**
+	- [SessionAuthMiddleware]()
+	- **/**
+		- _GET_
+			- [ListChannels]()
+		- _POST_
+			- [NewChannel]()
+
+</details>
+<details>
+<summary>`/channels/{channelID}`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/channels**
+	- [SessionAuthMiddleware]()
+	- **/{channelID}**
+		- **/**
+			- _DELETE_
+				- [DeleteChannel]()
+			- _GET_
+				- [GetChannel]()
+
+</details>
+<details>
+<summary>`/channels/{channelID}/messages`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/channels**
+	- [SessionAuthMiddleware]()
+	- **/{channelID}**
+		- **/messages**
+			- **/**
+				- _GET_
+					- [ListMessages]()
+
+</details>
+<details>
+<summary>`/channels/{channelID}/messages/{messageID}`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/channels**
+	- [SessionAuthMiddleware]()
+	- **/{channelID}**
+		- **/messages**
+			- **/{messageID}**
+				- **/**
+					- _GET_
+						- [GetMessage]()
+
+</details>
+<details>
+<summary>`/files/{fileID}`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/files**
+	- [SessionAuthMiddleware]()
+	- **/{fileID}**
+		- **/**
+			- _GET_
+				- [ServeFile]()
+
+</details>
+<details>
+<summary>`/login`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/login**
+	- **/**
+		- _POST_
+			- [Login]()
+
+</details>
+<details>
+<summary>`/logout`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/logout**
+	- [SessionAuthMiddleware]()
+	- **/**
+		- _POST_
+			- [Logout]()
+
+</details>
+<details>
+<summary>`/register`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/register**
+	- **/**
+		- _POST_
+			- [NewUser]()
+
+</details>
+<details>
+<summary>`/users`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/users**
+	- [SessionAuthMiddleware]()
+	- **/**
+		- _GET_
+			- [ListUsers]()
+
+</details>
+<details>
+<summary>`/users/{userID}`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/users**
+	- [SessionAuthMiddleware]()
+	- **/{userID}**
+		- **/**
+			- _GET_
+				- [GetUser]()
+
+</details>
+<details>
+<summary>`/whoami`</summary>
+
+- [o-chi/cors.(*Cors).Handler-fm]()
+- **/whoami**
+	- [SessionAuthMiddleware]()
+	- [LoginCtx]()
+	- **/**
+		- _GET_
+			- [Whoami]()
+
+</details>
+
+Total # of routes: 12
+