Skip to content

Commit 4e382cc

Browse files
dixonjoelJoel Dixon
andauthored
Rename custom metadata notebook to extension attributes (#75)
* Rename custom metadata to extension attributes * Rename custom metadata to extension attributes --------- Co-authored-by: Joel Dixon <joel.dixon@emerson.com>
1 parent b79e77b commit 4e382cc

File tree

8 files changed

+6
-6
lines changed

8 files changed

+6
-6
lines changed

docs/examples/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Additional examples for various use cases:
2929

3030
* `publish_measurement.ipynb <https://github.com/ni/datastore-python/blob/main/examples/notebooks/overview/publish_measurement.ipynb>`_ - Basic measurement publishing
3131
* `alias.ipynb <https://github.com/ni/datastore-python/blob/main/examples/notebooks/alias/alias.ipynb>`_ - Working with aliases
32-
* `custom_metadata.ipynb <https://github.com/ni/datastore-python/blob/main/examples/notebooks/custom-metadata/custom_metadata.ipynb>`_ - Custom metadata examples
32+
* `extension_attributes.ipynb <https://github.com/ni/datastore-python/blob/main/examples/notebooks/extension-attributes/extension_attributes.ipynb>`_ - Extension attributes examples
3333
* `publish_waveforms.ipynb <https://github.com/ni/datastore-python/blob/main/examples/notebooks/voltage-regulator/publish_waveforms.ipynb>`_ - Publishing waveform data
3434

3535
Getting Started with Notebooks

examples/notebooks/custom-metadata/cable_schema.toml renamed to examples/notebooks/extension-attributes/cable_schema.toml

File renamed without changes.

examples/notebooks/custom-metadata/custom_metadata.ipynb renamed to examples/notebooks/extension-attributes/extension_attributes.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
"id": "936b1eca",
3333
"metadata": {},
3434
"source": [
35-
"## Create the Hardware Objects with their Custom Metadata\n",
35+
"## Create the Hardware Objects with their Extension Attributes\n",
3636
"\n",
37-
"Now that the schemas are registered, we can create Hardware objects that specify custom metadata to meet the requirements of the registered schemas. Each piece of hardware can use it's own schema."
37+
"Now that the schemas are registered, we can create Hardware objects that specify extension attributes to meet the requirements of the registered schemas. Each piece of hardware can use it's own schema."
3838
]
3939
},
4040
{
@@ -80,7 +80,7 @@
8080
"source": [
8181
"## Create a Schema for the Test Result (optional)\n",
8282
"\n",
83-
"If you specify a schema for the test result, it will ensure that all the hardware custom metadata is a superset of whatever metadata is specified in the session schema. This allows the author to ensure all hardware has some consistent attributes.\n"
83+
"If you specify a schema for the test result, it will ensure that all the hardware extension attributes are a superset of whatever metadata is specified in the session schema. This allows the author to ensure all hardware has some consistent attributes.\n"
8484
]
8585
},
8686
{

examples/notebooks/custom-metadata/scope_schema.toml renamed to examples/notebooks/extension-attributes/scope_schema.toml

File renamed without changes.

examples/notebooks/custom-metadata/socket_schema.toml renamed to examples/notebooks/extension-attributes/socket_schema.toml

File renamed without changes.

examples/notebooks/custom-metadata/test_result_schema.toml renamed to examples/notebooks/extension-attributes/test_result_schema.toml

File renamed without changes.

src/ni/datastore/data/_types/_step.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def __init__(
8181
start_date_time: The start date and time of the step execution.
8282
end_date_time: The end date and time of the step execution.
8383
link: Optional link to external resources for this step.
84-
extension: Additional custom metadata as key-value pairs.
84+
extension: Additional extension attributes as key-value pairs.
8585
schema_id: ID of the extension schema for validating extensions.
8686
error_information: Error or exception information in case of
8787
step failure.

src/ni/datastore/data/_types/_test_result.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ def __init__(
104104
outcome: The outcome of the test execution (PASSED, FAILED,
105105
INDETERMINATE, or UNSPECIFIED).
106106
link: Optional link to external resources for this test result.
107-
extension: Additional custom metadata as key-value pairs.
107+
extension: Additional extension attributes as key-value pairs.
108108
schema_id: ID of the extension schema for validating extensions.
109109
error_information: Error or exception information in case of
110110
test result failure.

0 commit comments

Comments
 (0)