Autogenerate services.m3o.com (#37)

* Autogenerate services.m3o.com * Openapi for all * Gen * Fix * Whaat * Fix dep * Fix * Hmm * Install make * Debug * Debug 1 * Location -> locations * Fix * Intall protoc gen micro * F * F * F * Push * Rename secret * Fix npm install * Fix script * Fix v2 * Ignore errors * Ignore v2 * F * F * F * Docs index * Add hugo theme * Hugo tania fixes * Change gen * Change gen 2 * Install hugo * Change gen * Gen fix * Change hugo install * Change hugo install * CNAME * Change articles wording * Tiny fix * Fix gen * Redoc it all * Fix gen * Fixing up protos * Fix proto * Fix gen * Fix * Trigger build * Fix copy * Openapi docs * Flatten * Changes * No date vol2 * Changes * Add make to chat * Fixes * Change * api spec * replace RSS * fix link * Dont continue on error * increase the width * use micro at master * change box colours * move some things * Pushing new readmes to see how they look like * Add skip file * Readmes * Nicer api link * Remove stutter * FIx mistake * set service font weight * Messages readme fix * add other font bold * Notes * Remove post from url * Revert "Remove post from url" This reverts commit 5fea2c23d0bafa910f5dc4d4cc63f71f578530e3. * move exampleSite to site * replace exampleSite with site * update readme * use filename for post * update index * Add source urls * set source as params * set source as params * Fix entries * Generator in go * Fixes to generator * F * Change doc gen * FIx cname * Fixing protos * Change to makefiles * Fix gen script Co-authored-by: Asim Aslam <asim@aslam.me>
2026-01-11 19:04:35 +00:00 · 2021-01-19 16:59:25 +00:00
parent ec81db0753
commit 40b71a9cf9
174 changed files with 10914 additions and 3157 deletions
--- a/chat/README.md
+++ b/chat/README.md
@@ -1,14 +1,25 @@
-# Chat Service
-
 The chat service is an example Micro service which leverages bidirectional streaming, the store and events to build a chat backend. There is both a server and client which can be run together to demonstrate the application (see client/main.go for more instructions on running the service).

+# Chat Service
+
 The service is documented inline and is designed to act as a reference for the events package.

-### Calling the service
+## Create a chat

-You can call the service via the CLI:
+### cURL
+
+```bash
+> curl 'https://api.m3o.com/chat/New' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"user_ids":["JohnBarry"]}';
+{
+	"chat_id": "3c9ea66c-d516-45d4-abe8-082089e18b27"
+}
+```
+
+### CLI

-Create a chat:
 ```bash
 > micro chat new --user_ids=JohnBarry
 {
@@ -16,13 +27,49 @@ Create a chat:
 }
 ```

-Send a message to the chat:
+## Send a message to the chat
+
+### cURL
+
+```bash
+> curl 'https://api.m3o.com/chat/Send' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"user_id": "John", "subject": "Hello", "text": "Hey Barry"}';
+{}
+```
+
+### CLI
+
 ```bash
 > micro chat send --chat_id=bed4f0f0-da12-46d2-90d2-17ae1714a214 --user_id=John --subject=Hello --text='Hey Barry'
 {}
 ```

-View the chat history
+## View the chat history
+
+### cURL
+
+```bash
+> curl 'https://api.m3o.com/chat/Send' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"chat_id": "bed4f0f0-da12-46d2-90d2-17ae1714a214"}';
+{
+	"messages": [
+		{
+			"id": "a61284a8-f471-4734-9192-640d89762e98",
+			"client_id": "6ba0d2a6-96fa-47d8-8f6f-7f75b4cc8b3e",
+			"chat_id": "bed4f0f0-da12-46d2-90d2-17ae1714a214",
+			"user_id": "John",
+			"subject": "Hello",
+			"text": "Hey Barry"
+		}
+	]
+}
+```
+
+### CLI
 ```bash
 > micro chat history --chat_id=bed4f0f0-da12-46d2-90d2-17ae1714a214
 {