roas-overlay 0.2.1

Rust implementation of the OpenAPI Overlay Specification v1.0 / v1.1 — parse, validate, and apply
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

//! Overlay v1.1 `Info` object.
//!
//! Per [§3.2 Info Object](https://spec.openapis.org/overlay/v1.1.0.html#info-object):
//! the v1.0 fields plus an optional `description`.

use crate::validation::{Context, ValidateWithContext, ValidationOptions};
use serde::{Deserialize, Serialize};
use std::collections::BTreeMap;

#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Default)]
pub struct Info {
    /// **Required** A human-readable description of the purpose of the overlay.
    pub title: String,

    /// **Required** A version identifier for changes to the Overlay document.
    pub version: String,

    /// Optional CommonMark-flavored prose description. Added in v1.1.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,

    /// `x-`-prefixed Specification Extensions.
    #[serde(flatten)]
    #[serde(with = "crate::common::extensions")]
    #[serde(skip_serializing_if = "Option::is_none")]
    pub extensions: Option<BTreeMap<String, serde_json::Value>>,
}

impl ValidateWithContext for Info {
    fn validate_with_context(&self, ctx: &mut Context) {
        if !ctx.is_option(ValidationOptions::IgnoreEmptyInfoTitle) {
            ctx.require_non_empty("title", &self.title);
        }
        if !ctx.is_option(ValidationOptions::IgnoreEmptyInfoVersion) {
            ctx.require_non_empty("version", &self.version);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use enumset::EnumSet;
    use serde_json::json;

    fn ctx() -> Context {
        Context::with_path(EnumSet::empty(), "#.info")
    }

    #[test]
    fn deserialize_minimal_info_round_trips() {
        let info: Info = serde_json::from_value(json!({ "title": "T", "version": "1.0" })).unwrap();
        assert_eq!(info.title, "T");
        assert_eq!(info.version, "1.0");
        assert!(info.description.is_none());
        assert!(info.extensions.is_none());

        let v = serde_json::to_value(&info).unwrap();
        assert_eq!(v, json!({ "title": "T", "version": "1.0" }));
    }

    #[test]
    fn deserialize_with_description_round_trips() {
        let info: Info = serde_json::from_value(json!({
            "title": "T",
            "version": "1.0",
            "description": "Adds error responses."
        }))
        .unwrap();
        assert_eq!(info.description.as_deref(), Some("Adds error responses."));

        let v = serde_json::to_value(&info).unwrap();
        assert_eq!(
            v,
            json!({
                "title": "T",
                "version": "1.0",
                "description": "Adds error responses."
            }),
        );
    }

    #[test]
    fn deserialize_keeps_x_dash_extensions_and_drops_others() {
        let info: Info = serde_json::from_value(json!({
            "title": "T",
            "version": "1.0",
            "x-team": "platform",
            "ignored": 42,
        }))
        .unwrap();
        let ext = info.extensions.as_ref().unwrap();
        assert_eq!(ext.get("x-team").unwrap(), &json!("platform"));
        assert!(!ext.contains_key("ignored"));
    }

    #[test]
    fn validate_rejects_empty_title_and_version() {
        let mut c = ctx();
        let info = Info::default();
        info.validate_with_context(&mut c);
        assert!(
            c.errors
                .iter()
                .any(|e| e == "#.info.title: must not be empty")
        );
        assert!(
            c.errors
                .iter()
                .any(|e| e == "#.info.version: must not be empty")
        );
    }

    #[test]
    fn validate_ignore_options_suppress_diagnostics() {
        let opts = EnumSet::only(ValidationOptions::IgnoreEmptyInfoTitle)
            | ValidationOptions::IgnoreEmptyInfoVersion;
        let mut c = Context::with_path(opts, "#.info");
        let info = Info::default();
        info.validate_with_context(&mut c);
        assert!(c.errors.is_empty());
    }
}