openapiv3/
components.rs

1use crate::*;
2use indexmap::IndexMap;
3use serde::{Deserialize, Serialize};
4use crate::map::RefOrMap;
5
6/// Holds a set of reusable objects for different aspects of the OAS.
7/// All objects defined within the components object will have no effect
8/// on the API unless they are explicitly referenced from properties
9/// outside the components object.
10#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq)]
11#[serde(rename_all = "camelCase")]
12pub struct Components {
13    /// An object to hold reusable Security Scheme Objects.
14    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
15    pub security_schemes: RefOrMap<SecurityScheme>,
16    /// An object to hold reusable Response Objects.
17    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
18    pub responses: RefOrMap<Response>,
19    /// An object to hold reusable Parameter Objects.
20    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
21    pub parameters: RefOrMap<Parameter>,
22    /// An object to hold reusable Example Objects.
23    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
24    pub examples: RefOrMap<Example>,
25    /// An object to hold reusable Request Body Objects.
26    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
27    pub request_bodies: RefOrMap<RequestBody>,
28    /// An object to hold reusable Header Objects.
29    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
30    pub headers: RefOrMap<Header>,
31    /// An object to hold reusable Schema Objects.
32    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
33    pub schemas: RefOrMap<Schema>,
34    /// An object to hold reusable Link Objects.
35    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
36    pub links: RefOrMap<Link>,
37    /// An object to hold reusable Callback Objects.
38    #[serde(default, skip_serializing_if = "IndexMap::is_empty")]
39    pub callbacks: RefOrMap<Callback>,
40    /// Inline extensions to this object.
41    #[serde(flatten, deserialize_with = "crate::util::deserialize_extensions")]
42    pub extensions: IndexMap<String, serde_json::Value>,
43}
44
45impl Components {
46    pub fn is_empty(&self) -> bool {
47        self.security_schemes.is_empty()
48            && self.responses.is_empty()
49            && self.parameters.is_empty()
50            && self.examples.is_empty()
51            && self.request_bodies.is_empty()
52            && self.headers.is_empty()
53            && self.schemas.is_empty()
54            && self.links.is_empty()
55            && self.callbacks.is_empty()
56            && self.extensions.is_empty()
57    }
58}
openapiv3/components.rs

openapiv3/
components.rs
