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
use std::collections::BTreeMap;
use serde::{Deserialize, Serialize};
use super::{spec_extensions, FromRef, Ref, RefError, RefType, Spec};
/// Multi-purpose example objects.
///
/// Will be validated against schema when used in conformance testing.
///
/// See <https://spec.openapis.org/oas/v3.1.1#example-object>.
#[derive(Debug, Clone, Default, PartialEq, Deserialize, Serialize)]
pub struct Example {
/// Short description for the example.
#[serde(skip_serializing_if = "Option::is_none")]
pub summary: Option<String>,
/// Long description for the example.
/// [CommonMark syntax](https://spec.commonmark.org) MAY be used for rich text representation.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
// FIXME: Implement (merge with externalValue as enum)
/// Embedded literal example. The `value` field and `externalValue` field are mutually
/// exclusive. To represent examples of media types that cannot naturally represented
/// in JSON or YAML, use a string value to contain the example, escaping where necessary.
#[serde(skip_serializing_if = "Option::is_none")]
pub value: Option<serde_json::Value>,
//
// FIXME: Implement (merge with value as enum)
// /// A URL that points to the literal example. This provides the capability to reference
// /// examples that cannot easily be included in JSON or YAML documents. The `value` field
// /// and `externalValue` field are mutually exclusive.
// #[serde(skip_serializing_if = "Option::is_none")]
// pub externalValue: Option<String>,
//
/// Specification extensions.
///
/// Only "x-" prefixed keys are collected, and the prefix is stripped.
///
/// See <https://spec.openapis.org/oas/v3.1.1#specification-extensions>.
#[serde(flatten, with = "spec_extensions")]
pub extensions: BTreeMap<String, serde_json::Value>,
}
impl Example {
/// Returns JSON-encoded bytes of this example's value.
pub fn as_bytes(&self) -> Vec<u8> {
match self.value {
Some(ref val) => serde_json::to_string(val).unwrap().as_bytes().to_owned(),
None => vec![],
}
}
}
impl FromRef for Example {
fn from_ref(spec: &Spec, path: &str) -> Result<Self, RefError> {
let refpath = path.parse::<Ref>()?;
match refpath.kind {
RefType::Example => spec
.components
.as_ref()
.and_then(|cs| cs.examples.get(&refpath.name))
.ok_or_else(|| RefError::Unresolvable(path.to_owned()))
.and_then(|oor| oor.resolve(spec)),
typ => Err(RefError::MismatchedType(typ, RefType::Example)),
}
}
}