opentalk-types-api-internal 0.2.2

OpenTalk API internal data types
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

// SPDX-FileCopyrightText: OpenTalk GmbH <mail@opentalk.eu>
//
// SPDX-License-Identifier: EUPL-1.2

use crate::module_resources::ModuleResourceFilter;

/// The json body for a patch request
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "snake_case")]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub struct PatchModuleResourceBody {
    /// Filter affected resources
    pub filter: ModuleResourceFilter,
    /// Json patch operations that will be applied to affected resources
    pub patch_operations: Vec<ModuleResourceOperation>,
}

/// json patch operations based on [RFC6902](https://www.rfc-editor.org/rfc/rfc6902#section-4)
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(tag = "op", rename_all = "snake_case")]
#[cfg_attr(feature = "utoipa", derive(utoipa::ToSchema))]
pub enum ModuleResourceOperation {
    /// Json patch *add* operation.
    Add {
        /// The path where the value is added.
        path: String,

        /// The value that is added.
        value: serde_json::Value,
    },

    /// Json patch *remove* operation.
    Remove {
        /// The path from where the value is removed.
        path: String,
    },

    /// Json patch *replace* operation.
    Replace {
        /// The path where the value is replaced.
        path: String,

        /// The value by which the existing value is replaced.
        value: serde_json::Value,
    },

    /// Json patch *move* operation.
    Move {
        /// The location from which the value is moved.
        from: String,

        /// The location to which the value is moved.
        path: String,
    },

    /// Json patch *copy* operation.
    Copy {
        /// The location from which the value is copied.
        from: String,

        /// The location to which the value is copied.
        path: String,
    },

    /// Json patch *test* operation.
    Test {
        /// The path of the value that is compared.
        path: String,

        /// The value with which to compare the specified location.
        value: serde_json::Value,
    },
}