manta-shared 2.0.0-beta.59

Shared types and pure helpers used by both manta-cli and manta-server.
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

//! Wire shape for `GET /api/v1/analysis/images`.
//!
//! Each `BackendSummary` is one row in an image-centric projection of
//! the four backend resource lists. See the field-population rules in
//! the implementation plan for how each column is derived.

use serde::{Deserialize, Serialize};
use utoipa::ToSchema;

/// One row of the backend-data summary, anchored on an IMS image.
///
/// Every IMS image visible to the caller produces exactly one row.
/// The row's `image_id` and `name` are always populated; the rest are
/// `Option<String>` and are filled in only when the corresponding
/// relation resolves.
#[derive(Debug, Serialize, Deserialize, ToSchema)]
pub struct BackendSummary {
  /// IMS image id (`Image.id`). Row anchor.
  pub image_id: String,
  /// IMS image name (`Image.name`).
  pub name: String,
  /// IMS image `created` timestamp (`Image.created`).
  pub image_created: Option<String>,
  /// CFS configuration the image was built with
  /// (`Image.configuration`).
  pub configuration_name: Option<String>,
  /// `true` if no BSS boot-parameter record references this image as
  /// its boot image. An image referenced by BSS is currently booting
  /// (or scheduled to boot) at least one node, so deleting it would
  /// break that node's next boot.
  pub safe_to_delete: bool,
}