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
//! Implements [OpenAPI Header Object][header] types.
//!
//! [header]: https://spec.openapis.org/oas/latest.html#header-object
use super::{Object, RefOr, Schema, SchemaType};
use serde::{Deserialize, Serialize};
/// Implements [OpenAPI Header Object][header] for response headers.
///
/// [header]: https://spec.openapis.org/oas/latest.html#header-object
#[non_exhaustive]
#[derive(Serialize, Deserialize, Clone, PartialEq)]
#[cfg_attr(feature = "debug", derive(Debug))]
pub struct Header {
/// Schema of header type.
pub schema: RefOr<Schema>,
/// Additional description of the header value.
#[serde(skip_serializing_if = "Option::is_none")]
pub description: Option<String>,
}
impl Header {
/// Construct a new [`Header`] with custom schema. If you wish to construct a default
/// header with `String` type you can use [`Header::default`] function.
///
/// # Examples
///
/// Create new [`Header`] with integer type.
/// ```rust
/// # use hypers_openapi::header::Header;
/// # use hypers_openapi::{Object, SchemaType};
/// let header = Header::new(Object::with_type(SchemaType::Integer));
/// ```
///
/// Create a new [`Header`] with default type `String`
/// ```rust
/// # use hypers_openapi::header::Header;
/// let header = Header::default();
/// ```
pub fn new<C: Into<RefOr<Schema>>>(component: C) -> Self {
Self {
schema: component.into(),
..Default::default()
}
}
/// Add schema of header.
pub fn schema<I: Into<RefOr<Schema>>>(mut self, component: I) -> Self {
self.schema = component.into();
self
}
/// Add additional description for header.
pub fn description<S: Into<String>>(mut self, description: S) -> Self {
self.description = Some(description.into());
self
}
}
impl Default for Header {
fn default() -> Self {
Self {
description: Default::default(),
schema: Object::with_type(SchemaType::String).into(),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use assert_json_diff::assert_json_eq;
use serde_json::json;
#[test]
fn test_build_header() {
let header = Header::new(Object::with_type(SchemaType::String));
assert_json_eq!(
header,
json!({
"schema": {
"type": "string"
}
})
);
let header = header
.description("test description")
.schema(Object::with_type(SchemaType::Number));
assert_json_eq!(
header,
json!({
"description": "test description",
"schema": {
"type": "number"
}
})
);
}
}