Skip to content

Commit f93f1cc

Browse files
committed
Automatic documentation generation proof-of-concept
1 parent cb51940 commit f93f1cc

File tree

14 files changed

+462
-94
lines changed

14 files changed

+462
-94
lines changed

Cargo.lock

Lines changed: 101 additions & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ enum_dispatch = "0.3.8"
3131
async-trait = "0.1.66"
3232
reqwest = { version = "0.11.17", features = ["json"] }
3333
rocket_cors = "0.6.0"
34+
rocket_okapi = { version = "0.8.0", features = ["rapidoc", "swagger"] }

src/database/models/level.rs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
use mars_api_rs_macro::IdentifiableDocument;
21
use mars_api_rs_derive::IdentifiableDocument;
3-
use serde::{Serialize, Deserialize};
2+
use mars_api_rs_macro::IdentifiableDocument;
3+
use rocket_okapi::okapi::schemars;
4+
use schemars::JsonSchema;
5+
use serde::{Deserialize, Serialize};
46

57
use crate::database::CollectionOwner;
68

7-
use super::{r#match::GoalCollection, player::{PlayerRecord, ProjectileRecord, FirstBloodRecord}};
9+
use super::{player::{FirstBloodRecord, PlayerRecord, ProjectileRecord}, r#match::GoalCollection};
810

911
#[derive(Serialize, Deserialize, IdentifiableDocument)]
1012
#[serde(rename_all = "camelCase")]
@@ -77,7 +79,7 @@ pub struct LevelContributor {
7779
contribution: Option<String>
7880
}
7981

80-
#[derive(Debug, Serialize, Deserialize, Clone, strum_macros::EnumProperty, Hash, PartialEq, Eq)]
82+
#[derive(Debug, Serialize, Deserialize, JsonSchema, Clone, strum_macros::EnumProperty, Hash, PartialEq, Eq)]
8183
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
8284
#[strum(serialize_all = "SCREAMING_SNAKE_CASE")]
8385
pub enum LevelGamemode {

0 commit comments

Comments
 (0)