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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
use crate::error::DerefError;
use crate::reference::ReferenceOrExt;
use alloc::boxed::Box;
use alloc::string::String;
use alloc::string::ToString;
use alloc::vec::Vec;
use indexmap::IndexMap;
use openapiv3::*;

/// Extends an openapi spec with a method to dereference all its contents
pub trait SpecExt {
    /// Dereferences all the $ref refences in the OpenAPI description.
    /// Consumes the Spec object and creates a new one with all references resolved
    /// Note that because the inner structures are using `ReferenceOr`
    /// you will still need to use the methods from the `ReferenceOr` extension
    /// to access the data. But these methods will always succeed as all
    /// references have been resolved ahead of time.
    ///
    /// # Panics
    /// This method will panic if the referenced item is not present in the OpenAPI description.
    /// This method will panic AdditionalProperties
    ///
    /// # Example
    ///
    /// ```
    ///   let data = std::fs::read_to_string(filename).expect("OpenAPI file could not be read.");
    ///   let deser = serde_yaml::from_str(&data).expect("Could not deserialize file as OpenAPI v3.0");
    ///   let spec = spec::read(&deser).deref_all();
    ///   let paths = spec.paths;
    /// ```
    fn deref_all(self) -> OpenAPI;
}

impl SpecExt for OpenAPI {
    /// Dereferences all the internal references in a document by copying
    /// the items in the place of the references.
    fn deref_all(mut self) -> OpenAPI {
        if let Some(comp) = self.components.as_ref() {
            for (_, path_item) in &mut self.paths.paths {
                deref_everything_in_path(path_item, comp);
            }
        }
        //    println!("{:?}", spec);
        self
    }
}

fn deref_everything_in_path(path_item: &mut ReferenceOr<PathItem>, components: &Components) {
    let p_item = path_item.to_item_mut(); //TODO: no Deref possible? Where in components?
    set_deref_all_params(&mut p_item.parameters, components);

    let p_item2 = p_item.clone(); // hack as things are used, etc.

    for operation in operation_list(p_item) {
        // inline params
        set_deref_all_params(&mut operation.parameters, components);
        // Move from path level params to each operation so it is easier later
        for param in &p_item2.parameters {
            operation.parameters.push(param.clone());
        }

        // inline request body
        if operation.request_body.is_some() {
            let req_body = operation.request_body.as_mut().unwrap();
            set_deref(req_body, &components.request_bodies, &mut Vec::new());
            let body: &mut RequestBody = req_body.to_item_mut();
            for (_, media) in &mut body.content {
                let schema = media.schema.as_mut().unwrap();
                let mut referred = Vec::new();
                set_deref(schema, &components.schemas, &mut referred);
                set_defer_schema_contents(schema.to_item_mut(), components, 10, &mut referred);
            }
        }

        // inline responses
        for (_status_code, response) in &mut operation.responses.responses {
            set_deref(response, &components.responses, &mut Vec::new());
            for (_name, header) in &mut response.to_item_mut().headers {
                set_deref(header, &components.headers, &mut Vec::new());
            }
            for (_, media) in &mut response.to_item_mut().content {
                let schema = media.schema.as_mut().unwrap();
                let mut referred = Vec::new();
                set_deref(schema, &components.schemas, &mut referred);
                set_defer_schema_contents(schema.to_item_mut(), components, 10, &mut referred);
            }
        }
    }
}

fn set_defer_schema_contents(
    schema: &mut Schema,
    components: &Components,
    recursion: i32,
    referred: &mut Vec<String>,
) {
    if recursion == 0 {
        return;
    }
    match &mut schema.schema_kind {
        SchemaKind::Type(schema_type) => match schema_type {
            Type::Object(object) => {
                for (_name, property) in &mut object.properties {
                    set_deref_box(property, &components.schemas, referred);
                    set_defer_schema_contents(
                        property.to_item_mut(),
                        components,
                        recursion - 1,
                        referred,
                    );
                }
            }
            Type::Array(array) => match &mut array.items {
                None => {}
                Some(items) => {
                    set_deref_box(items, &components.schemas, referred);
                    set_defer_schema_contents(
                        items.to_item_mut(),
                        components,
                        recursion - 1,
                        referred,
                    );
                }
            },
            _ => {}
        },

        SchemaKind::OneOf { ref mut one_of } => {
            for sch in &mut one_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
        }
        SchemaKind::AnyOf { ref mut any_of } => {
            for sch in &mut any_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
        }
        SchemaKind::AllOf { ref mut all_of } => {
            for sch in &mut all_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
        }
        SchemaKind::Not { ref mut not } => {
            let sch = not;
            set_deref(sch, &components.schemas, referred);
            set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
        }
        SchemaKind::Any(schema) => {
            for (_name, property) in &mut schema.properties {
                set_deref_box(property, &components.schemas, referred);
                set_defer_schema_contents(property.to_item_mut(), components, recursion - 1, referred);
            }
            if schema.items.is_some() {
                let the_items = schema.items.as_mut().unwrap();
                set_deref_box(the_items, &components.schemas, referred);
                set_defer_schema_contents(the_items.to_item_mut(), components, recursion - 1, referred);
            }
            for sch in &mut schema.one_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
            for sch in &mut schema.any_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
            for sch in &mut schema.all_of.iter_mut() {
                set_deref(sch, &components.schemas, referred);
                set_defer_schema_contents(sch.to_item_mut(), components, recursion - 1, referred);
            }
        }
    }
}

fn set_deref_all_params(parameters: &mut [ReferenceOr<Parameter>], components: &Components) {
    for parameter in parameters.iter_mut() {
        set_deref(parameter, &components.parameters, &mut Vec::new());
    }
}

fn set_deref<T>(
    item: &mut ReferenceOr<T>,
    component_type: &IndexMap<String, ReferenceOr<T>>,
    referred: &mut Vec<String>,
) where
    T: Clone,
{
    match item {
        ReferenceOr::Reference { reference } => {
            let p = find_reference(reference, component_type, referred)
                .expect("No Reference found!");
            *item = ReferenceOr::Item(p);
        }
        ReferenceOr::Item(_) => {}
    }
}

fn set_deref_box<T>(
    item: &mut ReferenceOr<Box<T>>,
    component_type: &IndexMap<String, ReferenceOr<T>>,
    referred: &mut Vec<String>,
) where
    T: Clone,
{
    match item {
        ReferenceOr::Reference { reference } => {
            let p = find_reference(reference, component_type, referred)
                .expect("No Reference found!");
            *item = ReferenceOr::Item(Box::new(p));
        }
        ReferenceOr::Item(_) => {}
    }
}

fn find_reference<T>(
    reference: &str,
    component_type: &IndexMap<String, ReferenceOr<T>>,
    referred: &mut Vec<String>,
) -> Result<T, DerefError>
where
    T: Clone,
{
    let reference_name: &str = reference.rsplit('/').next().unwrap();

    let ref_item = component_type
        .get(reference_name)
        .ok_or(DerefError::ReferenceError {
            name: reference_name.to_string(),
        })?;

    match ref_item {
        ReferenceOr::Reference { reference } => {
            if referred.iter().any(|v| v == reference_name) {
                unimplemented!("Circular references are not supported")
            } else {
                referred.push(reference_name.to_string());
                let p = find_reference(reference, component_type, referred)
                    .expect("No Reference found!");
                Ok(p)
            }
        }
        ReferenceOr::Item(item) => Ok(item.clone()),
    }
}

fn operation_list<'a>(item: &'a mut PathItem) -> Vec<&'a mut Operation> {
    let mut result = Vec::new();
    let mut pusher = |operation: &'a mut Option<Operation>| {
        if operation.is_some() {
            result.push(operation.as_mut().unwrap());
        }
    };
    pusher(&mut item.delete);
    pusher(&mut item.get);
    pusher(&mut item.head);
    pusher(&mut item.options);
    pusher(&mut item.patch);
    pusher(&mut item.post);
    pusher(&mut item.put);
    pusher(&mut item.trace);
    result
}