Skip to content

Commit

Permalink
fix lint format error
Browse files Browse the repository at this point in the history
Signed-off-by: Huong Nguyen <[email protected]>
  • Loading branch information
Huong Nguyen committed Jan 17, 2025
1 parent 5104506 commit 00bce4b
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 12 deletions.
19 changes: 11 additions & 8 deletions package/kedro_viz/api/rest/responses/version.py
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
"""`kedro_viz.api.rest.responses.version` contains response classes
and utility functions for the `/version` REST endpoint"""

from kedro_viz import __version__
from kedro_viz.integrations.pypi import get_latest_version, is_running_outdated_version
from pydantic import ConfigDict

from kedro_viz import __version__
from kedro_viz.api.rest.responses.base import BaseAPIResponse
from kedro_viz.integrations.pypi import get_latest_version, is_running_outdated_version


class VersionAPIResponse(BaseAPIResponse):
"""
VersionAPIResponse is a subclass of BaseAPIResponse that represents the response structure for version API.
Attributes:
installed (str): The installed version of the Kedro Viz package.
isOutdated (bool): Whether the installed version is outdated.
is_outdated (bool): Whether the installed version is outdated.
latest (str): The latest available version of the Kedro Viz package.
"""

installed: str
isOutdated: bool
is_outdated: bool
latest: str
model_config = ConfigDict(
json_schema_extra={
"installed": __version__,
"isOutdated": False,
"latest": "0.0.0"
"is_outdated": False,
"latest": "0.0.0",
}
)


def get_version_response():
"""API response for `/api/version`."""
installed_version = str(__version__)
Expand All @@ -35,6 +38,6 @@ def get_version_response():

return VersionAPIResponse(
installed=installed_version,
isOutdated=is_outdated,
is_outdated=is_outdated,
latest=latest_version,
)
)
2 changes: 1 addition & 1 deletion package/kedro_viz/api/rest/router.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,11 +53,11 @@ async def get_single_node_metadata(node_id: str):
async def get_single_pipeline_data(registered_pipeline_id: str):
return get_pipeline_response(registered_pipeline_id)


@router.get(
"/version",
response_model=VersionAPIResponse,
)

async def get_version():
return get_version_response()

Expand Down
5 changes: 3 additions & 2 deletions package/tests/test_api/test_rest/test_router.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,16 @@ def test_metadata(
assert response.status_code == expected_status_code
assert response.json() == expected_response


def test_version(client):
response = client.get("/api/version")
assert response.status_code == 200

json_response = response.json()
assert "installed" in json_response
assert "isOutdated" in json_response
assert "is_outdated " in json_response
assert "latest" in json_response

assert isinstance(json_response["installed"], str)
assert isinstance(json_response["isOutdated"], bool)
assert isinstance(json_response["is_outdated "], bool)
assert isinstance(json_response["latest"], str)
2 changes: 1 addition & 1 deletion src/components/wrapper/wrapper.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const Wrapper = ({ displayGlobalNavigation, theme }) => {
const response = await request.json();

if (request.ok) {
setIsOutdated(response.isOutdated);
setIsOutdated(response.is_outdated);
setLatestVersion(response.latest);
}
} catch (error) {
Expand Down

0 comments on commit 00bce4b

Please sign in to comment.