Add information about how ioresource.instrument_type annotation is used

Signed-off-by: Jonathan Mendez <[email protected]>
ni · Apr 22, 2024 · 989efe8 · 989efe8
1 parent fbb96fd
commit 989efe8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/ni/measurementlink/measurement/v1/measurement_service.proto b/ni/measurementlink/measurement/v1/measurement_service.proto
@@ -123,7 +123,7 @@ message ConfigurationParameter {
   // - 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: "ioresource" ...    
-  // - For string parameter with ni/type_specialization annotation equals "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
@@ -127,7 +127,7 @@ message ConfigurationParameter {
   //   - 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 "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"...
   // - For enum parameter with ni/type_specialization annotation equals "enum"