tmf656-slice 0.3.2

TM Forum TMF656 Slice Management API implementation in Rust
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135

//! TMF656 Slice Management models

use chrono::{DateTime, Utc};
use serde::{Deserialize, Serialize};
use tmf_apis_core::BaseEntity;
use utoipa::ToSchema;
use uuid::Uuid;

/// Slice State
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum SliceState {
    Planned,
    Active,
    Inactive,
    Terminated,
}

/// Slice Type
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
#[serde(rename_all = "SCREAMING_SNAKE_CASE")]
pub enum SliceType {
    EnhancedMobileBroadband,
    UltraReliableLowLatency,
    MassiveMachineTypeCommunications,
    Custom,
}

/// Network Slice - Represents a 5G network slice
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkSlice {
    #[serde(flatten)]
    pub base: BaseEntity,
    /// Slice state
    pub state: SliceState,
    /// Slice type
    pub slice_type: SliceType,
    /// Service Level Agreement (SLA) parameters
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sla_parameters: Option<SLAParameters>,
    /// Network function references
    #[serde(skip_serializing_if = "Option::is_none")]
    pub network_functions: Option<Vec<NetworkFunctionRef>>,
    /// Activation date
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schema(value_type = String, format = "date-time")]
    pub activation_date: Option<DateTime<Utc>>,
    /// Termination date
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schema(value_type = String, format = "date-time")]
    pub termination_date: Option<DateTime<Utc>>,
}

/// SLA Parameters
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct SLAParameters {
    /// Maximum latency in milliseconds
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_latency_ms: Option<u32>,
    /// Minimum throughput in Mbps
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_throughput_mbps: Option<u32>,
    /// Maximum number of devices
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_devices: Option<u32>,
    /// Coverage area
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coverage_area: Option<String>,
}

/// Network Function Reference
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct NetworkFunctionRef {
    #[schema(value_type = String, format = "uuid")]
    pub id: Uuid,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub href: Option<String>,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub function_type: Option<String>,
}

/// Request to create a network slice
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CreateNetworkSliceRequest {
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    pub slice_type: SliceType,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sla_parameters: Option<CreateSLAParametersRequest>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub network_functions: Option<Vec<CreateNetworkFunctionRefRequest>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schema(value_type = String, format = "date-time")]
    pub activation_date: Option<DateTime<Utc>>,
}

/// Request to create SLA parameters
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CreateSLAParametersRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_latency_ms: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub min_throughput_mbps: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_devices: Option<u32>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub coverage_area: Option<String>,
}

/// Request to create a network function reference
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct CreateNetworkFunctionRefRequest {
    #[schema(value_type = String, format = "uuid")]
    pub id: Uuid,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub function_type: Option<String>,
}

/// Request to update a network slice
#[derive(Debug, Clone, Serialize, Deserialize, ToSchema)]
pub struct UpdateNetworkSliceRequest {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub state: Option<SliceState>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schema(value_type = String, format = "date-time")]
    pub activation_date: Option<DateTime<Utc>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    #[schema(value_type = String, format = "date-time")]
    pub termination_date: Option<DateTime<Utc>>,
}