schema-registry-api 2.0.1

REST API for a schema-registry
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

use crate::{Compatibility, GetCompatibility, SchemaRegistryError, SubjectName};

use super::SchemaRegistry;

/// The configuration client
#[derive(Debug)]
pub struct ConfigClient<'sr> {
    pub(super) sr: &'sr SchemaRegistry,
}

impl ConfigClient<'_> {
    /// Update global compatibility level.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn set(
        &self,
        compatibility: Compatibility,
    ) -> Result<Compatibility, SchemaRegistryError> {
        let url = self.sr.base_url.join("config")?;
        self.sr.put(url, &compatibility).await
    }

    /// Get global compatibility level.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn get(&self) -> Result<GetCompatibility, SchemaRegistryError> {
        let url = self.sr.base_url.join("config")?;
        self.sr.get(url).await
    }

    /// Update compatibility level for the specified subject.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn set_subject(
        &self,
        subject: &SubjectName,
        compatibility: Compatibility,
    ) -> Result<Compatibility, SchemaRegistryError> {
        let path = format!("config/{subject}");
        let url = self.sr.base_url.join(&path)?;
        self.sr.put(url, &compatibility).await
    }

    /// Update compatibility level for the specified subject.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn get_subject(
        &self,
        subject: &SubjectName,
        default_to_global: Option<bool>,
    ) -> Result<GetCompatibility, SchemaRegistryError> {
        let path = format!("config/{subject}");
        let mut url = self.sr.base_url.join(&path)?;
        if let Some(default_to_global) = default_to_global {
            let query = format!("defaultToGlobal={default_to_global}");
            url.set_query(Some(&query));
        }
        self.sr.get(url).await
    }

    /// Deletes the specified subject-level compatibility level config and reverts to the global default.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn delete_subject(
        &self,
        subject: &SubjectName,
    ) -> Result<GetCompatibility, SchemaRegistryError> {
        let path = format!("config/{subject}");
        let url = self.sr.base_url.join(&path)?;
        self.sr.delete(url).await
    }
}