diff --git a/docs/examples/index.rst b/docs/examples/index.rst index 3a387a8..4ac4f43 100644 --- a/docs/examples/index.rst +++ b/docs/examples/index.rst @@ -29,7 +29,7 @@ Additional examples for various use cases: * `publish_measurement.ipynb `_ - Basic measurement publishing * `alias.ipynb `_ - Working with aliases -* `custom_metadata.ipynb `_ - Custom metadata examples +* `extension_attributes.ipynb `_ - Extension attributes examples * `publish_waveforms.ipynb `_ - Publishing waveform data Getting Started with Notebooks diff --git a/examples/notebooks/custom-metadata/cable_schema.toml b/examples/notebooks/extension-attributes/cable_schema.toml similarity index 100% rename from examples/notebooks/custom-metadata/cable_schema.toml rename to examples/notebooks/extension-attributes/cable_schema.toml diff --git a/examples/notebooks/custom-metadata/custom_metadata.ipynb b/examples/notebooks/extension-attributes/extension_attributes.ipynb similarity index 94% rename from examples/notebooks/custom-metadata/custom_metadata.ipynb rename to examples/notebooks/extension-attributes/extension_attributes.ipynb index 3bed949..8135c74 100644 --- a/examples/notebooks/custom-metadata/custom_metadata.ipynb +++ b/examples/notebooks/extension-attributes/extension_attributes.ipynb @@ -32,9 +32,9 @@ "id": "936b1eca", "metadata": {}, "source": [ - "## Create the Hardware Objects with their Custom Metadata\n", + "## Create the Hardware Objects with their Extension Attributes\n", "\n", - "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." + "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." ] }, { @@ -80,7 +80,7 @@ "source": [ "## Create a Schema for the Test Result (optional)\n", "\n", - "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" + "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" ] }, { diff --git a/examples/notebooks/custom-metadata/scope_schema.toml b/examples/notebooks/extension-attributes/scope_schema.toml similarity index 100% rename from examples/notebooks/custom-metadata/scope_schema.toml rename to examples/notebooks/extension-attributes/scope_schema.toml diff --git a/examples/notebooks/custom-metadata/socket_schema.toml b/examples/notebooks/extension-attributes/socket_schema.toml similarity index 100% rename from examples/notebooks/custom-metadata/socket_schema.toml rename to examples/notebooks/extension-attributes/socket_schema.toml diff --git a/examples/notebooks/custom-metadata/test_result_schema.toml b/examples/notebooks/extension-attributes/test_result_schema.toml similarity index 100% rename from examples/notebooks/custom-metadata/test_result_schema.toml rename to examples/notebooks/extension-attributes/test_result_schema.toml diff --git a/src/ni/datastore/data/_types/_step.py b/src/ni/datastore/data/_types/_step.py index 46695f4..4bc598f 100644 --- a/src/ni/datastore/data/_types/_step.py +++ b/src/ni/datastore/data/_types/_step.py @@ -81,7 +81,7 @@ def __init__( start_date_time: The start date and time of the step execution. end_date_time: The end date and time of the step execution. link: Optional link to external resources for this step. - extension: Additional custom metadata as key-value pairs. + extension: Additional extension attributes as key-value pairs. schema_id: ID of the extension schema for validating extensions. error_information: Error or exception information in case of step failure. diff --git a/src/ni/datastore/data/_types/_test_result.py b/src/ni/datastore/data/_types/_test_result.py index 4c823b1..6bc9cda 100644 --- a/src/ni/datastore/data/_types/_test_result.py +++ b/src/ni/datastore/data/_types/_test_result.py @@ -104,7 +104,7 @@ def __init__( outcome: The outcome of the test execution (PASSED, FAILED, INDETERMINATE, or UNSPECIFIED). link: Optional link to external resources for this test result. - extension: Additional custom metadata as key-value pairs. + extension: Additional extension attributes as key-value pairs. schema_id: ID of the extension schema for validating extensions. error_information: Error or exception information in case of test result failure.