rweb_openapi/v3_0/
components.rs

1use crate::{
2    v3_0::{
3        Callback, Example, Header, Link, Parameter, RequestBody, Response, Schema, SecurityScheme,
4    },
5    Str,
6};
7use indexmap::IndexMap;
8use serde::{Deserialize, Serialize};
9
10#[derive(Clone, Debug, Deserialize, Serialize, PartialEq)]
11#[serde(untagged)]
12pub enum ObjectOrReference<T> {
13    Object(T),
14    Ref {
15        #[serde(rename = "$ref")]
16        ref_path: Str,
17    },
18}
19
20/// Holds a set of reusable objects for different aspects of the OAS.
21///
22/// All objects defined within the components object will have no effect on the API unless
23/// they are explicitly referenced from properties outside the components object.
24///
25/// See <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#componentsObject>.
26#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
27pub struct Components {
28    /// An object to hold reusable Schema Objects.
29    #[serde(skip_serializing_if = "IndexMap::is_empty")]
30    pub schemas: IndexMap<Str, ObjectOrReference<Schema>>,
31
32    /// An object to hold reusable Response Objects.
33    #[serde(skip_serializing_if = "IndexMap::is_empty")]
34    pub responses: IndexMap<Str, ObjectOrReference<Response>>,
35
36    /// An object to hold reusable Parameter Objects.
37    #[serde(skip_serializing_if = "IndexMap::is_empty")]
38    pub parameters: IndexMap<Str, ObjectOrReference<Parameter>>,
39
40    /// An object to hold reusable Example
41    #[serde(skip_serializing_if = "IndexMap::is_empty")]
42    pub examples: IndexMap<Str, ObjectOrReference<Example>>,
43
44    /// An object to hold reusable Request Body Objects.
45    #[serde(skip_serializing_if = "IndexMap::is_empty", rename = "requestBodies")]
46    pub request_bodies: IndexMap<Str, ObjectOrReference<RequestBody>>,
47
48    /// An object to hold reusable Header Objects.
49    #[serde(skip_serializing_if = "IndexMap::is_empty")]
50    pub headers: IndexMap<Str, ObjectOrReference<Header>>,
51
52    /// An object to hold reusable Security Scheme Objects.
53    #[serde(skip_serializing_if = "IndexMap::is_empty", rename = "securitySchemes")]
54    pub security_schemes: IndexMap<Str, ObjectOrReference<SecurityScheme>>,
55
56    /// An object to hold reusable Link Objects.
57    #[serde(skip_serializing_if = "IndexMap::is_empty")]
58    pub links: IndexMap<Str, ObjectOrReference<Link>>,
59
60    /// An object to hold reusable Callback Objects.
61    #[serde(skip_serializing_if = "IndexMap::is_empty")]
62    pub callbacks: IndexMap<Str, ObjectOrReference<Callback>>,
63    // TODO: Add "Specification Extensions" https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#specificationExtensions}
64}
rweb_openapi/v3_0/components.rs

rweb_openapi/v3_0/
components.rs
