You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update data.client and metadata.client package dependencies to the latest (#63)
* Update data.proto and fix mypy errors
* Update to the latest versions of data.client and metadata.client
* Fix a couple tests
* Run poetry update to include renovate changes
* Rename wrapper class fields to match .proto fields
* Fix ni-python-styleguide error
* Add error_information to TestResult
* Add error_information to Step class
* Add outcome field to Step class
* Rename step_name to name and step_type to type in Step class
- Updated __slots__, __init__ parameters, and field assignments
- Updated from_protobuf and to_protobuf methods
- Updated __eq__ method and docstring
- Updated all test files to use new field names
- Maintains compatibility with protobuf schema
* Fix custom_metadata notebook
* Update TestResult.test_result_name to name
* Change condition_name to name and condition_type to type.
* Rename alias_name, measurement_name, and measurement_notes.
* Rename schema_id to id
* Fix overview example with latest code changes
* Fix some notebooks
* Fix query notebooks
* Fix voltage-regulator notebook
* Fix mypy errors
* Add notes to publish_measurement_batch
* Update documentation for field name changes
* Make start_date_time and end_date_time writable.
* Update TestResult fields
* Clear query_metadata outputs
* Remove comment
---------
Co-authored-by: Joel Dixon <[email protected]>
Copy file name to clipboardExpand all lines: docs/reference/ni-data-store.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,14 @@ A **TestResult** represents a complete test session or test execution run for a
16
16
-`software_item_ids` (list of strings) - IDs of software used during testing
17
17
-`hardware_item_ids` (list of strings) - IDs of hardware used during testing
18
18
-`test_adapter_ids` (list of strings) - IDs of test adapters used
19
-
-`test_result_name` (string) - Human-readable name for the test run
19
+
-`name` (string) - Human-readable name for the test run
20
20
-`start_date_time` (timestamp) - When the test execution started
21
21
-`end_date_time` (timestamp) - When the test execution finished
22
22
-`outcome` (enum) - Overall test result (PASSED, FAILED, INDETERMINATE, UNSPECIFIED)
23
23
-`link` (string) - Optional link to additional resources
24
24
-`extensions` (dict) - Custom key-value pairs for additional metadata
25
25
-`schema_id` (string) - ID of the schema for extension validation
26
+
-`error_information` (ErrorInformation) - Error details if test result failed
26
27
27
28
**Real-world example**: When you put a circuit board on a test station and run a complete validation sequence, that entire session becomes one TestResult. It includes metadata like who ran the test, when it was run, what test station was used, and links to all the measurements and steps that were performed.
28
29
@@ -34,14 +35,16 @@ A **Step** represents an individual test procedure or operation within a larger
34
35
-`parent_step_id` (string) - ID of parent step (for hierarchical steps)
35
36
-`test_result_id` (string) - ID of the associated TestResult
36
37
-`test_id` (string) - ID of the test definition/specification
37
-
-`step_name` (string) - Human-readable name for the step
38
-
-`step_type` (string) - Type/category of the step
38
+
-`name` (string) - Human-readable name for the step
39
+
-`type` (string) - Type/category of the step
39
40
-`notes` (string) - Additional notes about the step
40
41
-`start_date_time` (timestamp) - When the step started executing
41
42
-`end_date_time` (timestamp) - When the step finished executing
43
+
-`outcome` (enum) - Result of this step (PASSED, FAILED, INDETERMINATE, UNSPECIFIED)
42
44
-`link` (string) - Optional link to additional resources
43
45
-`extensions` (dict) - Custom key-value pairs for additional metadata
44
46
-`schema_id` (string) - ID of the schema for extension validation
47
+
-`error_information` (ErrorInformation) - Error details if step failed
45
48
46
49
**Real-world examples**:
47
50
- "Measure DC Voltage on Pin 5"
@@ -64,9 +67,9 @@ A **PublishedMeasurement** represents actual measurement data captured during a
64
67
-`software_item_ids` (list of strings) - Software used to capture this measurement
65
68
-`hardware_item_ids` (list of strings) - Hardware used to capture this measurement
66
69
-`test_adapter_ids` (list of strings) - Test adapters used to capture this measurement
67
-
-`measurement_name` (string) - Name used to group related measurements
70
+
-`name` (string) - Name used to group related measurements
68
71
-`data_type` (string) - Type of data (e.g., "Scalar", "AnalogWaveform", "Spectrum")
69
-
-`measurement_notes` (string) - Additional notes about the measurement
72
+
-`notes` (string) - Additional notes about the measurement
70
73
-`start_date_time` (timestamp) - When measurement capture started
71
74
-`end_date_time` (timestamp) - When measurement capture finished
72
75
-`outcome` (enum) - Result of this measurement (PASSED, FAILED, INDETERMINATE, UNSPECIFIED)
@@ -95,8 +98,8 @@ A **PublishedCondition** represents environmental or contextual information that
95
98
**Fields:**
96
99
-`moniker` (Moniker) - Data location identifier for retrieving the condition value
97
100
-`id` (string) - Unique identifier for this condition
98
-
-`condition_name` (string) - Name of the condition (e.g., "Temperature", "Supply Voltage")
99
-
-`condition_type` (string) - Type/category of the condition (e.g., "Environment", "Input Parameter")
101
+
-`name` (string) - Name of the condition (e.g., "Temperature", "Supply Voltage")
102
+
-`type` (string) - Type/category of the condition (e.g., "Environment", "Input Parameter")
100
103
-`step_id` (string) - ID of the associated Step
101
104
-`test_result_id` (string) - ID of the associated TestResult
Each UUT instance tracks the test history for that specific physical device throughout its lifecycle.
84
85
@@ -185,7 +186,7 @@ A **Test Adapter** represents a test fixture, mechanical setup, or interface use
185
186
An **Extension Schema** defines the structure and validation rules for custom extension fields that can be added to any metadata entity.
186
187
187
188
**Fields:**
188
-
-`schema_id` (string) - Unique identifier for the schema
189
+
-`id` (string) - Unique identifier for the schema
189
190
-`schema` (string) - The schema definition itself (JSON Schema format)
190
191
191
192
**Real-world examples**:
@@ -198,7 +199,7 @@ An **Extension Schema** defines the structure and validation rules for custom ex
198
199
An **Alias** provides a human-readable name that points to any metadata entity. This creates a layer of abstraction that makes test code more maintainable and readable.
199
200
200
201
**Fields:**
201
-
-`alias_name` (string) - The registered alias name for the metadata instance
202
+
-`name` (string) - The registered alias name for the metadata instance
202
203
-`target_type` (enum) - The type of the aliased metadata instance (see `AliasTargetType` enum)
203
204
-`target_id` (string) - The unique identifier for the aliased metadata instance
0 commit comments