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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

//! Rules that apply to the document as a whole: servers, tags, component
//! names.

use std::collections::HashSet;

#[cfg(feature = "openapi32")]
use std::collections::HashMap;

use crate::{
    model::{components::ComponentName, document::Document},
    validate::violation::{SpecError, Violation},
};

pub(in crate::validate) fn check_servers(document: &Document, violations: &mut Vec<Violation>) {
    for (index, server) in document.servers.iter().enumerate() {
        for (name, variable) in &server.variables {
            let location = format!("#/servers/{index}/variables/{name}");
            if let Some(values) = &variable.enumeration {
                if values.is_empty() {
                    violations.push(Violation::error(
                        &location,
                        SpecError::EmptyServerVariableEnum { name: name.clone() },
                    ));
                } else if !values.contains(&variable.default_value) {
                    violations.push(Violation::error(
                        &location,
                        SpecError::ServerVariableDefaultNotInEnum { name: name.clone() },
                    ));
                }
            }
        }
    }
}

pub(in crate::validate) fn check_tags(document: &Document, violations: &mut Vec<Violation>) {
    let mut seen: HashSet<&str> = HashSet::new();
    for (index, tag) in document.tags.iter().enumerate() {
        if !seen.insert(tag.name.as_str()) {
            violations.push(Violation::error(
                format!("#/tags/{index}"),
                SpecError::DuplicateTag {
                    name: tag.name.clone(),
                },
            ));
        }
    }

    #[cfg(feature = "openapi32")]
    check_tag_hierarchy(document, &seen, violations);

    #[cfg(not(feature = "openapi32"))]
    let _ = &seen;
}

#[cfg(feature = "openapi32")]
pub(in crate::validate) fn check_tag_hierarchy(
    document: &Document,
    declared: &HashSet<&str>,
    violations: &mut Vec<Violation>,
) {
    let parents: HashMap<&str, &str> = document
        .tags
        .iter()
        .filter_map(|tag| {
            tag.parent
                .as_deref()
                .map(|parent| (tag.name.as_str(), parent))
        })
        .collect();

    for (index, tag) in document.tags.iter().enumerate() {
        let Some(parent) = tag.parent.as_deref() else {
            continue;
        };
        let location = format!("#/tags/{index}");

        if !declared.contains(parent) {
            violations.push(Violation::error(
                &location,
                SpecError::UnknownTagParent {
                    name: tag.name.clone(),
                    parent: parent.to_owned(),
                },
            ));
            continue;
        }

        // Walk upward, bounded by the number of tags: a chain longer than
        // that has necessarily revisited a node.
        let mut current = parent;
        let mut steps = 0;
        while let Some(next) = parents.get(current) {
            if *next == tag.name.as_str() || steps > document.tags.len() {
                violations.push(Violation::error(
                    &location,
                    SpecError::TagParentCycle {
                        name: tag.name.clone(),
                    },
                ));
                break;
            }
            current = next;
            steps += 1;
        }
    }
}

pub(in crate::validate) fn check_component_names(
    document: &Document,
    violations: &mut Vec<Violation>,
) {
    let components = &document.components;

    // Every section, because the specification says "**All** the fixed
    // fields declared above". Five of them were consulted, which let a key
    // in any of the others through whatever it was. `extensions` is not a
    // section: its keys are `x-` prefixed names, checked by their own rule.
    let groups = [
        ("schemas", components.schemas.keys().collect::<Vec<_>>()),
        ("responses", components.responses.keys().collect()),
        ("parameters", components.parameters.keys().collect()),
        ("examples", components.examples.keys().collect()),
        ("requestBodies", components.request_bodies.keys().collect()),
        ("headers", components.headers.keys().collect()),
        (
            "securitySchemes",
            components.security_schemes.keys().collect(),
        ),
        ("links", components.links.keys().collect()),
        ("callbacks", components.callbacks.keys().collect()),
        ("pathItems", components.path_items.keys().collect()),
        #[cfg(feature = "openapi32")]
        ("mediaTypes", components.media_types.keys().collect()),
    ];

    for (group, names) in groups {
        for name in names {
            if !ComponentName::is_valid(name) {
                violations.push(Violation::error(
                    format!("#/components/{group}/{name}"),
                    SpecError::InvalidComponentName { name: name.clone() },
                ));
            }
        }
    }
}