SEBA-401: Reformat and expand descriptions in rcord profile xproto
Change-Id: Ib3cb9759cebd4876a69c5f63e48493ebb4832a76
diff --git a/VERSION b/VERSION
index 66c4c22..7ee7020 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-1.0.9
+1.0.10
diff --git a/xos/synchronizer/models/rcord.xproto b/xos/synchronizer/models/rcord.xproto
index 527ed6f..ba3168f 100644
--- a/xos/synchronizer/models/rcord.xproto
+++ b/xos/synchronizer/models/rcord.xproto
@@ -4,34 +4,83 @@
message RCORDService (Service) {
option verbose_name = "RCORD Service";
- required string access = 11 [help_text = "Who is managing the Access Network", default = "voltha", choices = "(('voltha', 'VOLTHA'), ('unknown', 'Unknown'))", max_length = 30, db_index = False];
+ option description = "Service that manages residential subscribers";
+
+ required string access = 11 [
+ help_text = "Name of service that is managing the Access Network",
+ default = "voltha", choices = "(('voltha', 'VOLTHA'), ('unknown', 'Unknown'))",
+ db_index = False,
+ max_length = 30];
}
message RCORDSubscriber (ServiceInstance) {
option kind = "RCORDSubscriber";
option verbose_name = "RCORD Subscriber";
option owner_class_name = "RCORDService";
+ option description = "A residential subscriber";
// vsg related configurations
- optional manytoone creator->User:created_rcord_subscribers = 15 [db_index = True];
- optional string status = 11 [default = "enabled", choices = "(('enabled', 'Enabled'), ('disabled', 'Disabled'), ('pre-provisioned', 'Pre Provisioned'), ('awaiting-auth', 'Awaiting Authentication'), ('auth-failed', 'Authentication Failed'))", max_length = 30, content_type = "stripped", db_index = False];
+ optional manytoone creator->User:created_rcord_subscribers = 15 [
+ help_text = "User who created this RCORDSubscriber object",
+ db_index = True];
+ optional string status = 11 [
+ help_text = "Status of subscriber provisioning and authentication",
+ content_type = "stripped",
+ db_index = False,
+ default = "enabled",
+ choices = "(('enabled', 'Enabled'), ('disabled', 'Disabled'), ('pre-provisioned', 'Pre Provisioned'), ('awaiting-auth', 'Awaiting Authentication'), ('auth-failed', 'Authentication Failed'))",
+ max_length = 30];
// parameters for r-cord lite
- optional int32 c_tag = 12 [db_index = False, min_value = 0, max_value = 4096];
- optional int32 s_tag = 19 [db_index = False, min_value = 0, max_value = 4096];
- required string onu_device = 13 [help_text = "ONUDevice serial number", db_index = False];
- optional string mac_address = 18 [db_index = False];
+ optional int32 c_tag = 12 [
+ help_text = "Customer VLAN Tag, one half of the double-tag that identifies this subscriber's traffic",
+ db_index = False,
+ min_value = 0,
+ max_value = 4096];
+ optional int32 s_tag = 19 [
+ help_text = "Service VLAN Tag, one half of the double-tag that identifies this subscriber's traffic",
+ db_index = False,
+ min_value = 0,
+ max_value = 4096];
+ required string onu_device = 13 [
+ help_text = "ONUDevice serial number",
+ db_index = False];
+ optional string mac_address = 18 [
+ help_text = "Subscriber MAC Address",
+ db_index = False];
// operator specific fields
- optional string nas_port_id = 20 [db_index = False];
- optional string circuit_id = 21 [db_index = False];
- optional string remote_id = 22 [db_index = False];
+ optional string nas_port_id = 20 [
+ help_text = "NAS Port ID used in Radius to identify physical interface used to authenticate subscriber",
+ db_index = False];
+ optional string circuit_id = 21 [
+ help_text = "Option 82 Circuit ID for DHCP relay agent",
+ db_index = False];
+ optional string remote_id = 22 [
+ help_text = "Option 82 Remote ID for DHCP relay agent",
+ db_index = False];
}
message RCORDIpAddress(XOSBase) {
option verbose_name = "IP address";
+ option description = "An IP Address assinged to a residential subscriber";
- required manytoone subscriber->RCORDSubscriber:ips = 1:1001 [help_text = "The subscriber the IP address belongs to", db_index = True, null = False, blank = False];
- required string ip = 2 [help_text = "The unique IP address (either IPv4 or IPv6 / netmask)", max_length = 52, null = False, db_index = False, blank = False, unique_with = "subscriber"];
- optional string description = 3 [help_text = "A short description of the IP address", max_length = 254, null = False, db_index = False, blank = False];
+ required manytoone subscriber->RCORDSubscriber:ips = 1:1001 [
+ help_text = "The subscriber the IP address belongs to",
+ blank = False,
+ db_index = True,
+ null = False];
+ required string ip = 2 [
+ help_text = "The unique IP address (either IPv4 or IPv6 / netmask)",
+ blank = False,
+ db_index = False,
+ max_length = 52,
+ null = False,
+ unique_with = "subscriber"];
+ optional string description = 3 [
+ help_text = "A short description of the IP address",
+ blank = False,
+ db_index = False,
+ max_length = 254,
+ null = False];
}
\ No newline at end of file