gaard-api 0.2.12__tar.gz → 0.2.13__tar.gz

{gaard_api-0.2.12/src/gaard_api.egg-info → gaard_api-0.2.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gaard-api
-Version: 0.2.12
+Version: 0.2.13
 Summary: GAARD backend web services providing admin interface
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{gaard_api-0.2.12 → gaard_api-0.2.13}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gaard-api"
-version = "0.2.12"
+version = "0.2.13"
 description = "GAARD backend web services providing admin interface"
 readme = "README.md"
 requires-python = ">=3.11"

{gaard_api-0.2.12 → gaard_api-0.2.13}/src/gaard_api/admin/services.py

@@ -2229,6 +2229,7 @@ def build_table_settings(
         tables[table.name] = {
             "selected": bool(existing.get("selected", True)),
             "description": str(existing.get("description", "")),
+            "view_description": str(existing.get("view_description", "")),
             "primary_key_prompt": str(existing.get("primary_key_prompt", "")),
             "foreign_key_prompt": str(existing.get("foreign_key_prompt", "")),
             "join_logic": str(existing.get("join_logic", "")),

{gaard_api-0.2.12 → gaard_api-0.2.13}/src/gaard_api/admin-web/assets/main.js

@@ -100,7 +100,7 @@ var state = {
     loadedName: "",
     loadedSql: "",
     name: "",
-    description: "",
+    view_description: "",
     sql: "",
     error: "",
     success: "",
@@ -1926,7 +1926,7 @@ function renderDatasourceViewDialog() {
         </div>
         <form id="datasource-view-form" class="form-grid">
           <label>View name<input name="name" value="${escapeHtml(dialog.name || "")}" autocomplete="off" /></label>
-          <label>View description<textarea name="description">${escapeHtml(dialog.description || "")}</textarea></label>
+          <label>View description<textarea name="view_description">${escapeHtml(dialog.view_description || "")}</textarea></label>
           <label>SQL<textarea name="sql" class="textarea-small" spellcheck="false">${escapeHtml(dialog.sql || "")}</textarea></label>
           ${busy === "load" ? `<p class="muted"><span class="spinner" aria-hidden="true"></span> Loading view definition.</p>` : ""}
           ${dialog.error ? `<p class="error">${escapeHtml(dialog.error)}</p>` : ""}
@@ -1976,6 +1976,7 @@ function getDatasourceSchemaDraftTables(rawTables, tableSettings) {
     state.datasourceSchemaDraftTables[table.name] = {
       selected: settings.selected !== false,
       description: settings.description || "",
+      view_description: settings.view_description || "",
       primary_key_prompt: settings.primary_key_prompt || "",
       foreign_key_prompt: settings.foreign_key_prompt || "",
       join_logic: settings.join_logic || ""
@@ -3340,7 +3341,7 @@ function defaultDatasourceViewDialog() {
     loadedName: "",
     loadedSql: "",
     name: "",
-    description: "",
+    view_description: "",
     sql: "",
     error: "",
     success: "",
@@ -3367,8 +3368,7 @@ async function openEditDatasourceViewDialog(event) {
   const rawTables = state.datasourceSchema?.item?.raw_schema?.tables || [];
   const tableSettings = state.datasourceSchema?.item?.table_settings?.tables || {};
   const draftSettings = getDatasourceSchemaDraftTables(rawTables, tableSettings)[viewName] || {};
-  const hasDraftDescription = Object.prototype.hasOwnProperty.call(draftSettings, "description");
-  const draftDescription = hasDraftDescription ? draftSettings.description || "" : "";
+  const draftViewDescription = draftSettings.view_description || "";
   state.datasourceViewDialog = {
     ...defaultDatasourceViewDialog(),
     open: true,
@@ -3376,14 +3376,14 @@ async function openEditDatasourceViewDialog(event) {
     originalName: viewName,
     loadedName: viewName,
     name: viewName,
-    description: draftDescription,
+    view_description: draftViewDescription,
     busy: "load"
   };
   render();
   try {
     const result = await api(`/api/v1/admin/datasources/${selected.id}/schema/views/${encodeURIComponent(viewName)}`);
     const item = result.item || {};
-    const description = hasDraftDescription ? draftDescription : item.description || "";
+    const viewDescription = draftViewDescription || item.view_description || item.description || "";
     state.datasourceViewDialog = {
       ...state.datasourceViewDialog,
       mode: "edit",
@@ -3391,7 +3391,7 @@ async function openEditDatasourceViewDialog(event) {
       loadedName: item.name || viewName,
       loadedSql: item.sql || "",
       name: item.name || viewName,
-      description,
+      view_description: viewDescription,
       sql: item.sql || "",
       busy: "",
       error: "",
@@ -3420,14 +3420,14 @@ function readDatasourceViewDialogPayload() {
     const dialog = state.datasourceViewDialog || {};
     return {
       name: String(dialog.name || "").trim(),
-      description: String(dialog.description || ""),
+      view_description: String(dialog.view_description || ""),
       sql: String(dialog.sql || "")
     };
   }
   const data = new FormData(form);
   return {
     name: String(data.get("name") || "").trim(),
-    description: String(data.get("description") || ""),
+    view_description: String(data.get("view_description") || ""),
     sql: String(data.get("sql") || "")
   };
 }
@@ -3464,7 +3464,7 @@ async function generateDatasourceViewSql() {
   try {
     const result = await api(`/api/v1/admin/datasources/${selected.id}/schema/views/generate-sql`, {
       method: "POST",
-      body: JSON.stringify({ name: payload.name, description: payload.description })
+      body: JSON.stringify({ name: payload.name, view_description: payload.view_description })
     });
     state.datasourceViewDialog = {
       ...state.datasourceViewDialog,
@@ -3546,7 +3546,7 @@ async function saveDatasourceView(event) {
     const result = canSaveSettingsOnly
       ? await api(`/api/v1/admin/datasources/${selected.id}/schema/views/${encodeURIComponent(dialog.originalName || payload.name)}`, {
           method: "PUT",
-          body: JSON.stringify({ description: payload.description })
+          body: JSON.stringify({ view_description: payload.view_description })
         })
       : dialog.mode === "edit"
         ? await api(`/api/v1/admin/datasources/${selected.id}/schema/views/${encodeURIComponent(dialog.originalName || payload.name)}/execute`, {
@@ -3689,6 +3689,7 @@ async function saveDatasourceSchema(event) {
     tables[table.name] = {
       selected: draft.selected !== false,
       description: draft.description || "",
+      view_description: draft.view_description || "",
       primary_key_prompt: draft.primary_key_prompt || "",
       foreign_key_prompt: draft.foreign_key_prompt || "",
       join_logic: draft.join_logic || ""

{gaard_api-0.2.12 → gaard_api-0.2.13}/src/gaard_api/api/v1/admin.py

@@ -363,22 +363,33 @@ class DatasourceSchemaTableSettingsRequest(BaseModel):
 class DatasourceViewSqlGenerationRequest(BaseModel):
     name: str = Field(min_length=1, max_length=128)
     description: str = Field(default="", max_length=20000)
+    view_description: str | None = Field(default=None, max_length=20000)
 
 
 class DatasourceViewExecuteRequest(BaseModel):
     name: str = Field(min_length=1, max_length=128)
     description: str = Field(default="", max_length=20000)
+    view_description: str | None = Field(default=None, max_length=20000)
     sql: str = Field(min_length=1, max_length=200000)
 
 
 class DatasourceViewUpdateRequest(BaseModel):
     name: str = Field(min_length=1, max_length=128)
     description: str = Field(default="", max_length=20000)
+    view_description: str | None = Field(default=None, max_length=20000)
     sql: str = Field(min_length=1, max_length=200000)
 
 
 class DatasourceViewSettingsRequest(BaseModel):
     description: str = Field(default="", max_length=20000)
+    view_description: str | None = Field(default=None, max_length=20000)
+
+
+def request_view_description(request: Any) -> str:
+    view_description = getattr(request, "view_description", None)
+    if view_description is not None:
+        return view_description
+    return str(getattr(request, "description", ""))
 
 
 class BusinessLogicSuggestionUpdateRequest(BaseModel):
@@ -3248,6 +3259,27 @@ def datasource_view_description_from_cache(
     connector: DatasourceConnector,
     view_name: str,
     actor: str,
+) -> str:
+    cache = get_datasource_schema_cache(session, connector.id)
+    if cache is None:
+        cache = introspect_datasource_connector(session, connector, actor)
+    settings = json_loads(cache.table_settings_json)
+    tables = settings.get("tables", {})
+    direct = tables.get(view_name, {})
+    if direct:
+        return str(direct.get("view_description", direct.get("description", "")))
+    lowered = view_name.lower()
+    for name, item in tables.items():
+        if str(name).lower() == lowered:
+            return str(item.get("view_description", item.get("description", "")))
+    return ""
+
+
+def datasource_view_logic_from_cache(
+    session: Session,
+    connector: DatasourceConnector,
+    view_name: str,
+    actor: str,
 ) -> str:
     cache = get_datasource_schema_cache(session, connector.id)
     if cache is None:
@@ -3282,14 +3314,23 @@ def get_datasource_view_definition(
     finally:
         engine.dispose()
 
+    view_description = datasource_view_description_from_cache(
+        session,
+        connector,
+        existing_name,
+        actor,
+    )
+    datasource_logic = datasource_view_logic_from_cache(
+        session,
+        connector,
+        existing_name,
+        actor,
+    )
     return {
         "name": existing_name,
-        "description": datasource_view_description_from_cache(
-            session,
-            connector,
-            existing_name,
-            actor,
-        ),
+        "description": view_description,
+        "view_description": view_description,
+        "datasource_logic": datasource_logic,
         "sql": view_sql_for_editor(connector, existing_name, definition),
     }
 
@@ -3298,7 +3339,7 @@ def save_datasource_view_settings_to_cache(
     session: Session,
     cache: DatasourceSchemaCache,
     view_name: str,
-    description: str,
+    view_description: str,
     actor: str,
 ) -> DatasourceSchemaCache:
     schema = json_loads(cache.schema_json)
@@ -3315,7 +3356,7 @@ def save_datasource_view_settings_to_cache(
     table_settings = settings.setdefault("tables", {})
     existing = table_settings.setdefault(actual_view_name, {})
     existing["selected"] = True
-    existing["description"] = description.strip()
+    existing["view_description"] = view_description.strip()
     return update_schema_table_settings(
         session=session,
         cache=cache,
@@ -3328,7 +3369,7 @@ def execute_datasource_view_sql(
     session: Session,
     connector: DatasourceConnector,
     view_name: str,
-    description: str,
+    view_description: str,
     sql: str,
     actor: str,
 ) -> DatasourceSchemaCache:
@@ -3352,7 +3393,7 @@ def execute_datasource_view_sql(
         session,
         cache,
         normalized_name,
-        description,
+        view_description,
         actor,
     )
 
@@ -3361,7 +3402,7 @@ def save_datasource_view_settings(
     session: Session,
     connector: DatasourceConnector,
     view_name: str,
-    description: str,
+    view_description: str,
     actor: str,
 ) -> DatasourceSchemaCache:
     normalized_name = normalize_datasource_view_name(view_name)
@@ -3372,7 +3413,7 @@ def save_datasource_view_settings(
         session,
         cache,
         normalized_name,
-        description,
+        view_description,
         actor,
     )
 
@@ -3382,7 +3423,7 @@ def update_datasource_view_sql(
     connector: DatasourceConnector,
     current_view_name: str,
     next_view_name: str,
-    description: str,
+    view_description: str,
     sql: str,
     actor: str,
 ) -> DatasourceSchemaCache:
@@ -3416,7 +3457,7 @@ def update_datasource_view_sql(
         session,
         cache,
         next_name,
-        description,
+        view_description,
         actor,
     )
 
@@ -3448,11 +3489,11 @@ def generate_datasource_view_sql(
     session: Session,
     connector: DatasourceConnector,
     view_name: str,
-    description: str,
+    view_description: str,
     actor: str,
 ) -> str:
     normalized_name = normalize_datasource_view_name(view_name)
-    if not description.strip():
+    if not view_description.strip():
         raise ValueError("View description is required to generate SQL.")
 
     cache = get_or_create_datasource_schema_cache(session, connector, actor)
@@ -3464,8 +3505,8 @@ def generate_datasource_view_sql(
     query_request = QueryRequest(
         question=(
             f"Create a SQL SELECT statement for a database view named {normalized_name}. "
-            "The SELECT must implement this datasource logic:\n"
-            f"{description.strip()}\n\n"
+            "The SELECT must implement this view description:\n"
+            f"{view_description.strip()}\n\n"
             "Return only one SELECT query. Do not create, drop, alter, insert, update or delete data."
         ),
         datasource_id=connector.connector_key,
@@ -3615,7 +3656,7 @@ def generate_datasource_view_sql_preview(
             session=session,
             connector=connector,
             view_name=request.name,
-            description=request.description,
+            view_description=request_view_description(request),
             actor=user.username,
         )
     except (
@@ -3656,7 +3697,7 @@ def execute_datasource_view_sql_endpoint(
             session=session,
             connector=connector,
             view_name=request.name,
-            description=request.description,
+            view_description=request_view_description(request),
             sql=request.sql,
             actor=user.username,
         )
@@ -3705,7 +3746,7 @@ def update_datasource_view_sql_endpoint(
             connector=connector,
             current_view_name=view_name,
             next_view_name=request.name,
-            description=request.description,
+            view_description=request_view_description(request),
             sql=request.sql,
             actor=user.username,
         )
@@ -3756,7 +3797,7 @@ def save_datasource_view_settings_endpoint(
             session=session,
             connector=connector,
             view_name=view_name,
-            description=request.description,
+            view_description=request_view_description(request),
             actor=user.username,
         )
     except (SQLAlchemyError, ValueError) as exc:

{gaard_api-0.2.12 → gaard_api-0.2.13/src/gaard_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gaard-api
-Version: 0.2.12
+Version: 0.2.13
 Summary: GAARD backend web services providing admin interface
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown

{gaard_api-0.2.12 → gaard_api-0.2.13}/tests/test_admin_api.py

@@ -3668,7 +3668,7 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         headers={"Authorization": f"Bearer {token}"},
         json={
             "name": "v_generated_active_patients",
-            "description": "Active patients count.",
+            "view_description": "Active patients count.",
         },
     )
 
@@ -3682,7 +3682,7 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         headers={"Authorization": f"Bearer {token}"},
         json={
             "name": "v_active_patients",
-            "description": "Active patient names.",
+            "view_description": "Active patient names.",
             "sql": (
                 "CREATE VIEW v_active_patients AS "
                 "SELECT id, first_name, last_name FROM patients WHERE status = 'active'"
@@ -3697,10 +3697,12 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         for table in created["raw_schema"]["tables"]
     )
     assert (
-        created["table_settings"]["tables"]["v_active_patients"]["description"]
+        created["table_settings"]["tables"]["v_active_patients"]["view_description"]
         == "Active patient names."
     )
+    assert created["table_settings"]["tables"]["v_active_patients"]["description"] == ""
     assert "View: v_active_patients" in created["formatted_schema"]
+    assert "Active patient names." not in created["formatted_schema"]
 
     definition_response = admin_client.get(
         f"/api/v1/admin/datasources/{datasource['id']}/schema/views/v_active_patients",
@@ -3710,7 +3712,8 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
     assert definition_response.status_code == 200
     definition = definition_response.json()["item"]
     assert definition["name"] == "v_active_patients"
-    assert definition["description"] == "Active patient names."
+    assert definition["view_description"] == "Active patient names."
+    assert definition["datasource_logic"] == ""
     assert definition["sql"].startswith("SELECT")
 
     duplicate_response = admin_client.post(
@@ -3718,7 +3721,7 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         headers={"Authorization": f"Bearer {token}"},
         json={
             "name": "v_active_patients",
-            "description": "Duplicate.",
+            "view_description": "Duplicate.",
             "sql": "SELECT id FROM patients",
         },
     )
@@ -3731,7 +3734,7 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         headers={"Authorization": f"Bearer {token}"},
         json={
             "name": "v_current_patients",
-            "description": "Renamed active patient view.",
+            "view_description": "Renamed active patient view.",
             "sql": "SELECT id, first_name FROM patients WHERE status = 'active'",
         },
     )
@@ -3747,23 +3750,53 @@ def test_datasource_schema_views_can_be_created_saved_and_deleted(
         for table in edited["raw_schema"]["tables"]
     )
     assert (
-        edited["table_settings"]["tables"]["v_current_patients"]["description"]
+        edited["table_settings"]["tables"]["v_current_patients"]["view_description"]
         == "Renamed active patient view."
     )
+    assert edited["table_settings"]["tables"]["v_current_patients"]["description"] == ""
 
     save_response = admin_client.put(
         f"/api/v1/admin/datasources/{datasource['id']}/schema/views/v_current_patients",
         headers={"Authorization": f"Bearer {token}"},
-        json={"description": "Updated active patient view logic."},
+        json={"view_description": "Updated active patient view definition."},
     )
 
     assert save_response.status_code == 200
     saved = save_response.json()["item"]
     assert (
-        saved["table_settings"]["tables"]["v_current_patients"]["description"]
-        == "Updated active patient view logic."
+        saved["table_settings"]["tables"]["v_current_patients"]["view_description"]
+        == "Updated active patient view definition."
     )
-    assert "Updated active patient view logic." in saved["formatted_schema"]
+    assert saved["table_settings"]["tables"]["v_current_patients"]["description"] == ""
+    assert "Updated active patient view definition." not in saved["formatted_schema"]
+
+    logic_response = admin_client.put(
+        f"/api/v1/admin/datasources/{datasource['id']}/schema/tables",
+        headers={"Authorization": f"Bearer {token}"},
+        json={
+            "tables": {
+                "v_current_patients": {
+                    "selected": True,
+                    "description": "Use this view for active patient lookup.",
+                    "view_description": "Updated active patient view definition.",
+                    "join_logic": "",
+                }
+            }
+        },
+    )
+
+    assert logic_response.status_code == 200
+    logic_saved = logic_response.json()["item"]
+    assert (
+        logic_saved["table_settings"]["tables"]["v_current_patients"]["description"]
+        == "Use this view for active patient lookup."
+    )
+    assert (
+        logic_saved["table_settings"]["tables"]["v_current_patients"]["view_description"]
+        == "Updated active patient view definition."
+    )
+    assert "Use this view for active patient lookup." in logic_saved["formatted_schema"]
+    assert "Updated active patient view definition." not in logic_saved["formatted_schema"]
 
     delete_response = admin_client.delete(
         f"/api/v1/admin/datasources/{datasource['id']}/schema/views/v_current_patients",