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-16 21:14:36 +00:00 · 2021-01-19 16:59:25 +00:00
parent ec81db0753
commit 40b71a9cf9
174 changed files with 10914 additions and 3157 deletions
--- a/posts/README.md
+++ b/posts/README.md
@@ -0,0 +1,90 @@
+The post service is responsible for storing and querying posts by their slugs or IDs. Posts support tags and metadata, for details see `posts.proto`.
+
+# Post Service
+
+## Create a post
+
+### cURL
+
+```shell
+> curl 'https://api.m3o.com/posts/Save' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"post":{"id":"1","title":"How to Micro","content":"Simply put, Micro is awesome."}}';
+
+> curl 'https://api.m3o.com/chat/Save' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"post":{"id":"2","title":"Fresh posts are fresh","content":"This post is fresher than the How to Micro one"}}';
+```
+
+### CLI
+
+```shell
+micro call posts Posts.Save '{"post":{"id":"1","title":"How to Micro","content":"Simply put, Micro is awesome."}}'
+
+micro call posts Posts.Save '{"post":{"id":"2","title":"Fresh posts are fresh","content":"This post is fresher than the How to Micro one"}}'
+```
+
+## Create a post with tags
+
+
+### cURL
+
+```shell
+> curl 'https://api.m3o.com/posts/Save' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"post":{"id":"3","title":"How to do epic things with Micro","content":"Everything is awesome.","tagNames":["a","b"]}}';
+```
+
+### CLI
+
+```shell
+micro call posts Posts.Save '{"post":{"id":"3","title":"How to do epic things with Micro","content":"Everything is awesome.","tagNames":["a","b"]}}'
+```
+
+## Query posts
+
+### cURL
+
+```shell
+# Query all
+> curl 'https://api.m3o.com/posts/Query' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{}';
+
+# Query by slug
+> curl 'https://api.m3o.com/posts/Query' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"slug":"how-to-micro"}';
+
+# Limit and offset
+> curl 'https://api.m3o.com/posts/Query' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"offset": 10, "limit": 10}';
+```
+
+### CLI
+
+```shell
+micro call posts Posts.Query '{}'
+micro call posts Posts.Query '{"slug":"how-to-micro"}'
+micro call posts Posts.Query '{"offset": 10, "limit": 10}'
+```
+
+## Delete posts
+
+```shell
+> curl 'https://api.m3o.com/posts/Delete' \
+  -H 'micro-namespace: $yourNamespace' \
+  -H 'authorization: Bearer $yourToken' \
+  -d '{"id": "3c9ea66c"}';
+```
+
+```shell
+micro call posts Posts.Delete '{"id": "3c9ea66c"}'
+```