SEBA-401: Reformat and expand descriptions in att-workflow-driver xproto
Change-Id: I74cb9c7c914ea51d6d9ce7315eb0f50815c54d49
diff --git a/VERSION b/VERSION
index 9374c13..94562c7 100644
--- a/VERSION
+++ b/VERSION
@@ -1,2 +1,2 @@
-1.0.14
+1.0.15
diff --git a/xos/synchronizer/models/att-workflow-driver.xproto b/xos/synchronizer/models/att-workflow-driver.xproto
index 7ebc390..6b4d7ba 100644
--- a/xos/synchronizer/models/att-workflow-driver.xproto
+++ b/xos/synchronizer/models/att-workflow-driver.xproto
@@ -4,29 +4,84 @@
message AttWorkflowDriverService (Service){
option verbose_name = "AttWorkflowDriver Service";
option kind = "control";
+ option description = "Service that manages the AT&T Subscriber workflow";
}
message AttWorkflowDriverServiceInstance (ServiceInstance){
option owner_class_name = "AttWorkflowDriverService";
option verbose_name = "AttWorkflowDriver Service Instance";
+ option description = "Workflow settings for a particular ONU Device";
- required string serial_number = 2 [max_length = 254, db_index = False, tosca_key=True, unique = True];
- required string authentication_state = 3 [default = "AWAITING", choices = "(('AWAITING', 'Awaiting'), ('STARTED', 'Started'), ('REQUESTED', 'Requested'), ('APPROVED', 'Approved'), ('DENIED', 'Denied'), )", max_length = 50, db_index = False, feedback_state = True];
- required string of_dpid = 4 [max_length = 254, db_index = False];
- required int32 uni_port_id = 5 [db_index = False];
- required string onu_state = 6 [max_length = 254, db_index = False, default = "AWAITING", choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))", feedback_state = True];
- optional string status_message = 7 [max_length = 254, db_index = False, default = ""];
- required string dhcp_state = 8 [max_length = 254, db_index = False, default = "AWAITING", choices = "(('AWAITING', 'Awaiting'), ('DHCPDISCOVER', 'DHCPDISCOVER'), ('DHCPACK', 'DHCPACK'), ('DHCPREQUEST', 'DHCPREQUEST'))", feedback_state = True];
- optional string ip_address = 9 [max_length = 20, db_index = False, feedback_state = True];
- optional string mac_address = 10 [max_length = 20, db_index = False, feedback_state = True];
+ required string serial_number = 2 [
+ help_text = "Serial number of ONU",
+ db_index = False,
+ max_length = 254,
+ tosca_key=True,
+ unique = True];
+ required string authentication_state = 3 [
+ help_text = "Subscriber authentication state",
+ choices = "(('AWAITING', 'Awaiting'), ('STARTED', 'Started'), ('REQUESTED', 'Requested'), ('APPROVED', 'Approved'), ('DENIED', 'Denied'), )",
+ default = "AWAITING",
+ db_index = False,
+ feedback_state = True,
+ max_length = 50];
+ required string of_dpid = 4 [
+ help_text = "OLT Openflow ID",
+ db_index = False,
+ max_length = 254];
+ required int32 uni_port_id = 5 [
+ help_text = "ONU UNI port ID",
+ db_index = False];
+ required string onu_state = 6 [
+ help_text = "ONU administrative state",
+ choices = "(('AWAITING', 'Awaiting'), ('ENABLED', 'Enabled'), ('DISABLED', 'Disabled'))",
+ db_index = False,
+ default = "AWAITING",
+ feedback_state = True,
+ max_length = 254];
+ optional string status_message = 7 [
+ help_text = "Status text of current state machine state",
+ db_index = False,
+ default = "",
+ max_length = 254];
+ required string dhcp_state = 8 [
+ max_length = 254,
+ db_index = False,
+ default = "AWAITING",
+ choices = "(('AWAITING', 'Awaiting'), ('DHCPDISCOVER', 'DHCPDISCOVER'), ('DHCPACK', 'DHCPACK'), ('DHCPREQUEST', 'DHCPREQUEST'))",
+ feedback_state = True];
+ optional string ip_address = 9 [
+ help_text = "Subcriber IP address, learned from DHCP",
+ db_index = False,
+ feedback_state = True,
+ max_length = 20];
+ optional string mac_address = 10 [
+ help_text = "Subscriber MAC address, leanred from DHCP",
+ db_index = False,
+ feedback_state = True,
+ max_length = 20];
}
message AttWorkflowDriverWhiteListEntry (XOSBase) {
option verbose_name = "ONU Whitelist";
option plural = "attworkflowdriverwhitelistentries";
+ option description = "White list entry that permits an ONU with a particular serial number on a particular OLT and PON";
- required manytoone owner->AttWorkflowDriverService:whitelist_entries = 1:1001 [db_index = True, tosca_key=True];
- required string serial_number = 2 [max_length = 254, db_index = False, tosca_key=True, unique_with = "owner"];
- required int32 pon_port_id = 3 [db_index = False, help_text = "PON Port on which this ONU is expected to show up"];
- required string device_id = 4 [max_length = 54, db_index = False, help_text = "OLT Device (logical device id) on which this ONU is expected to show up"];
+ required manytoone owner->AttWorkflowDriverService:whitelist_entries = 1:1001 [
+ help_text = "AttWorkflowDriverService that owns this white list entry",
+ db_index = True,
+ tosca_key = True];
+ required string serial_number = 2 [
+ help_text = "ONU Serial Number",
+ db_index = False,
+ max_length = 254,
+ tosca_key = True,
+ unique_with = "owner"];
+ required int32 pon_port_id = 3 [
+ help_text = "PON Port on which this ONU is expected to show up",
+ db_index = False];
+ required string device_id = 4 [
+ help_text = "OLT Device (logical device id) on which this ONU is expected to show up",
+ db_index = False,
+ max_length = 54];
}