feat: add get webapps by slug method

https://bluesquare.atlassian.net/browse/PATHWAYS-1048

Author: bramj

openhexa/graphql/graphql_client/__init__.py

@@ -226,6 +226,13 @@
 )
 from .get_file_by_path import GetFileByPath, GetFileByPathGetFileByPath
 from .get_users import GetUsers, GetUsersUsers, GetUsersUsersAvatar
+from .get_webapp_by_slug import (
+    GetWebappBySlug,
+    GetWebappBySlugWebapp,
+    GetWebappBySlugWebappCreatedBy,
+    GetWebappBySlugWebappPermissions,
+    GetWebappBySlugWebappWorkspace,
+)
 from .input_types import (
     AddOrganizationMemberInput,
     AddPipelineOutputInput,
@@ -610,6 +617,11 @@
     "GetUsers",
     "GetUsersUsers",
     "GetUsersUsersAvatar",
+    "GetWebappBySlug",
+    "GetWebappBySlugWebapp",
+    "GetWebappBySlugWebappCreatedBy",
+    "GetWebappBySlugWebappPermissions",
+    "GetWebappBySlugWebappWorkspace",
     "GraphQLClientError",
     "GraphQLClientGraphQLError",
     "GraphQLClientGraphQLMultiError",

openhexa/graphql/graphql_client/client.py

@@ -44,6 +44,7 @@
 from .get_connection import GetConnection, GetConnectionConnectionBySlug
 from .get_file_by_path import GetFileByPath, GetFileByPathGetFileByPath
 from .get_users import GetUsers, GetUsersUsers
+from .get_webapp_by_slug import GetWebappBySlug, GetWebappBySlugWebapp
 from .input_types import (
     AddToFavoritesInput,
     ArchiveWorkspaceInput,
@@ -1093,3 +1094,43 @@ def get_file_by_path(
         )
         data = self.get_data(response)
         return GetFileByPath.model_validate(data).get_file_by_path
+
+    def get_webapp_by_slug(
+        self, workspace_slug: str, webapp_slug: str, **kwargs: Any
+    ) -> Optional[GetWebappBySlugWebapp]:
+        query = gql(
+            """
+            query getWebappBySlug($workspaceSlug: String!, $webappSlug: String!) {
+              webapp(workspaceSlug: $workspaceSlug, slug: $webappSlug) {
+                id
+                name
+                description
+                url
+                icon
+                isFavorite
+                createdBy {
+                  id
+                  displayName
+                  email
+                }
+                workspace {
+                  slug
+                  name
+                }
+                permissions {
+                  update
+                  delete
+                }
+              }
+            }
+            """
+        )
+        variables: Dict[str, object] = {
+            "workspaceSlug": workspace_slug,
+            "webappSlug": webapp_slug,
+        }
+        response = self.execute(
+            query=query, operation_name="getWebappBySlug", variables=variables, **kwargs
+        )
+        data = self.get_data(response)
+        return GetWebappBySlug.model_validate(data).webapp

openhexa/graphql/graphql_client/get_webapp_by_slug.py

@@ -0,0 +1,44 @@
+# Generated by ariadne-codegen
+# Source: openhexa/graphql/queries.graphql
+
+from typing import Any, Optional
+
+from pydantic import Field
+
+from .base_model import BaseModel
+
+
+class GetWebappBySlug(BaseModel):
+    webapp: Optional["GetWebappBySlugWebapp"]
+
+
+class GetWebappBySlugWebapp(BaseModel):
+    id: Any
+    name: str
+    description: Optional[str]
+    url: str
+    icon: Optional[str]
+    is_favorite: bool = Field(alias="isFavorite")
+    created_by: "GetWebappBySlugWebappCreatedBy" = Field(alias="createdBy")
+    workspace: "GetWebappBySlugWebappWorkspace"
+    permissions: "GetWebappBySlugWebappPermissions"
+
+
+class GetWebappBySlugWebappCreatedBy(BaseModel):
+    id: Any
+    display_name: str = Field(alias="displayName")
+    email: str
+
+
+class GetWebappBySlugWebappWorkspace(BaseModel):
+    slug: str
+    name: str
+
+
+class GetWebappBySlugWebappPermissions(BaseModel):
+    update: bool
+    delete: bool
+
+
+GetWebappBySlug.model_rebuild()
+GetWebappBySlugWebapp.model_rebuild()

openhexa/graphql/queries.graphql

@@ -487,3 +487,27 @@ query getFileByPath($path: String!, $workspaceSlug: String!) {
         type
     }
 }
+
+query getWebappBySlug($workspaceSlug: String!, $webappSlug: String!) {
+    webapp(workspaceSlug: $workspaceSlug, slug: $webappSlug) {
+        id
+        name
+        description
+        url
+        icon
+        isFavorite
+        createdBy {
+            id
+            displayName
+            email
+        }
+        workspace {
+            slug
+            name
+        }
+        permissions {
+            update
+            delete
+        }
+    }
+}

openhexa/graphql/schema.generated.graphql

@@ -3381,7 +3381,7 @@ type Query {
 
   """Search users."""
   users(organizationId: UUID, query: String!, workspaceSlug: String): [User!]!
-  webapp(id: UUID!): Webapp
+  webapp(workspaceSlug: String!, slug: String!): Webapp
   webapps(favorite: Boolean, page: Int, perPage: Int, workspaceSlug: String): WebappsPage!
   workspace(slug: String!): Workspace
   workspaces(organizationId: UUID, page: Int, perPage: Int, query: String): WorkspacePage!

openhexa/sdk/workspaces/current_workspace.py

@@ -661,3 +661,27 @@ def get_file(self, path: str) -> File:
             size=result.size,
             type=result.type,
         )
+
+    def get_webapp(self, webapp_slug: str):
+        """Get a webapp by its slug.
+
+        Parameters
+        ----------
+        webapp_slug : str
+            The slug identifier of the webapp
+
+        Returns
+        -------
+        The webapp object with name, url, description and other properties
+
+        Raises
+        ------
+        ValueError
+            If the webapp does not exist
+        """
+        webapp = OpenHexaClient().get_webapp_by_slug(workspace_slug=self.slug, webapp_slug=webapp_slug)
+
+        if not webapp:
+            raise ValueError(f"Webapp {webapp_slug} does not exist in workspace {self.slug}.")
+
+        return webapp