feat: Work on docs and disable ban ts comment in case of generated lib

Author: batleforc

.vscode/settings.json

@@ -101,5 +101,6 @@
   "[helm]": {
     "editor.tabSize": 2,
     "editor.defaultFormatter": "tim-koehler.helm-intellisense"
-  }
+  },
+  "sarif-viewer.connectToGithubCodeScanning": "on"
 }

eslint.config.mjs

@@ -39,4 +39,10 @@ export default [
     // Override or add rules here
     rules: {},
   },
+  {
+    files: ['libs/front/front-api/**/*.ts'],
+    rules: {
+      '@typescript-eslint/ban-ts-comment': 0,
+    },
+  },
 ];

libs/cli/client_api/docs/ProxyClustersApi.md

@@ -26,7 +26,7 @@ Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **ns** | **String** | Namespace | [required] |
 **cluster** | **String** | Cluster name | [required] |
-**path** | **String** | Path to resource | [required] |
+**path** | **String** | Corresponding path to resource given to the kube api server | [required] |
 
 ### Return type
 
@@ -58,7 +58,7 @@ Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **ns** | **String** | Namespace | [required] |
 **cluster** | **String** | Cluster name | [required] |
-**path** | **String** | Path to resource | [required] |
+**path** | **String** | Corresponding path to resource given to the kube api server | [required] |
 
 ### Return type
 
@@ -90,7 +90,7 @@ Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **ns** | **String** | Namespace | [required] |
 **cluster** | **String** | Cluster name | [required] |
-**path** | **String** | Path to resource | [required] |
+**path** | **String** | Corresponding path to resource given to the kube api server | [required] |
 
 ### Return type
 
@@ -122,7 +122,7 @@ Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **ns** | **String** | Namespace | [required] |
 **cluster** | **String** | Cluster name | [required] |
-**path** | **String** | Path to resource | [required] |
+**path** | **String** | Corresponding path to resource given to the kube api server | [required] |
 
 ### Return type
 
@@ -154,7 +154,7 @@ Name | Type | Description  | Required | Notes
 ------------- | ------------- | ------------- | ------------- | -------------
 **ns** | **String** | Namespace | [required] |
 **cluster** | **String** | Cluster name | [required] |
-**path** | **String** | Path to resource | [required] |
+**path** | **String** | Corresponding path to resource given to the kube api server | [required] |
 
 ### Return type
 

libs/cli/client_api/src/models/visible_cluster.rs

@@ -11,7 +11,7 @@
 use crate::models;
 use serde::{Deserialize, Serialize};
 
-/// VisibleCluster : Model representing a cluster visible to the user
+/// VisibleCluster : Model representing a cluster visible to the user.
 #[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
 pub struct VisibleCluster {
     #[serde(rename = "enabled")]
@@ -32,7 +32,7 @@ pub struct VisibleCluster {
 }
 
 impl VisibleCluster {
-    /// Model representing a cluster visible to the user
+    /// Model representing a cluster visible to the user.
     pub fn new(
         enabled: bool,
         name: String,

libs/front/front-api/src/lib/types.gen.ts

@@ -5,7 +5,7 @@ export type ClientOptions = {
 };
 
 /**
- * Model representing a cluster visible to the user
+ * Model representing a cluster visible to the user.
  */
 export type VisibleCluster = {
     enabled: boolean;

libs/server/api/src/api/get_all_visible_cluster_model.rs

@@ -2,7 +2,7 @@ use crd::ProxyKubeApi;
 use serde::{Deserialize, Serialize};
 use utoipa::ToSchema;
 
-/// Model representing a cluster visible to the user
+/// Model representing a cluster visible to the user.
 #[derive(Serialize, Deserialize, Debug, Clone, ToSchema)]
 pub struct VisibleCluster {
     pub enabled: bool,

libs/server/api/src/api_doc.rs

@@ -36,10 +36,10 @@ impl Modify for SecurityAddons {
         ),
       ),
     tags(
-            (name = "health", description = "Health check endpoints."),
             (name = "api_clusters", description = "API endpoints used by the front."),
-            (name = "proxy_clusters", description = "Proxy cluster endpoints."),
             (name = "auth_clusters", description = "Authentication endpoints for clusters."),
+            (name = "health", description = "Health check endpoints."),
+            (name = "proxy_clusters", description = "Proxy cluster endpoints."),
         ),
     modifiers(&SecurityAddons)
 )]

libs/server/api/src/cluster/redirect/mod.rs

@@ -20,7 +20,7 @@ pub mod kube_redirect;
     params(
         ("ns" = String, description = "Namespace"),
         ("cluster" = String, description = "Cluster name"),
-        ("path" = String, description = "Path to resource")
+        ("path" = String, description = "Corresponding path to resource given to the kube api server")
     )
 )]
 #[get("/{ns}/{cluster}/{path:.*}")]
@@ -48,7 +48,7 @@ pub async fn get_redirect(
     params(
         ("ns" = String, description = "Namespace"),
         ("cluster" = String, description = "Cluster name"),
-        ("path" = String, description = "Path to resource")
+        ("path" = String, description = "Corresponding path to resource given to the kube api server")
     )
 )]
 #[post("/{ns}/{cluster}/{path:.*}")]
@@ -76,7 +76,7 @@ pub async fn post_redirect(
     params(
         ("ns" = String, description = "Namespace"),
         ("cluster" = String, description = "Cluster name"),
-        ("path" = String, description = "Path to resource")
+        ("path" = String, description = "Corresponding path to resource given to the kube api server")
     )
 )]
 #[put("/{ns}/{cluster}/{path:.*}")]
@@ -104,7 +104,7 @@ pub async fn put_redirect(
     params(
         ("ns" = String, description = "Namespace"),
         ("cluster" = String, description = "Cluster name"),
-        ("path" = String, description = "Path to resource")
+        ("path" = String, description = "Corresponding path to resource given to the kube api server")
     )
 )]
 #[patch("/{ns}/{cluster}/{path:.*}")]
@@ -132,7 +132,7 @@ pub async fn patch_redirect(
     params(
         ("ns" = String, description = "Namespace"),
         ("cluster" = String, description = "Cluster name"),
-        ("path" = String, description = "Path to resource")
+        ("path" = String, description = "Corresponding path to resource given to the kube api server")
     )
 )]
 #[delete("/{ns}/{cluster}/{path:.*}")]

swagger.json

@@ -245,7 +245,7 @@
           {
             "name": "path",
             "in": "path",
-            "description": "Path to resource",
+            "description": "Corresponding path to resource given to the kube api server",
             "required": true,
             "schema": {
               "type": "string"
@@ -293,7 +293,7 @@
           {
             "name": "path",
             "in": "path",
-            "description": "Path to resource",
+            "description": "Corresponding path to resource given to the kube api server",
             "required": true,
             "schema": {
               "type": "string"
@@ -341,7 +341,7 @@
           {
             "name": "path",
             "in": "path",
-            "description": "Path to resource",
+            "description": "Corresponding path to resource given to the kube api server",
             "required": true,
             "schema": {
               "type": "string"
@@ -389,7 +389,7 @@
           {
             "name": "path",
             "in": "path",
-            "description": "Path to resource",
+            "description": "Corresponding path to resource given to the kube api server",
             "required": true,
             "schema": {
               "type": "string"
@@ -437,7 +437,7 @@
           {
             "name": "path",
             "in": "path",
-            "description": "Path to resource",
+            "description": "Corresponding path to resource given to the kube api server",
             "required": true,
             "schema": {
               "type": "string"
@@ -521,7 +521,7 @@
       },
       "VisibleCluster": {
         "type": "object",
-        "description": "Model representing a cluster visible to the user",
+        "description": "Model representing a cluster visible to the user.",
         "required": [
           "enabled",
           "namespace",
@@ -559,21 +559,21 @@
     }
   },
   "tags": [
-    {
-      "name": "health",
-      "description": "Health check endpoints."
-    },
     {
       "name": "api_clusters",
       "description": "API endpoints used by the front."
     },
-    {
-      "name": "proxy_clusters",
-      "description": "Proxy cluster endpoints."
-    },
     {
       "name": "auth_clusters",
       "description": "Authentication endpoints for clusters."
+    },
+    {
+      "name": "health",
+      "description": "Health check endpoints."
+    },
+    {
+      "name": "proxy_clusters",
+      "description": "Proxy cluster endpoints."
     }
   ]
 }