mycelium-openapi 8.3.1-beta.2

Provide OpenAPI related elements to the mycelium project.
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

use crate::{
    dtos::{content::Content, parameter::Parameter},
    entities::{DepthTracker, ReferenceResolver},
};

use mycelium_base::utils::errors::{execution_err, MappedErrors};
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use utoipa::ToSchema;

#[derive(Debug, Deserialize, Serialize, Clone, PartialEq, Eq, ToSchema)]
#[serde(rename_all = "camelCase")]
pub struct Operation {
    #[serde(default)]
    pub operation_id: Option<String>,

    #[serde(default)]
    pub tags: Vec<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub summary: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub parameters: Option<Vec<Parameter>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub request_body: Option<Content>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub responses: Option<HashMap<String, Content>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub deprecated: Option<bool>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub security: Option<serde_json::Value>,
}

impl ReferenceResolver for Operation {
    fn resolve_ref(
        &self,
        components: &serde_json::Value,
        depth_tracker: &mut DepthTracker,
    ) -> Result<serde_json::Value, MappedErrors> {
        if depth_tracker.should_stop() {
            return Ok(depth_tracker.empty_value());
        }

        depth_tracker.increment();

        let mut value = serde_json::to_value(self).map_err(|e| {
            execution_err(format!("Failed to resolve operation: {e}"))
        })?;

        //
        // Resolve the parameters
        //
        if let Some(parameters) = self.parameters.as_ref() {
            value["parameters"] = if let false = parameters.is_empty() {
                parameters
                    .iter()
                    .filter_map(|parameter| {
                        //
                        // Clone the depth tracker to guard against parallel
                        // increment
                        //
                        let mut tracker_clone = depth_tracker.clone();

                        //
                        // Resolve the parameter
                        //
                        parameter
                            .resolve_ref(components, &mut tracker_clone)
                            .map_err(|e| {
                                execution_err(format!(
                                    "Failed to resolve parameter: {e}"
                                ))
                            })
                            .ok()
                    })
                    .collect::<Vec<serde_json::Value>>()
                    .into()
            } else {
                depth_tracker.empty_value()
            };
        }

        //
        // Resolve the request body
        //
        if let Some(request_body) = self.request_body.as_ref() {
            value["requestBody"] =
                request_body.resolve_ref(components, depth_tracker)?;
        }

        //
        // Resolve the responses
        //
        if let Some(responses) = self.responses.as_ref() {
            let mut responses_value = serde_json::Map::new();

            for (key, response) in responses {
                let resolved =
                    response.resolve_ref(components, depth_tracker)?;

                responses_value.insert(key.clone(), resolved);
            }

            value["responses"] = serde_json::Value::Object(responses_value);
        }

        Ok(value)
    }
}