chore: better man to markdown and missing openapi schema

bin/nanocld/specs/swagger.yaml

@@ -4444,6 +4444,36 @@ components:
           minimum: 0
         Spec:
           $ref: '#/components/schemas/Job'
+    LimitReq:
+      type: object
+      required:
+      - Burst
+      properties:
+        Burst:
+          type: integer
+          description: The burst size
+          minimum: 0
+        Delay:
+          type: integer
+          description: The delay to wait before retrying
+          nullable: true
+          minimum: 0
+      additionalProperties: false
+    LimitReqZone:
+      type: object
+      required:
+      - Size
+      - Rate
+      properties:
+        Size:
+          type: integer
+          description: The max size of the cache in megabytes
+          minimum: 0
+        Rate:
+          type: integer
+          description: The max number of request per second
+          minimum: 0
+      additionalProperties: false
     LocalNodeState:
       type: string
       description: |-
@@ -5448,7 +5478,8 @@ components:
           format: date-time
           description: The created at date
         IpAddress:
-          $ref: '#/components/schemas/ipnet.IpNet'
+          type: string
+          description: The ip address of the node
         Endpoint:
           type: string
           description: Endpoint to connect to the node

bin/nanocld/src/services/openapi.rs

@@ -74,7 +74,7 @@ use nanocl_stubs::proxy::{
   ResourceProxyRule, ProxyRuleHttp, ProxyHttpLocation, ProxySsl,
   ProxyRuleStream, StreamTarget, ProxyStreamProtocol, UriTarget,
   LocationTarget, HttpTarget, UrlRedirect, UpstreamTarget, ProxyRule,
-  UnixTarget, ProxySslConfig,
+  UnixTarget, ProxySslConfig, LimitReq, LimitReqZone,
 };
 use nanocl_stubs::statefile::{
   Statefile, StatefileArg, StatefileArgKind, SubState, SubStateDef,
@@ -495,6 +495,8 @@ impl Modify for VersionModifier {
     UpstreamTarget,
     UnixTarget,
     UriTarget,
+    LimitReq,
+    LimitReqZone,
     // DnsRules
     ResourceDnsRule,
     DnsEntry,

crates/nanocl_stubs/src/node.rs

@@ -12,6 +12,7 @@ pub struct Node {
   /// The created at date
   pub created_at: chrono::NaiveDateTime,
   /// The ip address of the node
+  #[cfg_attr(feature = "utoipa", schema(value_type = String))]
   pub ip_address: ipnet::IpNet,
   /// Endpoint to connect to the node
   pub endpoint: String,

doc/man/nanocl-backup.md

@@ -1,26 +1,26 @@
-# NAME
+---
+title: Backup
+sidebar_position: 2
+---
 
-backup - Backup the current state
+# Backup
 
-# SYNOPSIS
+## SYNOPSIS
 
-**backup** \[**-o**\|**\--output-dir**\] \[**-y**\|**\--yes**\]
-\[**-h**\|**\--help**\]
+**backup** \[**-o**\|**--output-dir**\] \[**-y**\|**--yes**\]
+\[**-h**\|**--help**\]
 
-# DESCRIPTION
+## DESCRIPTION
 
 Backup the current state
 
-# OPTIONS
+## OPTIONS
 
-**-o**, **\--output-dir**=*OUTPUT_DIR*
+**-o**, **--output-dir**=*OUTPUT_DIR*  
+Directory where to write the backup default to the current directory
 
-:   Directory where to write the backup default to the current directory
+**-y**, **--yes**  
+Skip confirmation
 
-**-y**, **\--yes**
-
-:   Skip confirmation
-
-**-h**, **\--help**
-
-:   Print help
+**-h**, **--help**  
+Print help

doc/man/nanocl-cargo-create.md

@@ -1,34 +1,32 @@
-# NAME
+---
+title: Cargo create
+sidebar_position: 4
+---
 
-create - Create a new cargo
+# Cargo create
 
-# SYNOPSIS
+## SYNOPSIS
 
-**create** \[**-v**\|**\--volume**\] \[**-e**\|**\--env**\]
-\[**-h**\|**\--help**\] \<*NAME*\> \<*IMAGE*\>
+**create** \[**-v**\|**--volume**\] \[**-e**\|**--env**\]
+\[**-h**\|**--help**\] \<*NAME*\> \<*IMAGE*\>
 
-# DESCRIPTION
+## DESCRIPTION
 
 Create a new cargo
 
-# OPTIONS
+## OPTIONS
 
-**-v**, **\--volume**=*VOLUMES*
+**-v**, **--volume**=*VOLUMES*  
+Volumes of the cargo
 
-:   Volumes of the cargo
+**-e**, **--env**=*ENV*  
+Environment variables of the cargo
 
-**-e**, **\--env**=*ENV*
+**-h**, **--help**  
+Print help
 
-:   Environment variables of the cargo
+\<*NAME*\>  
+Name of the cargo
 
-**-h**, **\--help**
-
-:   Print help
-
-\<*NAME*\>
-
-:   Name of the cargo
-
-\<*IMAGE*\>
-
-:   Image of the cargo
+\<*IMAGE*\>  
+Image of the cargo

doc/man/nanocl-cargo-exec.md

@@ -1,51 +1,45 @@
-# NAME
+---
+title: Cargo exec
+sidebar_position: 5
+---
 
-exec - Execute a command inside a cargo
+# Cargo exec
 
-# SYNOPSIS
+## SYNOPSIS
 
-**exec** \[**-t**\|**\--tty**\] \[**\--detach-keys**\] \[**-e **\]
-\[**\--privileged**\] \[**-u **\] \[**-w**\|**\--workdir**\]
-\[**-h**\|**\--help**\] \<*NAME*\> \[*COMMAND*\]
+**exec** \[**-t**\|**--tty**\] \[**--detach-keys**\] \[**-e **\]
+\[**--privileged**\] \[**-u **\] \[**-w**\|**--workdir**\]
+\[**-h**\|**--help**\] \<*NAME*\> \[*COMMAND*\]
 
-# DESCRIPTION
+## DESCRIPTION
 
 Execute a command inside a cargo
 
-# OPTIONS
+## OPTIONS
 
-**-t**, **\--tty**
+**-t**, **--tty**  
+Allocate a pseudo-TTY
 
-:   Allocate a pseudo-TTY
+**--detach-keys**=*DETACH_KEYS*  
+Override the key sequence for detaching a container
 
-**\--detach-keys**=*DETACH_KEYS*
+**-e**=*ENV*  
+Set environment variables
 
-:   Override the key sequence for detaching a container
+**--privileged**  
+Give extended privileges to the command
 
-**-e**=*ENV*
+**-u**=*USER*  
+Username or UID (format: "\<name\|uid\>\[:\<group\|gid\>\]")
 
-:   Set environment variables
+**-w**, **--workdir**=*WORKING_DIR*  
+Working directory inside the container
 
-**\--privileged**
+**-h**, **--help**  
+Print help
 
-:   Give extended privileges to the command
+\<*NAME*\>  
+Name of cargo to execute command
 
-**-u**=*USER*
-
-:   Username or UID (format: \"\<name\|uid\>\[:\<group\|gid\>\]\")
-
-**-w**, **\--workdir**=*WORKING_DIR*
-
-:   Working directory inside the container
-
-**-h**, **\--help**
-
-:   Print help
-
-\<*NAME*\>
-
-:   Name of cargo to execute command
-
-\[*COMMAND*\]
-
-:   Command to execute
+\[*COMMAND*\]  
+Command to execute

doc/man/nanocl-cargo-history.md

@@ -1,21 +1,22 @@
-# NAME
+---
+title: Cargo history
+sidebar_position: 6
+---
 
-history - List cargo history
+# Cargo history
 
-# SYNOPSIS
+## SYNOPSIS
 
-**history** \[**-h**\|**\--help**\] \<*NAME*\>
+**history** \[**-h**\|**--help**\] \<*NAME*\>
 
-# DESCRIPTION
+## DESCRIPTION
 
 List cargo history
 
-# OPTIONS
+## OPTIONS
 
-**-h**, **\--help**
+**-h**, **--help**  
+Print help
 
-:   Print help
-
-\<*NAME*\>
-
-:   Name of cargo to browse history
+\<*NAME*\>  
+Name of cargo to browse history

doc/man/nanocl-cargo-inspect.md

@@ -1,28 +1,28 @@
-# NAME
+---
+title: Cargo inspect
+sidebar_position: 7
+---
 
-inspect - Inspect a cargo by its name
+# Cargo inspect
 
-# SYNOPSIS
+## SYNOPSIS
 
-**inspect** \[**\--display**\] \[**-h**\|**\--help**\] \<*KEY*\>
+**inspect** \[**--display**\] \[**-h**\|**--help**\] \<*KEY*\>
 
-# DESCRIPTION
+## DESCRIPTION
 
 Inspect a cargo by its name
 
-# OPTIONS
+## OPTIONS
 
-**\--display**=*DISPLAY*
+**--display**=*DISPLAY*  
+Display format  
 
-:   Display format\
-
-\
+
 \[*possible values: *yaml, toml, json\]
 
-**-h**, **\--help**
-
-:   Print help
-
-\<*KEY*\>
+**-h**, **--help**  
+Print help
 
-:   Key or Name of the object to inspect
+\<*KEY*\>  
+Key or Name of the object to inspect

doc/man/nanocl-cargo-list.md

@@ -1,34 +1,32 @@
-# NAME
+---
+title: Cargo list
+sidebar_position: 8
+---
 
-list - List existing cargo
+# Cargo list
 
-# SYNOPSIS
+## SYNOPSIS
 
-**list** \[**-q**\|**\--quiet**\] \[**-l**\|**\--limit**\]
-\[**-o**\|**\--offset**\] \[**\--filters**\] \[**-h**\|**\--help**\]
+**list** \[**-q**\|**--quiet**\] \[**-l**\|**--limit**\]
+\[**-o**\|**--offset**\] \[**--filters**\] \[**-h**\|**--help**\]
 
-# DESCRIPTION
+## DESCRIPTION
 
 List existing cargo
 
-# OPTIONS
+## OPTIONS
 
-**-q**, **\--quiet**
+**-q**, **--quiet**  
+Only show keys
 
-:   Only show keys
+**-l**, **--limit**=*LIMIT*  
+Limit the number of results default to 100
 
-**-l**, **\--limit**=*LIMIT*
+**-o**, **--offset**=*OFFSET*  
+Offset the results to navigate through the results
 
-:   Limit the number of results default to 100
+**--filters**=*FILTERS*  
+Filters
 
-**-o**, **\--offset**=*OFFSET*
-
-:   Offset the results to navigate through the results
-
-**\--filters**=*FILTERS*
-
-:   Filters
-
-**-h**, **\--help**
-
-:   Print help
+**-h**, **--help**  
+Print help