schematools 0.23.1

Tools for codegen, preprocessing and validation of json-schema and openapi spec
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

use crate::error::Error;
use crate::process::name::jsonschema;
use crate::{schema::Schema, scope::SchemaNamingStrategy, scope::SchemaScope, tools};
use serde_json::Value;

use super::endpoint;

pub struct OpenapiNamer;

pub struct OpenapiNamerOptions {
    pub resource_method_version: bool,
    pub overwrite: bool,
    pub overwrite_ambiguous: bool,
    pub naming_strategy: SchemaNamingStrategy,
}

impl OpenapiNamer {
    pub fn options() -> OpenapiNamerOptions {
        OpenapiNamerOptions {
            resource_method_version: false,
            overwrite: false,
            overwrite_ambiguous: false,
            naming_strategy: SchemaNamingStrategy::Default,
        }
    }
}

impl OpenapiNamerOptions {
    pub fn with_overwrite(&mut self, value: bool) -> &mut Self {
        self.overwrite = value;
        self
    }

    pub fn with_overwrite_ambiguous(&mut self, value: bool) -> &mut Self {
        self.overwrite_ambiguous = value;
        self
    }

    pub fn with_resource_method_version(&mut self, value: bool) -> &mut Self {
        self.resource_method_version = value;
        self
    }

    pub fn with_naming_strategy(&mut self, value: SchemaNamingStrategy) -> &mut Self {
        self.naming_strategy = value;
        self
    }

    pub fn process(&self, schema: &mut Schema) -> Result<(), Error> {
        let root = schema.get_body_mut();

        let mut scope = SchemaScope::new(self.naming_strategy.clone());

        tools::each_node_mut(
            root,
            &mut scope,
            "/any:components/any:schemas/definition:*",
            |node, parts, ctx| {
                if let [key] = parts {
                    ctx.glue(key);

                    jsonschema::name_schema(
                        node,
                        ctx,
                        &jsonschema::NamerOptions {
                            overwrite: self.overwrite,
                            overwrite_ambiguous: self.overwrite_ambiguous,
                            base_name: None,
                        },
                    )?;

                    ctx.pop();
                }

                Ok(())
            },
        )?;

        tools::each_node_mut(
            root,
            &mut scope,
            "/any:components/any:responses/definition:*/any:content/any:*/any:schema",
            |node, parts, ctx| {
                if let [key, _] = parts {
                    ctx.glue(key).glue("response");

                    jsonschema::name_schema(
                        node,
                        ctx,
                        &jsonschema::NamerOptions {
                            overwrite: self.overwrite,
                            overwrite_ambiguous: self.overwrite_ambiguous,
                            base_name: None,
                        },
                    )?;

                    ctx.reduce(2);
                }

                Ok(())
            },
        )?;

        tools::each_node_mut(
            root,
            &mut scope,
            "/any:components/any:requestBodies/definition:*/any:content/any:*/any:schema",
            |node, parts, ctx| {
                if let [key, _] = parts {
                    ctx.glue(key).glue("request");

                    jsonschema::name_schema(
                        node,
                        ctx,
                        &jsonschema::NamerOptions {
                            overwrite: self.overwrite,
                            overwrite_ambiguous: self.overwrite_ambiguous,
                            base_name: None,
                        },
                    )?;

                    ctx.reduce(2);
                }

                Ok(())
            },
        )?;

        tools::each_node_mut(
            root,
            &mut scope,
            "/path:paths/any:*/any:*",
            |node, parts, ctx| {
                if let [endpoint, method] = parts {
                    let details = node.as_object_mut().unwrap();

                    match endpoint::Endpoint::new(method.to_string(), endpoint.to_string()) {
                        Ok(endpoint) => {
                            let operation_id =
                                endpoint.get_operation_id(self.resource_method_version);

                            if !details.contains_key("operationId") || self.overwrite {
                                log::debug!("{}/operationId -> {}", ctx, operation_id);
                                details
                                    .insert("operationId".to_string(), Value::String(operation_id));
                            } else {
                                log::debug!("{}/operationId -> using original", ctx);
                            }
                        }
                        Err(e) => log::error!(
                            "/paths/{}/{}: cannot parse endpoint: {}",
                            endpoint,
                            method,
                            e
                        ),
                    }
                }

                Ok(())
            },
        )?;

        Ok(())
    }
}