+ Badge structure docs

Also this is a new pattern but I'm going to start actually using those anchor tags
to self link to other places in the page.

+ /badge/new endpoint docs
+ /badge/delete endpoint docs
+ /badge/update/name endpoint docs
+ /badge/update/color endpoint docs
+ /badge/update/perms endpoint docs

! Small point but apparantly this layout is somewhat printer friendly
:^) Just thought that was kinda neat.
This commit is contained in:
shockrah
2021-07-01 21:09:26 -07:00
parent 995717afb3
commit a69ad24a45
4 changed files with 153 additions and 1 deletions

View File

@@ -0,0 +1,14 @@
---
title: Badges
anchor: badges
weight: 55
---
Name | Type
:--------:|:-------:
`name` | `String`
`id` | `u64`
`color` | `u32`
`perms` | `u64`

View File

@@ -13,6 +13,7 @@ Channels are made up of the following components
name | `String`
kind | `i32`
description| `String`
badge\_ids| `Array<u32>`
Channels have two valid types or (more semantically) `kind` values:

View File

@@ -14,10 +14,11 @@ Name | Type
secret | `String`
status | `i32`
permissions| `u64`
badge\_ids | `Array<u32>`
### JWT
This data is retrieved after a sucessful `/login` hit.
This data is retrieved after a successful `/login` hit.
Name | Type
:-----:|:------:
@@ -31,6 +32,7 @@ This data is retrieved after a sucessful `/login` hit.
name | `String`
status | `i32`
permissions| `u64`
badge\_ids | `Array<u32>`
For users _without_ the `USER_FETCH` permission the only two fields with actual data is `id` and `name`. The other fields will be set to 0.