[uniconfig] Swagger update (#95)

* [uniconfig] Update swagger models

Signed-off-by: Jakub Boguščiak <[email protected]>

* Bump version and add CHANGELOG.md entry

Signed-off-by: Jakub Boguščiak <[email protected]>

* Update patches

Signed-off-by: Jakub Boguščiak <[email protected]>

* Add check nodes connection RPC

Signed-off-by: Jakub Boguščiak <[email protected]>

* Add SNMP topology

Signed-off-by: Jakub Boguščiak <[email protected]>

* Add new patch for SNMP topology field name

Signed-off-by: Jakub Boguščiak <[email protected]>

---------

Signed-off-by: Jakub Boguščiak <[email protected]>

Author: jbogusciak

uniconfig/python/CHANGELOG.md

@@ -22,3 +22,6 @@
   1. ignore createsubscription ruff errors
   2. fix discover address spell error
   3. fix generated port constraints in discover model
+
+# 1.1.2
+- Update models based on new OpenAPI fixed in UniConfig 6.1.x

uniconfig/python/frinx_api/uniconfig/__init__.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from enum import Enum
 from typing import Optional
 
 from pydantic import BaseModel
@@ -14,6 +15,7 @@
 from .cli.unit.generic import executeandreaduntil
 from .connection.manager import changeadminstate
 from .connection.manager import checkinstallednodes
+from .connection.manager import checknodesconnection
 from .connection.manager import connectnode
 from .connection.manager import disconnectnode
 from .connection.manager import dryrunmountnode
@@ -84,6 +86,12 @@
 from .uniconfig.query import queryconfig
 
 
+class Content(Enum):
+    nonconfig = 'nonconfig'
+    config = 'config'
+    all = 'all'
+
+
 class OperationsReadJournalPostRequest(BaseModel):
     pass
     model_config = ConfigDict(
@@ -251,6 +259,13 @@ class OperationsDisconnectNodePostRequest(BaseModel):
     input: Optional[disconnectnode.Input] = None
 
 
+class OperationsCheckNodesConnectionPostRequest(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    input: Optional[checknodesconnection.Input] = None
+
+
 class OperationsChangeEncryptionStatusPostRequest(BaseModel):
     model_config = ConfigDict(
         populate_by_name=True,

uniconfig/python/frinx_api/uniconfig/cli/topology.py

@@ -6,16 +6,36 @@
 
 
 class JournalLevel(Enum):
+    """
+    Sets how much information should be stored in the journal. Command-only stores only the actual
+    commands executed on device. Extended records additional information such as: transaction
+    life-cycle, which handlers were invoked etc.
+
+    """
+
     command_only = 'command-only'
     extended = 'extended'
 
 
 class ParsingEngine(Enum):
+    """
+    Specification of the parsing engine that is used for parsing of the running-configuration
+    and lookup for target sections in the configuration using query commands.
+    * batch-parser - Running-configuration must be traversed from the beginning each time when the new
+    target section must be extracted from the configuration.
+    * tree-parser - Running-configuration is mapped into the tree structure before the first command
+    lookup. This tree can be reused in the same transaction for faster lookup process.
+    * one-line-parser - Parsing engine that uses grep function for parsing running-configuration.
+
+    """
+
     batch_parser = 'batch-parser'
     tree_parser = 'tree-parser'
     one_line_parser = 'one-line-parser'
 
 
 class TransportTypeEnumeration(Enum):
+    """ """
+
     ssh = 'ssh'
     telnet = 'telnet'

uniconfig/python/frinx_api/uniconfig/cli/unit/generic/configcoverage.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 from typing import Optional
+from typing import Union
 
 from pydantic import BaseModel
 from pydantic import ConfigDict
@@ -28,17 +29,30 @@ class ComplexOutputItem(BaseModel):
     covered: Optional[bool] = None
 
 
-class Output(BaseModel):
+class Result(BaseModel):
     model_config = ConfigDict(
         populate_by_name=True,
     )
-    simple_output: Optional[str] = Field(None, alias='simple-output')
+    complex_output: Optional[list[ComplexOutputItem]] = Field(
+        None, alias='complex-output'
+    )
     """
     Simple output contains commands marked with '+' if it is covered or '-' if not.
     """
-    complex_output: Optional[list[ComplexOutputItem]] = Field(
-        None, alias='complex-output'
+
+
+class ResultModel(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
     )
+    simple_output: Optional[str] = Field(None, alias='simple-output')
     """
     Simple output contains commands marked with '+' if it is covered or '-' if not.
     """
+
+
+class Output(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    result: Optional[Union[Result, ResultModel]] = None

uniconfig/python/frinx_api/uniconfig/connection/manager/__init__.py

@@ -6,12 +6,38 @@
 
 
 class AdminState(Enum):
+    """
+
+    * locked - When a device is administratively locked, it is not possible
+    to modify its configuration, and no changes are ever pushed
+    to the device
+    * unlocked - Device is assumed to be operational. All changes are attempted
+    to be sent southbound. This is the default when a new device is created.
+    * southbound_locked - It is possible to configure the device, but no changes are sent
+    to the device. Useful admin mode when pre provisioning devices.
+
+    """
+
     locked = 'locked'
     unlocked = 'unlocked'
     southbound_locked = 'southbound_locked'
 
 
 class ConnectionType(Enum):
+    """
+    Type of the mountpoint that is awaited:
+    a. cli - CLI mountpoint,
+    b. netconf - NETCONF mountpoint,
+    c. uniconfig-preferred-connection - Unified mounpoint (type of the southbound protocol
+       is read from database).
+    d. gnmi - gNMI mountpoint,
+    e. snmp - snmp mountpoin,
+    f. netconf-dryrun-connection - DRYRUN mountpoint
+    g. cli-dryrun-connection - DRYRUN mountpoint
+    f. gnmi-dryrun-connection - DRYRUN mountpoint
+
+    """
+
     cli = 'cli'
     netconf = 'netconf'
     uniconfig_preferred_connection = 'uniconfig-preferred-connection'
@@ -23,6 +49,16 @@ class ConnectionType(Enum):
 
 
 class MountType(Enum):
+    """
+    Type of the nodes that have been installed:
+    a. cli - nodes that are installed using CLI protocol,
+    b. netconf - nodes that are installed using NETCONF protocol,
+    c. gnmi - nodes that are installed using GNMI protocol,
+    d. uniconfig-preferred-connection - nodes that are installed in the UniConfig layer
+       (output may contain nodes mounted on CLI, NETCONF or GNMI protocol).
+
+    """
+
     cli = 'cli'
     netconf = 'netconf'
     uniconfig_preferred_connection = 'uniconfig-preferred-connection'

uniconfig/python/frinx_api/uniconfig/connection/manager/checkinstallednodes.py

@@ -32,11 +32,11 @@ class NodeResultItem(BaseModel):
         populate_by_name=True,
     )
     node_id: Optional[str] = Field(None, alias='node-id')
-    topology_id: Optional[str] = Field(None, alias='topology-id')
     uniconfig_layer: Optional[bool] = Field(None, alias='uniconfig-layer')
     """
     Indicates whether node is installed in UniConfig layer.
     """
+    topology_id: Optional[str] = Field(None, alias='topology-id')
 
 
 class NodeResults(BaseModel):

uniconfig/python/frinx_api/uniconfig/connection/manager/checknodesconnection.py

@@ -0,0 +1,33 @@
+# generated by datamodel-codegen
+
+from __future__ import annotations
+
+from typing import Optional
+
+from pydantic import BaseModel
+from pydantic import ConfigDict
+from pydantic import Field
+
+
+class TargetNodes(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    node: Optional[list[str]] = None
+
+
+class Input(BaseModel):
+    model_config = ConfigDict(
+        populate_by_name=True,
+    )
+    connection_timeout: Optional[int] = Field(
+        None, alias='connection-timeout', ge=0, le=65535
+    )
+    """
+    Timeout for each health-check session to be established individually. Default 5 seconds.
+    """
+    target_nodes: Optional[TargetNodes] = Field(
+        None,
+        alias='target-nodes',
+        title='uniconfig.manager.targetuniconfignodesfields.TargetNodes',
+    )

uniconfig/python/frinx_api/uniconfig/connection/manager/getinstallednodes.py

@@ -16,11 +16,11 @@ class NodeResultItem(BaseModel):
         populate_by_name=True,
     )
     node_id: Optional[str] = Field(None, alias='node-id')
-    topology_id: Optional[str] = Field(None, alias='topology-id')
     uniconfig_layer: Optional[bool] = Field(None, alias='uniconfig-layer')
     """
     Indicates whether node is installed in UniConfig layer.
     """
+    topology_id: Optional[str] = Field(None, alias='topology-id')
 
 
 class NodeResults(BaseModel):