kynos-openapi 0.1.0

OpenAPI 3.1 and 3.2 document model, serialization and validation.
Documentation 
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

//! The Discriminator Object.

use serde::{Deserialize, Serialize};

use crate::{Map, model::extensions::Extensions};

/// Polymorphism support: which subschema applies, chosen by a payload property.
///
/// A discriminator is only meaningful next to `oneOf`, `anyOf` or `allOf`, and
/// must not change whether an instance validates — it only makes the choice
/// cheaper to determine.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct Discriminator {
    /// The name of the property holding the discriminating value.
    #[serde(rename = "propertyName")]
    pub property_name: String,

    /// An explicit mapping from discriminating value to schema name or URI.
    #[serde(default, skip_serializing_if = "Map::is_empty")]
    pub mapping: Map<String>,

    /// The schema to use when the discriminating property is absent, or holds a
    /// value with no mapping.
    ///
    /// Introduced in OpenAPI 3.2. Required whenever the discriminating property
    /// is optional — which is why a Rust enum with a `#[serde(other)]`
    /// catch-all variant cannot be described under 3.1 alone.
    #[cfg(feature = "openapi32")]
    #[serde(
        rename = "defaultMapping",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub default_mapping: Option<String>,

    /// Specification extensions.
    #[serde(flatten)]
    pub extensions: Extensions,
}

impl Discriminator {
    /// Creates a discriminator keyed on the given property.
    pub fn new(property_name: impl Into<String>) -> Self {
        Self {
            property_name: property_name.into(),
            ..Self::default()
        }
    }

    /// Maps a discriminating value to a schema name or URI.
    #[must_use]
    pub fn with_mapping(mut self, value: impl Into<String>, schema: impl Into<String>) -> Self {
        self.mapping.insert(value.into(), schema.into());
        self
    }
}