Addressed Anees' comments

Author: aghaffarkhah

diag/diag.proto

@@ -15,7 +15,7 @@
 //
 
 // This file defines the gNOI APIs used to perform diagnostic operations on a
-// switching box.
+// network device.
 syntax = "proto3";
 
 package gnoi.diag;
@@ -24,11 +24,12 @@ package gnoi.diag;
 // 1- BERT related RPCs: Used to perform Bit Error Rate Test (BERT)
 //    operations on a set of ports.
 // 2- BURNIN related RPCs: Used to perform a vendor-provided Burnin test on the
-//    switch to ensure the box is ready to start serving traffic. Burnin tests
-//    are typically run in the field, as part of turnup or repair workflow.
+//    network device to ensure the device is ready to start serving traffic.
+//    Burnin tests are typically run in the field, as part of turnup or repair
+//    workflow.
 // Note: The RPCs defined here are are stateless operations and them
-// failing/passing should not leave any permanent artifact on the switch (unless
-// there is something wrong HW-wise).
+// failing/passing should not leave any permanent artifact on the network device
+//  (unless there is something wrong HW-wise).
 // Note: By "port" we refer to a channelized frontpanel or backplane port on a
 // chassis. In OpenConfig YANG models, there is a one-to-one relationship
 // between a port as used here and an "interface". Therefore, the "gnoi.Path"
@@ -58,15 +59,15 @@ service Diag {
   // - When the BERT operation ID does not match the in progress or completed
   //   BERT operation on any of the ports specified by the request.
   // The RPC returns an OK status of none of these situations is encountered.
-  // Note that a BERT operation is considered completed if the switch has a
+  // Note that a BERT operation is considered completed if the device has a
   // record/history of it. Also note that it is OK to receive a stop request for
   // a port which has completed BERT, as long as the recorded BERT operation ID
   // matches the one specified by the request.
   rpc StopBERT(StopBERTRequest) returns(StopBERTResponse) {}
 
   // Gets BERT results during the BERT operation or after it completes. The
   // caller uses the BERT operation ID it previously used when starting the
-  // operation to query it. The switch is expected to keep the results for
+  // operation to query it. The device is expected to keep the results for
   // last N BERT operations for some amount of time, as specified by the
   // product requirement. This RPC is expected to return error status in the
   // following situations:
@@ -75,7 +76,7 @@ service Diag {
   // - When the BERT operation ID does not match the in progress or completed
   //   BERT operation on any of the ports specified by the request.
   // The RPC returns an OK status of none of these situations is encountered.
-  // Note that a BERT operation is considered completed if switch has a
+  // Note that a BERT operation is considered completed if device has a
   // record of it.
   rpc GetBERTResult(GetBERTResultRequest) returns(GetBERTResultResponse) {}
 
@@ -143,6 +144,7 @@ message StartBERTRequest {
   // Unique BERT operation ID specified by the client. Multiple BERTs run on
   // different ports can have the same BERT operation ID. This ID will be used
   // later to stop the operation and/or get its results.
+  // TODO: Investigate whether we can use numerical IDs instead.
   string bert_operation_id = 1;
   // All the per-port BERTs that are considered one BERT operation and have the
   // same BERT operation ID.
@@ -190,6 +192,9 @@ message StopBERTResponse {
   repeated PerPortResponse per_port_responses = 2;
 }
 
+// TODO: If there is no use case to get the BERT results for all the ports
+// independent of the bert_operation_id, we can simplify this message and
+// return the results for all the ports associated with an operation ID.
 message GetBERTResultRequest {
   // Per-port BERT get result requests.
   message PerPortRequest {