Merge pull request #353 from FrankYang0529/add-version-to-healthz

feat(healthz): add version

src/invoice/api.rs

@@ -25,6 +25,12 @@ pub struct MissingParcelsResponse {
  pub missing: Vec<Label>,
 }
 
+#[derive(Deserialize, Serialize)]
+pub struct HealthResponse {
+ pub status: String,
+ pub version: String,
+}
+
 /// A string error message returned from the server
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ErrorResponse {

src/invoice/mod.rs

@@ -19,7 +19,8 @@ pub(crate) use api::DeviceAuthorizationExtraFields;
 pub(crate) use api::LoginParams;
 #[doc(inline)]
 pub use api::{
- ErrorResponse, InvoiceCreateResponse, KeyOptions, MissingParcelsResponse, QueryOptions,
+ ErrorResponse, HealthResponse, InvoiceCreateResponse, KeyOptions, MissingParcelsResponse,
+ QueryOptions,
 };
 #[doc(inline)]
 pub use bindle_spec::BindleSpec;

src/server/routes.rs

@@ -2,7 +2,7 @@ use std::sync::Arc;
 
 use warp::Filter;
 
-use crate::{server::filters, signature::KeyRing};
+use crate::{invoice::HealthResponse, server::filters, signature::KeyRing};
 
 /// A helper function that aggregates all routes into a complete API filter. If you only wish to
 /// serve specific endpoints or versions, you can assemble them with the individual submodules
@@ -22,7 +22,12 @@ where
  Authn: crate::authn::Authenticator + Clone + Send + Sync + 'static,
  Authz: crate::authz::Authorizer + Clone + Send + Sync + 'static,
 {
- let health = warp::path("healthz").map(|| "OK");
+ let health = warp::path("healthz").map(|| {
+ warp::reply::json(&HealthResponse {
+ status: "OK".to_string(),
+ version: env!("CARGO_PKG_VERSION").to_string(),
+ })
+ });
 
  // Use an Arc to avoid a possibly expensive clone of the keyring on every API call
  let wrapped_keyring = Arc::new(keyring);