0.2.1 release

Author: commitconfirmed

.gitignore

@@ -18,4 +18,7 @@ htmlcov/
 docs/build/
 
 # JSNAC default output file
-jsnac.schema.json
+jsnac.schema.json
+
+# Release notes
+release.txt

dist/jsnac-0.2.1-py3-none-any.whl

@@ -9,7 +9,7 @@
 project = "JSNAC"
 copyright = "2024, Andrew Jones"
 author = "Andrew Jones"
-release = "0.2.0"
+release = "0.2.1"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

dist/jsnac-0.2.1.tar.gz

@@ -21,7 +21,7 @@ Take a basic Ansible host_vars YAML file for a host below:
     chassis:
         hostname: "ceos-spine1"
         model: "ceos"
-        type: "router"
+        device_type: "router"
     
     system:
         domain_name: "example.com"
@@ -46,7 +46,6 @@ You can simply write out how you would like to validate this data, and this prog
     schema:
       chassis:
         title: "Chassis"
-        type: "object"
         properties:
           hostname:
             js_kind: { name: "string" }
@@ -55,18 +54,14 @@ You can simply write out how you would like to validate this data, and this prog
           device_type:
             js_kind: { name: "choice", choices: [ "router", "switch", "firewall", "load-balancer" ] }
       system:
-        type: "object"
         properties:
           domain_name:
             js_kind: { name: "string" }
           ntp_servers:
-            type: "array"
             items:
               js_kind: { name: "ipv4" } 
       interfaces:
-        type: "array"
         items:
-          type: "object"
           properties:
             if:
               js_kind: { name: "string" }
@@ -105,7 +100,6 @@ We also have full support for writing your own titles, descriptions, js_kinds (s
           hostname [required]: hostname
           model [required]: string
           device_type [required]: choice (router, switch, firewall, load-balancer)
-        type: "object"
         properties:
           hostname:
             js_kind: { name: "hostname" }
@@ -124,14 +118,12 @@ We also have full support for writing your own titles, descriptions, js_kinds (s
           Object containing System information. Has the below properties:
           domain_name [required]: string
           ntp_servers [required]: list of ipv4 addresses
-        type: "object"
         properties:
           domain_name:
             js_kind: { name: "string" }
           ntp_servers:
             title: "NTP Servers"
             description: "List of NTP servers"
-            type: "array"
             items:
               js_kind: { name: "ipv4" } 
         required: [ "domain_name", "ntp_servers" ]
@@ -143,9 +135,7 @@ We also have full support for writing your own titles, descriptions, js_kinds (s
           desc: string
           ipv4: ipv4_cidr
           ipv6: ipv6_cidr
-        type: "array"
         items:
-          type: "object"
           properties:
             if:
               js_kind: { name: "string" }

docs/source/conf.py

@@ -81,11 +81,124 @@ The string will be validated against the below IPv6 CIDR address regex pattern.
 
     ^(([a-fA-F0-9]{1,4}|):){1,7}([a-fA-F0-9]{1,4}|:)/(32|36|40|44|48|52|56|60|64|128)$
 
+**Example**
+
+.. code-block:: yaml
+
+    system:
+      ip_address: 
+        js_kind: { name: "ipv6_cidr" }
+
+js_kind: domain
+******************
+
+This type is used to validate a string against a domain name.
+The string will be validated against the below domain name regex pattern.
+
+.. code-block:: text
+
+    ^([a-zA-Z0-9-]{1,63}\\.)+[a-zA-Z]{2,63}$
+
+**Example**
+
+.. code-block:: yaml
+
+    system:
+      domain_name: 
+        js_kind: { name: "domain" }
+
+js_kind: email
+******************
+
+This type is used to validate a string against an email address.
+The string will be validated against the below email address regex pattern.
+
+.. code-block:: text
+
+    ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$
+
+**Example**
+
+.. code-block:: yaml
+
+    system:
+      email_address: 
+        js_kind: { name: "email" }
+
+js_kind: http_url
+******************
+
+This type is used to validate a string against an HTTP URL.
+The string will be validated against the below HTTP URL regex pattern.
+
+.. code-block:: text
+
+    ^(https?://)?([\\da-z.-]+)\\.([a-z.]{2,6})([/\\w .-]*)*\\??([^#\\s]*)?(#.*)?$
+
+**Example**
+
+.. code-block:: yaml
+
+    system:
+      sftp_server: 
+        js_kind: { name: "http_url" }
+
+js_kind: uint16
+******************
+
+This type is used to validate a string against a 16-bit unsigned integer (0 to 65535).
+
+**Example**
+
+.. code-block:: yaml
+
+    bgp:
+      as_number: 
+        js_kind: { name: "uint16" }
+
+js_kind: uint32
+******************
+
+This type is used to validate a string against a 32-bit unsigned integer (0 to 4294967295).
+
+**Example**
+
+.. code-block:: yaml
+
+    bgp:
+      as_number: 
+        js_kind: { name: "uint32" }
+
+js_kind: uint64
+******************
+
+This type is used to validate a string against a 64-bit unsigned integer (0 to 18446744073709551615).
+
+**Example**
+
+.. code-block:: yaml
+
+    interface:
+      statistics: 
+        in_octets: { name: "uint64" }
+
+js_kind: mtu
+******************
+
+This type is used to validate a string against a maximum transmission unit (MTU) value (68 to 9192).
+
+**Example**
+
+.. code-block:: yaml
+
+    interface:
+      mtu: 
+        js_kind: { name: "mtu" }
 
 js_kind: mac
 ******************
 
-This type is used to validate a string against a MAC address.
+This type is used to validate a string against a MAC address (i.e ff:ff:ff:ff:ff:ff).
 The string will be validated against the below MAC address regex pattern.
 
 .. code-block:: text
@@ -100,20 +213,51 @@ The string will be validated against the below MAC address regex pattern.
       mac_address: 
         js_kind: { name: "mac" }
 
-js_kind: domain
+js_kind: mac_dot
 ******************
 
-This type is used to validate a string against a domain name.
-The string will be validated against the below domain name regex pattern.
+This type is used to validate a string against a MAC address with dot separator (i.e ffff.ffff.ffff).
+The string will be validated against the below MAC address regex pattern.
 
 .. code-block:: text
 
-    ^([a-zA-Z0-9-]{1,63}\\.)+[a-zA-Z]{2,63}$
+    ^([0-9A-Fa-f]{4}[.]){2}([0-9A-Fa-f]{4})$
 
 **Example**
 
 .. code-block:: yaml
 
     system:
-      domain_name: 
-        js_kind: { name: "domain" }
+      mac_address: 
+        js_kind: { name: "mac_dot" }
+
+js_kind: vlan
+******************
+
+This type is used to validate a string against a VLAN ID (1 to 4094).
+
+**Example**
+
+.. code-block:: yaml
+
+    interface:
+      vlan_id: 
+        js_kind: { name: "vlan" }
+
+js_kind: docker_image
+*********************
+
+This type is used to validate a string against a Docker image name.
+The string will be validated against the below Docker image name regex pattern.
+
+.. code-block:: text
+
+    ^[a-z0-9]+(?:[._-][a-z0-9]+)*$
+
+**Example**
+
+.. code-block:: yaml
+
+    system:
+      docker_image: 
+        js_kind: { name: "docker_image" }