openapi_nexus_spec/oas30/spec/
example.rs

1use std::collections::BTreeMap;
2
3use serde::{Deserialize, Serialize};
4
5use super::{ErrorRef, FromRef, OpenApiV30Spec, Ref, RefType, spec_extensions};
6
7/// Multi-purpose example objects.
8#[derive(Debug, Clone, Default, PartialEq, Deserialize, Serialize)]
9pub struct Example {
10    #[serde(skip_serializing_if = "Option::is_none")]
11    pub summary: Option<String>,
12
13    #[serde(skip_serializing_if = "Option::is_none")]
14    pub description: Option<String>,
15
16    #[serde(skip_serializing_if = "Option::is_none")]
17    pub value: Option<serde_json::Value>,
18
19    #[serde(rename = "externalValue", skip_serializing_if = "Option::is_none")]
20    pub external_value: Option<String>,
21
22    #[serde(flatten, with = "spec_extensions")]
23    pub extensions: BTreeMap<String, serde_json::Value>,
24}
25
26impl Example {
27    /// Returns JSON-encoded bytes of this example's value.
28    pub fn as_bytes(&self) -> Vec<u8> {
29        match self.value {
30            Some(ref val) => serde_json::to_string(val).unwrap().as_bytes().to_owned(),
31            None => vec![],
32        }
33    }
34}
35
36impl FromRef for Example {
37    fn from_ref(spec: &OpenApiV30Spec, path: &str) -> Result<Self, ErrorRef> {
38        let refpath = path.parse::<Ref>()?;
39
40        match refpath.kind {
41            RefType::Example => spec
42                .components
43                .as_ref()
44                .and_then(|cs| cs.examples.get(&refpath.name))
45                .ok_or_else(|| ErrorRef::Unresolvable {
46                    path: path.to_owned(),
47                })
48                .and_then(|oor| oor.resolve(spec)),
49
50            typ => Err(ErrorRef::MismatchedType {
51                expected: typ,
52                actual: RefType::Example,
53            }),
54        }
55    }
56}
openapi_nexus_spec/oas30/spec/example.rs

openapi_nexus_spec/oas30/spec/
example.rs
