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
57
58
59
60
61
62
63

//! The Security Requirement Object.

use serde::{Deserialize, Serialize};

use crate::Map;

/// The security schemes that must be satisfied to invoke an operation.
///
/// Each key names a scheme in
/// [`Components::security_schemes`](crate::Components::security_schemes); the
/// value lists the required scopes, which is meaningful only for `oauth2` and
/// `openIdConnect`. All entries in one requirement must be satisfied together;
/// a list of requirements is satisfied when any one of them is.
///
/// An empty requirement means anonymous access is permitted.
///
/// This object carries no extensions: the specification does not permit them.
#[derive(Clone, Debug, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(transparent)]
pub struct SecurityRequirement(pub Map<Vec<String>>);

impl SecurityRequirement {
    /// Creates a requirement permitting anonymous access.
    #[must_use]
    pub fn anonymous() -> Self {
        Self(Map::new())
    }

    /// Requires a scheme that takes no scopes.
    pub fn scheme(name: impl Into<String>) -> Self {
        let mut map = Map::new();
        map.insert(name.into(), Vec::new());
        Self(map)
    }

    /// Requires a scheme together with a set of scopes.
    pub fn scoped(
        name: impl Into<String>,
        scopes: impl IntoIterator<Item = impl Into<String>>,
    ) -> Self {
        let mut map = Map::new();
        map.insert(name.into(), scopes.into_iter().map(Into::into).collect());
        Self(map)
    }

    /// Adds another scheme that must be satisfied alongside the existing ones.
    #[must_use]
    pub fn and(
        mut self,
        name: impl Into<String>,
        scopes: impl IntoIterator<Item = impl Into<String>>,
    ) -> Self {
        self.0
            .insert(name.into(), scopes.into_iter().map(Into::into).collect());
        self
    }

    /// Returns `true` when this requirement permits anonymous access.
    #[must_use]
    pub fn is_anonymous(&self) -> bool {
        self.0.is_empty()
    }
}