drift 0.2.0

Library for comparing the compatibility of OpenAPI documents
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

// Copyright 2026 Oxide Computer Company

use std::{borrow::Cow, ops::Deref};

use openapiv3::ReferenceOr;
use serde::de::DeserializeOwned;
use serde_json::Value;

use crate::{
    path::{EndpointPath, InvalidComponentRef, JsonPathStack},
    resolve::ReferenceOrResolver,
};

#[derive(Clone, Debug)]
pub struct Context<'a> {
    pub raw_openapi: &'a Value,
    pub stack: JsonPathStack,
}

impl<'a> Context<'a> {
    /// Create a context at a specific endpoint.
    ///
    /// This is the normal way to create a context for schema comparison.
    pub fn for_endpoint(raw_openapi: &'a Value, endpoint: EndpointPath) -> Self {
        Self {
            raw_openapi,
            stack: JsonPathStack::for_endpoint(endpoint),
        }
    }

    /// Create a context at `#/paths`.
    ///
    /// This is used only when reporting that an operation was added or removed,
    /// where one side doesn't have the operation. In normal use, prefer
    /// `for_endpoint()`.
    pub fn for_paths_root(raw_openapi: &'a Value) -> Self {
        Self {
            raw_openapi,
            stack: JsonPathStack::paths_root(),
        }
    }

    pub fn append(&self, segment: &str) -> Context<'a> {
        Self {
            raw_openapi: self.raw_openapi,
            stack: self.stack.append(segment),
        }
    }

    pub(crate) fn push(&self, path: &str) -> Result<Context<'a>, InvalidComponentRef> {
        Ok(Self {
            raw_openapi: self.raw_openapi,
            stack: self.stack.push(path)?,
        })
    }

    pub fn stack(&self) -> &JsonPathStack {
        &self.stack
    }
}

#[derive(Clone, Debug)]
pub struct Contextual<'a, T> {
    context: Context<'a>,
    value: T,
}

impl<'a, T> Contextual<'a, T> {
    pub fn new(context: Context<'a>, value: T) -> Self {
        Self { context, value }
    }

    pub fn append_deref<'s, S>(&'s self, field: &'s S, segment: &str) -> Contextual<'a, &'s S> {
        Contextual {
            context: self.context.append(segment),
            value: field,
        }
    }

    pub fn subcomponent<'s, S>(&'s self, field: &'s S) -> Contextual<'a, &'s S> {
        Contextual {
            context: self.context.clone(),
            value: field,
        }
    }

    pub fn context(&self) -> &Context<'a> {
        &self.context
    }
}

impl<T> Deref for Contextual<'_, T> {
    type Target = T;

    fn deref(&self) -> &Self::Target {
        &self.value
    }
}

impl<T> AsRef<T> for Contextual<'_, T> {
    fn as_ref(&self) -> &T {
        &self.value
    }
}

impl<'a, T> Contextual<'a, &ReferenceOr<T>>
where
    T: DeserializeOwned + Clone,
{
    pub fn contextual_resolve(&self) -> anyhow::Result<(Cow<'_, T>, Context<'a>)> {
        self.value.resolve(&self.context)
    }
}

pub(crate) trait ToContext<'a> {
    fn to_context(&self) -> &Context<'a>;
}

impl<'context> ToContext<'context> for Context<'context> {
    fn to_context(&self) -> &Context<'context> {
        self
    }
}

impl<'context, T> ToContext<'context> for Contextual<'context, T> {
    fn to_context(&self) -> &Context<'context> {
        self.context()
    }
}