Merge branch 'ni:master' into master

aravindhan-ni · web-flow · commit 9b13e70bfa17 · 2025-07-21T18:52:52.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v2.16.0 (2025-06-13)
+
+### Feature
+
+* Spec client | Add Get Spec API ([#147](https://github.com/ni/nisystemlink-clients-python/issues/147)) ([`b1ebf7c`](https://github.com/ni/nisystemlink-clients-python/commit/b1ebf7cb77f0be84e1e9a76afe52413c720bf0ea))
+
+## v2.15.0 (2025-06-11)
+
+### Feature
+
+* Add delete API for Artifact client ([#142](https://github.com/ni/nisystemlink-clients-python/issues/142)) ([`22f6515`](https://github.com/ni/nisystemlink-clients-python/commit/22f6515bac2b298fb18468095d9a02c782f4f6fb))
+
 ## v2.14.0 (2025-05-30)
 
 ### Feature
diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -19,6 +19,7 @@ API Reference
    api_reference/assetmanagement
    api_reference/systems
    api_reference/test_plan
+   api_reference/artifact
 
 Indices and tables
 ------------------
diff --git a/docs/api_reference/artifact.rst b/docs/api_reference/artifact.rst
@@ -0,0 +1,16 @@
+.. _api_tag_page:
+
+nisystemlink.clients.artifact
+======================
+
+.. autoclass:: nisystemlink.clients.artifact.ArtifactClient
+   :exclude-members: __init__
+
+   .. automethod:: __init__
+   .. automethod:: upload_artifact
+   .. automethod:: download_artifact
+   .. automethod:: delete_artifact
+
+.. automodule:: nisystemlink.clients.artifact.models
+   :members:
+   :imported-members:
diff --git a/docs/api_reference/spec.rst b/docs/api_reference/spec.rst
@@ -12,6 +12,7 @@ nisystemlink.clients.spec
    .. automethod:: delete_specs
    .. automethod:: query_specs
    .. automethod:: update_specs
+   .. automethod:: get_spec
 
 .. automodule:: nisystemlink.clients.spec.models
    :members:
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -170,12 +170,14 @@ With a :class:`.SpecClient` object, you can:
 
 * Query for specifications on any fields using DynamicLinq syntax.
 
+* Get a specification using an Id.
+
 Examples
 ~~~~~~~~
 
-Create and Query Specifications
+Create, Get and Query Specifications
 
-.. literalinclude:: ../examples/spec/query_specs.py
+.. literalinclude:: ../examples/spec/get_and_query_specs.py
    :language: python
    :linenos:
 
diff --git a/examples/artifact/artifacts.py b/examples/artifact/artifacts.py
@@ -1,28 +1,31 @@
-import io
-
-from nisystemlink.clients.artifact import ArtifactClient
-from nisystemlink.clients.core import HttpConfiguration
-
-
-# Setup the server configuration to point to your instance of SystemLink Enterprise
-server_configuration = HttpConfiguration(
-    server_uri="https://yourserver.yourcompany.com",
-    api_key="YourAPIKeyGeneratedFromSystemLink",
-)
-client = ArtifactClient(configuration=server_configuration)
-
-# Define the workspace and artifact content
-workspace = "your workspace ID"
-artifact_stream = io.BytesIO(b"test content")
-
-# Upload the artifact
-upload_response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
-if upload_response and upload_response.id:
-    print(f"Uploaded artifact ID: {upload_response.id}")
-
-# Download the artifact using the ID from the upload response
-artifact_id = upload_response.id
-download_response = client.download_artifact(artifact_id)
-if download_response:
-    downloaded_content = download_response.read()
-    print(f"Downloaded artifact content: {downloaded_content.decode('utf-8')}")
+import io
+
+from nisystemlink.clients.artifact import ArtifactClient
+from nisystemlink.clients.core import HttpConfiguration
+
+
+# Setup the server configuration to point to your instance of SystemLink Enterprise
+server_configuration = HttpConfiguration(
+    server_uri="https://yourserver.yourcompany.com",
+    api_key="YourAPIKeyGeneratedFromSystemLink",
+)
+client = ArtifactClient(configuration=server_configuration)
+
+# Define the workspace and artifact content
+workspace = "your workspace ID"
+artifact_stream = io.BytesIO(b"test content")
+
+# Upload the artifact
+upload_response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
+if upload_response and upload_response.id:
+    print(f"Uploaded artifact ID: {upload_response.id}")
+
+# Download the artifact using the ID from the upload response
+artifact_id = upload_response.id
+download_response = client.download_artifact(artifact_id)
+if download_response:
+    downloaded_content = download_response.read()
+    print(f"Downloaded artifact content: {downloaded_content.decode('utf-8')}")
+
+# Delete the artifact
+client.delete_artifact(artifact_id)
diff --git a/examples/spec/get_and_query_specs.py b/examples/spec/get_and_query_specs.py
@@ -68,7 +68,11 @@
 ]
 
 # Create the specs on the server
-client.create_specs(CreateSpecificationsRequest(specs=spec_requests))
+created_response = client.create_specs(CreateSpecificationsRequest(specs=spec_requests))
+
+# use get for first spec created
+if created_response.created_specs and len(created_response.created_specs) > 0:
+    created_spec = client.get_spec(created_response.created_specs[0].id)
 
 # You can query specs based on any field using DynamicLinq syntax.
 # These are just some representative examples.
diff --git a/nisystemlink/clients/artifact/_artifact_client.py b/nisystemlink/clients/artifact/_artifact_client.py
@@ -4,7 +4,12 @@
 
 from nisystemlink.clients import core
 from nisystemlink.clients.core._uplink._base_client import BaseClient
-from nisystemlink.clients.core._uplink._methods import get, post, response_handler
+from nisystemlink.clients.core._uplink._methods import (
+    delete,
+    get,
+    post,
+    response_handler,
+)
 from nisystemlink.clients.core.helpers._iterator_file_like import IteratorFileLike
 from requests.models import Response
 from uplink import Part, Path
@@ -81,3 +86,13 @@ def download_artifact(self, id: Path) -> IteratorFileLike:
 
         """
         ...
+
+    @delete("artifacts/{id}", args=[Path("id")])
+    def delete_artifact(self, id: str) -> None:
+        """Deletes an artifact.
+
+        Args:
+            id: The ID of the artifact to delete.
+
+        """
+        ...
diff --git a/nisystemlink/clients/spec/_spec_client.py b/nisystemlink/clients/spec/_spec_client.py
@@ -96,6 +96,22 @@ def query_specs(
         """
         ...
 
+    @get("specs/{id}")
+    def get_spec(self, id: str) -> models.Specification:
+        """Retrieves a single spec by id.
+
+        Args:
+            id (str): Unique ID of a specification.
+
+        Returns:
+            The single spec matching `id`
+
+        Raises:
+            ApiException: if unable to communicate with the `nispec` service or if there are invalid
+            arguments.
+        """
+        ...
+
     @post("update-specs")
     def update_specs(
         self, specs: models.UpdateSpecificationsRequest
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "nisystemlink-clients"
-version = "2.14.0"
+version = "2.16.0"
 description = "NI-SystemLink Python API"
 authors = ["National Instruments"]
 maintainers = [
diff --git a/tests/integration/artifact/test_artifact.py b/tests/integration/artifact/test_artifact.py
@@ -1,8 +1,11 @@
 import io
-import os
+from typing import List
 
 import pytest
 from nisystemlink.clients.artifact import ArtifactClient
+from nisystemlink.clients.artifact.models._upload_artifact_response import (
+    UploadArtifactResponse,
+)
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
 
 
@@ -12,35 +15,62 @@ def client(enterprise_config: HttpConfiguration) -> ArtifactClient:
     return ArtifactClient(enterprise_config)
 
 
+@pytest.fixture
+def create_artifact(client: ArtifactClient):
+    """Fixture to return a factory that creates artifact."""
+    created_artifact_ids: List[str] = []
+
+    def _create_artifact(
+        content: bytes = b"test content",
+        cleanup: bool = True,
+        workspace: str = "2300760d-38c4-48a1-9acb-800260812337",
+    ):
+        # Used the main-test default workspace since the client for creating a workspace has not been added yet
+        artifact_stream = io.BytesIO(content)
+        response = client.upload_artifact(workspace=workspace, artifact=artifact_stream)
+        if cleanup:
+            created_artifact_ids.append(response.id)
+
+        return response
+
+    yield _create_artifact
+
+    for artifact_id in created_artifact_ids:
+        client.delete_artifact(artifact_id)
+
+
 @pytest.mark.integration
 @pytest.mark.enterprise
 class TestArtifact:
 
-    def test__upload_artifact__artifact_uploaded(self, client: ArtifactClient):
-        workspace = os.getenv("SYSTEMLINK_WORKSPACE_ID")
+    def test__upload_artifact__artifact_uploaded(
+        self, client: ArtifactClient, create_artifact
+    ):
+        upload_response: UploadArtifactResponse = create_artifact()
 
-        if workspace is not None:
-            artifact_stream = io.BytesIO(b"test content")
+        assert upload_response is not None
+        assert upload_response.id is not None
 
-            response = client.upload_artifact(
-                workspace=workspace, artifact=artifact_stream
-            )
+    def test__download_artifact__artifact_downloaded(
+        self, client: ArtifactClient, create_artifact
+    ):
+        artifact_content = b"test content"
 
-            assert response is not None
-            assert response.id is not None
+        upload_response: UploadArtifactResponse = create_artifact(
+            content=artifact_content
+        )
+        artifact_id = upload_response.id
+        download_response = client.download_artifact(artifact_id)
 
-    def test__download_artifact__artifact_downloaded(self, client: ArtifactClient):
-        workspace = os.getenv("SYSTEMLINK_WORKSPACE_ID")
+        assert download_response is not None
+        assert download_response.read() == artifact_content
 
-        if workspace is not None:
-            artifact_content = b"test content"
-            artifact_stream = io.BytesIO(artifact_content)
+    def test__delete_artifact__artifact_deleted(
+        self, client: ArtifactClient, create_artifact
+    ):
+        upload_response: UploadArtifactResponse = create_artifact(cleanup=False)
+        artifact_id = upload_response.id
 
-            upload_response = client.upload_artifact(
-                workspace=workspace, artifact=artifact_stream
-            )
-            artifact_id = upload_response.id
-            download_response = client.download_artifact(artifact_id)
+        delete_response = client.delete_artifact(artifact_id)
 
-            assert download_response is not None
-            assert download_response.read() == artifact_content
+        assert delete_response is None
diff --git a/tests/integration/spec/test_spec.py b/tests/integration/spec/test_spec.py
@@ -2,6 +2,7 @@
 from typing import List
 
 import pytest
+from nisystemlink.clients.core._api_exception import ApiException
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
 from nisystemlink.clients.spec import SpecClient
 from nisystemlink.clients.spec.models import (
@@ -237,6 +238,39 @@ def test__update_single_same_version__version_updates(
         updated_spec = update_response.updated_specs[0]
         assert updated_spec.version == 1
 
+    def test__get_spec_by_id__spec_matches_expected(
+        self, client: SpecClient, create_specs, product
+    ):
+        productId = product
+        spec = CreateSpecificationsRequestObject(
+            product_id=productId,
+            spec_id="spec1",
+            type=SpecificationType.FUNCTIONAL,
+            keywords=["work", "reviewed"],
+            category="Parametric Specs",
+            block="newBlock",
+        )
+
+        response = create_specs(CreateSpecificationsRequest(specs=[spec]))
+
+        assert response is not None
+        assert len(response.created_specs) == 1
+        created_spec = response.created_specs[0]
+
+        get_spec_response = client.get_spec(created_spec.id)
+
+        assert get_spec_response is not None
+        assert get_spec_response.id == created_spec.id
+        assert get_spec_response.product_id == productId
+
+    def test__get_non_existant_spec_by_id__get_spec_fails(self, client: SpecClient):
+        non_existant_spec_id = "10"
+
+        with pytest.raises(ApiException) as exception_info:
+            client.get_spec(non_existant_spec_id)
+
+        assert exception_info.value.http_status_code == 404
+
     def test__query_product__all_returned(
         self, client: SpecClient, create_specs, create_specs_for_query, product
     ):
diff --git a/tests/integration/test_plan/test_test_plan_client.py b/tests/integration/test_plan/test_test_plan_client.py
