Patch swagger missing apis (#21)

Co-authored-by: Jozef Volak <[email protected]>

Author: Jozefiel

README.md

@@ -39,10 +39,10 @@ However, here are some straightforward examples of usage with Poetry.
 
 ```bash
 # inventory package, example with branch usage
-poetry add git+ssh://[email protected]/FRINXio/frinx-services-python-api.git.git@main#subdirectory=inventory/python
+poetry add git+ssh://[email protected]/FRINXio/frinx-services-python-api.git@main#subdirectory=inventory/python
 
 # inventory package, example with tag usage
-poetry add git+ssh://[email protected]/FRINXio/frinx-services-python-api.git.git@v2.0.0#subdirectory=inventory/python
+poetry add git+ssh://[email protected]/FRINXio/[email protected]#subdirectory=inventory/python
 ```
 
 ## Usage

uniconfig/python/frinx_api/uniconfig/rest_api.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from pydantic import BaseModel
+from typing import Any
 
 from . import OperationsAddKeystoreEntryPostRequest
 from . import OperationsAddPrivateKeyPostRequest
@@ -126,40 +126,40 @@
 class UniconfigRest:
     uri: str
     method: str
-    request: BaseModel | None
-    response: BaseModel | None
+    request: Any | None
+    response: Any | None
 
 
 class ConfigCoverage(UniconfigRest):
-    uri = '/operations/network-topology/topology={topology-id}/node={node-id}/yang-ext:mount/config-coverage'
+    uri = '/operations/network-topology/topology={topology_id}/node={node_id}/yang-ext:mount/config-coverage'
     method = 'POST'
     request = None
     response = None
 
 
 class Execute(UniconfigRest):
-    uri = '/operations/network-topology/topology={topology-id}/node={node-id}/yang-ext:mount/execute'
+    uri = '/operations/network-topology/topology={topology_id}/node={node_id}/yang-ext:mount/execute'
     method = 'POST'
     request = None
     response = None
 
 
 class ExecuteAndExpect(UniconfigRest):
-    uri = '/operations/network-topology/topology={topology-id}/node={node-id}/yang-ext:mount/execute-and-expect'
+    uri = '/operations/network-topology/topology={topology_id}/node={node_id}/yang-ext:mount/execute-and-expect'
     method = 'POST'
     request = None
     response = None
 
 
 class ExecuteAndRead(UniconfigRest):
-    uri = '/operations/network-topology/topology={topology-id}/node={node-id}/yang-ext:mount/execute-and-read'
+    uri = '/operations/network-topology/topology={topology_id}/node={node_id}/yang-ext:mount/execute-and-read'
     method = 'POST'
     request = None
     response = None
 
 
 class ExecuteAndReadUntil(UniconfigRest):
-    uri = '/operations/network-topology/topology={topology-id}/node={node-id}/yang-ext:mount/execute-and-read-until'
+    uri = '/operations/network-topology/topology={topology_id}/node={node_id}/yang-ext:mount/execute-and-read-until'
     method = 'POST'
     request = None
     response = None
@@ -621,7 +621,7 @@ class TransactionMetadata(UniconfigRest):
 
 
 class TransactionMetadataTransactionId(UniconfigRest):
-    uri = '/data/transactions-metadata/transaction-metadata={transaction-id}'
+    uri = '/data/transactions-metadata/transaction-metadata={transaction_id}'
     method = 'GET'
     request = None
     response = None
@@ -730,3 +730,18 @@ class QueryConfig(UniconfigRest):
     method = 'POST'
     request = OperationsQueryConfigPostRequest
     response = OperationsQueryConfigPostResponse
+
+
+class ReadStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'GET'
+
+
+class WriteStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'PUT'
+
+
+class DeleteStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'DELETE'

uniconfig/python/generate.sh

@@ -1,5 +1,7 @@
 #!/usr/bin/env bash
 
+REST_API_PATH='frinx_api/uniconfig/rest_api.py'
+
 # remove obsolete files, because are not cleaned during generations
 API_PATH='frinx_api/uniconfig/'
 
@@ -27,9 +29,12 @@ poetry run datamodel-codegen \
   --custom-file-header "# generated by datamodel-codegen"
 
 # generate rest_api file to map URL, Method and models from datamodel-codegen
-poetry run python3 ./generate_rest_api.py --input /swagger/uniconfig.yaml --output frinx_api/uniconfig/rest_api.py
+poetry run python3 ./generate_rest_api.py --input /swagger/uniconfig.yaml --output ${REST_API_PATH}
+
+# apply patches
+cat ./patches/rest_api.txt >> ${REST_API_PATH}
 
 ## use default formatting
 poetry run ruff --fix . || true
 
-chown -R "${uid}:${gid}" frinx_api/uniconfig/*
+chown -R "${uid}:${gid}" frinx_api/uniconfig/*

uniconfig/python/generate_rest_api.py

@@ -63,6 +63,15 @@ def _up_format(s: str, delimiters: list[str]) -> str:
             s = s.replace(x, SPACE)
         return NAN.join([x.capitalize() for x in s.split(SPACE)])
 
+    def _variable_query_to_snake_case(url: str) -> str:
+        pattern = r'{([^{}]+)}'
+        matches = re.findall(pattern, url)
+        modified_string = url
+        for match in matches:
+            modified_match = match.replace('-', '_')
+            modified_string = modified_string.replace(f'{{{match}}}', f'{{{modified_match}}}')
+        return modified_string
+
     def _get_cls(_endpoint: str, _method: str, *, request: bool = False, response: bool = False) -> str:
         base = _up_format(endpoint, ['/', '-']).split('=')[0] + method.capitalize()
         return str(base + {request: 'Request', response: 'Response'}.get(True))
@@ -91,7 +100,9 @@ def _get_service_name(_endpoint: str) -> str:
             else:
                 template_input['Cls'] = _get_service_name(endpoint)
 
-            template_input['uri'] = endpoint
+            modified_endpoint = _variable_query_to_snake_case(endpoint)
+
+            template_input['uri'] = modified_endpoint
             template_input['method'] = method.upper()
 
             req_ref = _get_cls(endpoint, method, request=True)

uniconfig/python/patches/rest_api_patch.txt

@@ -0,0 +1,15 @@
+
+
+class ReadStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'GET'
+
+
+class WriteStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'PUT'
+
+
+class DeleteStructuredData(UniconfigRest):
+    uri = '/data/network-topology:network-topology/topology={topology_id}/node={node_id}/frinx-uniconfig-topology:configuration{uri}'
+    method = 'DELETE'