87 lines
2 KiB
Rust
87 lines
2 KiB
Rust
mod util;
|
|
use schemars::JsonSchema;
|
|
use util::*;
|
|
|
|
#[allow(dead_code)]
|
|
#[derive(JsonSchema)]
|
|
/**
|
|
# This is the struct's title
|
|
|
|
This is the struct's description.
|
|
*/
|
|
struct MyStruct {
|
|
/// # An integer
|
|
my_int: i32,
|
|
my_undocumented_bool: bool,
|
|
/// A unit struct instance
|
|
my_unit: MyUnitStruct,
|
|
#[doc = concat!("# Documented ", "bool")]
|
|
#[doc = concat!("This bool is documented")]
|
|
my_documented_bool: bool,
|
|
}
|
|
|
|
/// # A Unit
|
|
#[derive(JsonSchema)]
|
|
struct MyUnitStruct;
|
|
|
|
#[allow(dead_code)]
|
|
#[doc = " # This is the enum's title "]
|
|
#[doc = " This is "]
|
|
#[derive(JsonSchema)]
|
|
#[doc = " the enum's description."]
|
|
enum MyEnum {
|
|
UndocumentedUnit,
|
|
UndocumentedUnit2,
|
|
/// This comment is included in the generated schema :)
|
|
DocumentedUnit,
|
|
/// ## Complex variant
|
|
/// This is a struct-like variant.
|
|
Complex {
|
|
/// ### A nullable string
|
|
///
|
|
/// This field is a nullable string.
|
|
///
|
|
/// This
|
|
///is
|
|
/// the second
|
|
/// line!
|
|
///
|
|
///
|
|
///
|
|
///
|
|
/// And this is the third!
|
|
my_nullable_string: Option<String>,
|
|
},
|
|
}
|
|
|
|
#[test]
|
|
fn doc_comments_struct() -> TestResult {
|
|
test_default_generated_schema::<MyStruct>("doc_comments_struct")
|
|
}
|
|
|
|
#[test]
|
|
fn doc_comments_enum() -> TestResult {
|
|
test_default_generated_schema::<MyEnum>("doc_comments_enum")
|
|
}
|
|
|
|
/// # OverrideDocs struct
|
|
/// This description should be overridden
|
|
#[allow(dead_code)]
|
|
#[derive(JsonSchema)]
|
|
#[schemars(description = "New description")]
|
|
struct OverrideDocs {
|
|
/// # Overridden
|
|
#[schemars(title = "My integer", description = "This is an i32")]
|
|
my_int: i32,
|
|
/// # Overridden
|
|
/// Also overridden
|
|
#[schemars(title = "", description = "")]
|
|
my_undocumented_bool: bool,
|
|
#[schemars(title = concat!("Documented ", "bool"), description = "Capitalized".to_uppercase())]
|
|
my_documented_bool: bool,
|
|
}
|
|
|
|
#[test]
|
|
fn doc_comments_override() -> TestResult {
|
|
test_default_generated_schema::<OverrideDocs>("doc_comments_override")
|
|
}
|