From 6b4e9015744ab8c9f17a6b8e23387cd676b1d827 Mon Sep 17 00:00:00 2001
From: roberto berto <rberto@deepcausa.com>
Date: Sun, 2 Nov 2025 22:54:44 +0000
Subject: feat: v0.4.0 - Architecture refactor, bug fixes, and quality
 improvements

- Fixed #25: config_file_save/load now include path: [] in payload
- Added exception hierarchy (SDKError, HttpError, ApiError, ValidationError)
- Added utility functions (json, ids, paths)
- Added structured logging with request ID tracking
- Added optional Pydantic validation models
- Refactored to pyvyos.core.* structure with backward compatibility shims
- Moved JSON specs to docs/development/vyos_api/
- Added comprehensive test suite (19 shim tests, 16 utils tests, 6 exception tests)
- Updated pyproject.toml for uv sync editable installation
- Added development documentation (architecture, roadmap, quality guidelines)

Maintains 100% backward compatibility with 0.3.0
---
 docs/development/vyos_api/config-file-save.json | 58 +++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 docs/development/vyos_api/config-file-save.json

(limited to 'docs/development/vyos_api/config-file-save.json')

diff --git a/docs/development/vyos_api/config-file-save.json b/docs/development/vyos_api/config-file-save.json
new file mode 100644
index 0000000..563e0ad
--- /dev/null
+++ b/docs/development/vyos_api/config-file-save.json
@@ -0,0 +1,58 @@
+{
+  "command": "config-file",
+  "operation": "save",
+  "description": "Save the current configuration to a file.",
+  "endpoint": "/config-file",
+  "method": "POST",
+  "request": {
+    "payload": {
+      "data": {
+        "op": "save",
+        "path": [],
+        "file": "/config/backup.config"
+      },
+      "key": "your-api-key"
+    },
+    "example": {
+      "with_file": {
+        "op": "save",
+        "path": [],
+        "file": "/config/backup.config"
+      },
+      "default_location": {
+        "op": "save",
+        "path": []
+      }
+    }
+  },
+  "response": {
+    "success": {
+      "success": true,
+      "data": "",
+      "error": null
+    },
+    "error": {
+      "success": false,
+      "data": null,
+      "error": "Failed to save configuration"
+    }
+  },
+  "parameters": {
+    "file": {
+      "type": "string",
+      "required": false,
+      "description": "Path to the file where configuration will be saved. If not provided, uses default location.",
+      "example": "/config/backup.config"
+    },
+    "path": {
+      "type": "array",
+      "required": false,
+      "description": "Path parameter (required by API, typically empty array)",
+      "default": [],
+      "example": []
+    }
+  },
+  "python_usage": "device.config_file_save(file=\"/config/backup.config\")",
+  "notes": "The path parameter is required by the VyOS API even though it's typically empty for save operations."
+}
+
-- 
cgit v1.2.3