Update documentation of measurement service protos to prefer "ioresou…

…rce" type specialization to "pin" (#44) * Replace references to "pin" type specialization with "ioresource" Signed-off-by: Jonathan Mendez <[email protected]> * Add information about how ioresource.instrument_type annotation is used Signed-off-by: Jonathan Mendez <[email protected]> --------- Signed-off-by: Jonathan Mendez <[email protected]>
ni · Apr 22, 2024 · 6881599 · 6881599
1 parent 0a56a20
commit 6881599
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 7 deletions.
diff --git a/ni/measurementlink/measurement/v1/measurement_service.proto b/ni/measurementlink/measurement/v1/measurement_service.proto
@@ -122,9 +122,9 @@ message ConfigurationParameter {
   // Well-known annotations:
   // - Type specialization. The keys to other annotations will be read based on the value of `ni/type_specialization` annotation.
   //   - Key: "ni/type_specialization"
-  //   - Common Values: "pin" ...    
-  // - For string parameter with ni/type_specialization annotation equals "pin"
-  //   - Key: "ni/pin.instrument_type"
+  //   - Common Values: "ioresource" ...    
+  // - For string parameter with ni/type_specialization annotation equals "ioresource", the "ni/ioresource.instrument_type" annotation will be used by UIs to limit selection of I/O to the specified instrument type.
+  //   - Key: "ni/ioresource.instrument_type"
   //   - Common Values: "niDCPower", "niScope"...
   map<string, string> annotations = 5;
 }

diff --git a/ni/measurementlink/measurement/v2/measurement_service.proto b/ni/measurementlink/measurement/v2/measurement_service.proto
@@ -124,11 +124,11 @@ message ConfigurationParameter {
   // Well-known annotations:
   // - Type specialization. The keys to other annotations will be read based on the value of `ni/type_specialization` annotation.
   //   - Key: "ni/type_specialization"
-  //   - Common Values: "pin", "path", "enum", ...
-  //   - "pin" and "path" parameters require the type field to be TYPE_STRING.
+  //   - Common Values: "ioresource", "path", "enum"...
+  //   - "ioresource" and "path" parameters require the type field to be TYPE_STRING.
   //   - "enum" parameters requires the type field to be TYPE_ENUM.
-  // - For string parameter with ni/type_specialization annotation equals "pin"
-  //   - Key: "ni/pin.instrument_type"
+  // - For string parameter with ni/type_specialization annotation equals "ioresource", the "ni/ioresource.instrument_type" annotation will be used by UIs to limit selection of I/O to the specified instrument type.
+  //   - Key: "ni/ioresource.instrument_type"
   //   - Common Values: "niDCPower", "niScope"...
   // - For enum parameter with ni/type_specialization annotation equals "enum"
   //   - Key: "ni/enum.values"