cdoc-base 0.10.0-alpha.1

Base type definitions for the Courses ecosystem.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct NodeDef {
    pub name: String,
    pub description: String,
    pub parameters: Vec<Parameter>,
    pub children: bool,
    pub templates: HashMap<String, String>,
    pub examples: Vec<UsageExample>,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct UsageExample {
    pub title: String,
    pub body: String,
}

#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Parameter {
    pub name: String,
    #[serde(default)]
    pub description: String,
    #[serde(rename = "type")]
    pub type_: String,
    #[serde(default)]
    pub optional: bool,
}

#[derive(Deserialize)]
pub struct ParameterType {}