fiberplane-models 1.0.0-beta.13

Core models used across Fiberplane
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

use super::Error;
#[cfg(feature = "fp-bindgen")]
use fp_bindgen::prelude::Serializable;
use serde::{Deserialize, Serialize};
use typed_builder::TypedBuilder;

/// Response type for status requests.
///
/// To be serialized using the `application/vnd.fiberplane.provider-status`
/// MIME type.
#[derive(Clone, Debug, Deserialize, PartialEq, Serialize, TypedBuilder)]
#[cfg_attr(
    feature = "fp-bindgen",
    derive(Serializable),
    fp(rust_module = "fiberplane_models::providers")
)]
#[non_exhaustive]
#[serde(rename_all = "camelCase")]
pub struct ProviderStatus {
    /// Indicates whether the provider is available to be queried.
    pub status: Result<(), Error>,

    /// Version string of the provider.
    ///
    /// Arbitrary strings may be used, such as commit hashes, but release
    /// versions of providers are expected to report semver versions.
    #[builder(setter(into))]
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub version: String,

    /// Human-readable timestamp at which the provider was built.
    ///
    /// Only used for diagnostics.
    #[builder(default, setter(into))]
    #[serde(default, skip_serializing_if = "String::is_empty")]
    pub built_at: String,
}