schemadoc-diff 0.1.20

OpenApi diff library and breaking changes detector
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

pub mod markdown;

use indexmap::IndexMap;

use crate::checker::ValidationIssue;
use crate::path_pointer::{PathPointer, PathPointerScope};

pub struct Text(String, bool);

impl Text {
    pub fn new(text: String, is_empty: bool) -> Self {
        Text(text, is_empty)
    }
    pub fn inner(&self) -> &str {
        &self.0
    }
    pub fn is_empty(&self) -> bool {
        self.1
    }
}

pub struct Markdown(String, bool);

impl Markdown {
    pub fn new(text: String, is_empty: bool) -> Self {
        Markdown(text, is_empty)
    }
    pub fn as_str(&self) -> &str {
        &self.0
    }
    pub fn is_empty(&self) -> bool {
        self.1
    }
}

pub trait Exporter<R> {
    fn export(
        &self,
        info: IndexMap<&str, &str>,
        version_url: &str,
        invalid_only: bool,
        path_filters: Option<&[String]>,
        validations: Option<&[ValidationIssue]>,
    ) -> R;
}

pub fn display_uri(pointer: &PathPointer) -> String {
    if let Some(component) = pointer.get(PathPointerScope::Path) {
        component
            .path
            .as_ref()
            .map_or_else(|| "".to_string(), |x| x.clone())
    } else {
        "".to_string()
    }
}

pub fn display_method(pointer: &PathPointer) -> String {
    if let Some(component) = pointer.get(PathPointerScope::Operation) {
        component
            .path
            .as_ref()
            .map_or_else(|| "".to_string(), |x| x.clone())
    } else {
        "".to_string()
    }
}