docs: partially document codebase
All checks were successful
ci/woodpecker/push/build-and-publish Pipeline was successful
All checks were successful
ci/woodpecker/push/build-and-publish Pipeline was successful
Should make it easier for frontend to figure out what stuff actually does, more will be added as the project goes on
This commit is contained in:
parent
1aa38631b8
commit
16ccf94631
10 changed files with 226 additions and 18 deletions
|
@ -1,4 +1,4 @@
|
|||
//! Contains endpoint related to guild memberships
|
||||
//! `/api/v1/me/servers` Contains endpoint related to guild memberships
|
||||
|
||||
use actix_web::{get, web, HttpRequest, HttpResponse};
|
||||
|
||||
|
@ -7,14 +7,24 @@ use crate::{api::v1::auth::check_access_token, error::Error, structs::Me, utils:
|
|||
|
||||
/// `GET /api/v1/me/servers` Returns all guild memberships in a list
|
||||
///
|
||||
/// Example Response:
|
||||
/// requires auth: yes
|
||||
///
|
||||
/// ### Example Response
|
||||
/// ```
|
||||
/// json!({
|
||||
/// "uuid": "22006503-fb01-46e6-8e0e-70336dac6c63",
|
||||
/// "nickname": "This field is nullable",
|
||||
/// "user_uuid": "522bca17-de63-4706-9d18-0971867ad1e0",
|
||||
/// "guild_uuid": "0911e468-3e9e-47bf-8381-59b30e8b68a8"
|
||||
/// });
|
||||
/// json!([
|
||||
/// {
|
||||
/// "uuid": "22006503-fb01-46e6-8e0e-70336dac6c63",
|
||||
/// "nickname": "This field is nullable",
|
||||
/// "user_uuid": "522bca17-de63-4706-9d18-0971867ad1e0",
|
||||
/// "guild_uuid": "0911e468-3e9e-47bf-8381-59b30e8b68a8"
|
||||
/// },
|
||||
/// {
|
||||
/// "uuid": "bf95361e-3b64-4704-969c-3c5a80d10514",
|
||||
/// "nickname": null,
|
||||
/// "user_uuid": "522bca17-de63-4706-9d18-0971867ad1e0",
|
||||
/// "guild_uuid": "69ec2ce5-3d8b-4451-b644-c2d969905458"
|
||||
/// }
|
||||
/// ]);
|
||||
/// ```
|
||||
/// NOTE: UUIDs in this response are made using `uuidgen`, UUIDs made by the actual backend will be UUIDv7 and have extractable timestamps
|
||||
#[get("/servers")]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue