chore(doc): implement remainder of documentation

This commit is contained in:
Paul Makles
2022-03-19 18:19:24 +00:00
parent 43c475eabb
commit 8dd9acdb59
54 changed files with 499 additions and 123 deletions

View File

@@ -10,25 +10,37 @@ use rocket::serde::json::Json;
use serde::{Deserialize, Serialize};
use validator::Validate;
#[derive(Validate, Serialize, Deserialize)]
pub struct Data {
/// # Role Data
#[derive(Validate, Serialize, Deserialize, JsonSchema)]
pub struct DataEditRole {
/// Role name
#[validate(length(min = 1, max = 32))]
name: Option<String>,
/// Role colour
#[validate(length(min = 1, max = 32))]
colour: Option<String>,
/// Whether this role should be displayed separately
hoist: Option<bool>,
/// Ranking position
///
/// Smaller values take priority.
rank: Option<i64>,
/// Fields to remove from role object
#[validate(length(min = 1))]
remove: Option<Vec<FieldsRole>>,
}
/// # Edit Role
///
/// Edit a role by its id.
#[openapi(tag = "Server Permissions")]
#[patch("/<target>/roles/<role_id>", data = "<data>")]
pub async fn req(
db: &Db,
user: User,
target: Ref,
role_id: String,
data: Json<Data>,
data: Json<DataEditRole>,
) -> Result<Json<Role>> {
let data = data.into_inner();
data.validate()
@@ -44,7 +56,7 @@ pub async fn req(
let member_rank = permissions.get_member_rank().unwrap_or(i64::MIN);
if let Some(mut role) = server.roles.remove(&role_id) {
let Data {
let DataEditRole {
name,
colour,
hoist,