summaryrefslogtreecommitdiff
path: root/pyvyos/specs/models.py
diff options
context:
space:
mode:
authorRoberto Bertó <463349+robertoberto@users.noreply.github.com>2025-11-02 19:55:55 -0300
committerGitHub <noreply@github.com>2025-11-02 19:55:55 -0300
commit6ca1269b138696b69c33d2db4bcf7dd03ea4caeb (patch)
tree4c0a634730df2123ff506252cbec050de006dac8 /pyvyos/specs/models.py
parent1ada32975f0bb559ec7526e0dd545700dde1cb94 (diff)
parent6b4e9015744ab8c9f17a6b8e23387cd676b1d827 (diff)
downloadpyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.tar.gz
pyvyos-6ca1269b138696b69c33d2db4bcf7dd03ea4caeb.zip
Merge pull request #27 from vyos-contrib/feat/architecture-and-quality-improvements
feat: v0.4.0 - Architecture refactor, bug fixes, and quality improvem…
Diffstat (limited to 'pyvyos/specs/models.py')
-rw-r--r--pyvyos/specs/models.py31
1 files changed, 31 insertions, 0 deletions
diff --git a/pyvyos/specs/models.py b/pyvyos/specs/models.py
new file mode 100644
index 0000000..a57ac82
--- /dev/null
+++ b/pyvyos/specs/models.py
@@ -0,0 +1,31 @@
+"""Base Pydantic models for PyVyOS API requests and responses."""
+
+from typing import Any, Dict, List, Optional, Union
+
+if False: # type checking only
+ from pydantic import BaseModel
+else:
+ try:
+ from pydantic import BaseModel, Field
+ except ImportError:
+ BaseModel = None # type: ignore
+ Field = None # type: ignore
+
+
+class ApiRequest(BaseModel):
+ """Base request model for VyOS API operations."""
+
+ op: str
+ path: Optional[Union[List[str], List[List[str]], List[Dict[str, Any]]]] = None
+
+ class Config:
+ extra = "allow" # Allow additional fields (file, url, name, etc.)
+
+
+class ApiResponse(BaseModel):
+ """Base response model for VyOS API responses."""
+
+ success: bool
+ data: Union[Dict[str, Any], List[Any], str, None]
+ error: Optional[str] = None
+