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
//! Implements [OpenAPI Header Object][header] types.
//!
//! [header]: https://spec.openapis.org/oas/latest.html#header-object
use super::{Object, Schema, Type};
/// Implements [OpenAPI Header Object][header] for response headers.
///
/// [header]: https://spec.openapis.org/oas/latest.html#header-object
#[non_exhaustive]
#[derive(serde_derive::Serialize, serde_derive::Deserialize, Clone, PartialEq, bon::Builder)]
#[cfg_attr(feature = "debug", derive(Debug))]
#[builder(on(_, into))]
pub struct Header {
/// Schema of header type.
pub schema: Schema,
/// Additional description of the header value.
#[serde(skip_serializing_if = "Option::is_none", default)]
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 openapiv3_1::header::Header;
/// # use openapiv3_1::{Object, Type};
/// let header = Header::new(Object::with_type(Type::Integer));
/// ```
///
/// Create a new [`Header`] with default type `String`
/// ```rust
/// # use openapiv3_1::header::Header;
/// let header = Header::default();
/// ```
pub fn new<C: Into<Schema>>(component: C) -> Self {
Self {
schema: component.into(),
..Default::default()
}
}
}
impl Default for Header {
fn default() -> Self {
Self {
description: Default::default(),
schema: Object::builder().schema_type(Type::String).into(),
}
}
}
impl<S: header_builder::IsComplete> From<HeaderBuilder<S>> for Header {
fn from(builder: HeaderBuilder<S>) -> Self {
builder.build()
}
}