adds a readme, various corrections in NewNote struct and get_all_ckey(), debug mode in Admin

Author: hry-gh

README.md

@@ -0,0 +1,30 @@
+# cm-api-rs
+
+This is the backend to [cmdb](https://github.com/cmss13-devs/cmdb), to provide Admins with access to database-stored information from outside the game.
+
+## Configuration
+
+### Api.toml
+
+```toml
+[host]
+base_url = "/foobar" // if your api is served on a different route
+
+[topic]
+host = "play.cm-ss13.com:1400" // which game server should be pinged for status updates
+auth = "your-auth-token-here" // the comms key to contact the game server
+
+[logging]
+webhook = "some discord webhook" // for actions impacting the database, a discord webhook
+```
+
+### Rocket.toml
+
+```toml
+[default]
+address = "0.0.0.0"
+port = 8080
+
+[default.databases.cmdb]
+url = "mysql://root:[email protected]:3306/cmdb"
+```

src/admin.rs

@@ -18,6 +18,12 @@ impl<'r> FromRequest<'r> for Admin {
     type Error = AdminError;
 
     async fn from_request(req: &'r Request<'_>) -> request::Outcome<Self, Self::Error> {
+        if cfg!(debug_assertions) {
+            return request::Outcome::Success(Admin {
+                username: "AdminBot".to_string(),
+            });
+        }
+
         let username = match req.headers().get("X-Forwarded-Preferred-Username").next() {
             Some(username) => username,
             None => return request::Outcome::Error((Status::BadRequest, AdminError::Missing)),

src/player.rs

@@ -228,7 +228,7 @@ pub async fn id(mut db: Connection<Cmdb>, id: i32) -> Option<Json<Player>> {
 pub struct NewNote {
     message: String,
     category: i32,
-    confidential: i32,
+    confidential: bool,
 }
 
 #[post("/<id>/Note", data = "<input>")]
@@ -254,7 +254,7 @@ pub async fn new_note(
         id,
         admin_id,
         &input.message,
-        input.confidential > 0,
+        input.confidential,
         input.category,
     )
     .await

src/stickyban.rs

@@ -191,7 +191,7 @@ pub async fn get_matched_ckey(
 
 #[get("/Ckey?<ckey>")]
 pub async fn get_all_ckey(mut db: Connection<Cmdb>, ckey: String) -> Json<Vec<Stickyban>> {
-    let query: Vec<StickybanMatchedCid> =
+    let query: Vec<StickybanMatchedCkey> =
         match query_as("SELECT * FROM stickyban_matched_ckey WHERE ckey = ? AND whitelisted = 0")
             .bind(ckey)
             .fetch_all(&mut **db)