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

use crate::{Schema, SchemaId, SchemaRegistryError, SchemaType, SubjectName, SubjectVersion};

use super::SchemaRegistry;

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

impl SchemaClient<'_> {
    /// Get the schema string identified by the input ID.
    ///
    /// # 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,
        id: SchemaId,
        subject: Option<&SubjectName>,
    ) -> Result<Option<Schema>, SchemaRegistryError> {
        let path = format!("schemas/ids/{id}");
        let mut url = self.sr.base_url.join(&path)?;
        if let Some(subject) = subject {
            let query = format!("subject={subject}");
            url.set_query(Some(&query));
        }
        self.sr.get_optional(url).await
    }

    /// Retrieves only the schema identified by the input ID.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn get_schema(
        &self,
        id: SchemaId,
        subject: Option<SubjectName>,
    ) -> Result<Option<String>, SchemaRegistryError> {
        let path = format!("schemas/ids/{id}/schema");
        let mut url = self.sr.base_url.join(&path)?;
        if let Some(subject) = subject {
            let query = format!("subject={subject}");
            url.set_query(Some(&query));
        }
        self.sr.get_optional(url).await
    }

    /// Get the schema types that are registered with Schema Registry.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn types(&self) -> Result<Vec<SchemaType>, SchemaRegistryError> {
        let url = self.sr.base_url.join("schemas/types")?;
        self.sr.get(url).await
    }

    /// Get the subject-version pairs identified by the input ID.
    ///
    /// # Errors
    ///
    /// Fail if we cannot send the query
    /// Fail if the schema registry return an error
    #[tracing::instrument(skip(self))]
    pub async fn versions(&self, id: SchemaId) -> Result<Vec<SubjectVersion>, SchemaRegistryError> {
        let path = format!("schemas/ids/{id}/versions");
        let url = self.sr.base_url.join(&path)?;
        self.sr.get(url).await
    }
}