Merge branch 'main' into release-2.5

deepfence · Nov 21, 2024 · b4724a9 · b4724a9
2 parents 186cdb7 + 695d1e4
commit b4724a9
Show file tree

Hide file tree

Showing 19 changed files with 91 additions and 57 deletions.
diff --git a/docs/docs/developers/api-reference.md b/docs/docs/developers/api-reference.md
@@ -0,0 +1,11 @@
+---
+title: REST API Reference
+---
+
+# REST API Reference
+
+To access the interactive API documentation, enter the following URL in your web browser
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
diff --git a/docs/docs/developers/index.md b/docs/docs/developers/index.md
@@ -1,18 +1,13 @@
 ---
-title: ThreatMapper Architecture
+title: Developer Resources
 ---
 
-# ThreatMapper Architecture
-
-:::info
-
-Help needed to provide architectural information for developers
-
-:::
+# Developer Resources
 
 Resources:
  * [How to build Deepfence ThreatMapper](build)
- * [How To Use Python Sdk](https://github.com/deepfence/threatmapper-python-client/blob/main/README.md)
+ * [REST API Reference](api-reference)
+ * [How To Use Python Sdk](python-sdk)
 
 ```mdx-code-block
 import DocCardList from '@theme/DocCardList';

diff --git a/docs/docs/developers/python-sdk.md b/docs/docs/developers/python-sdk.md
@@ -2,7 +2,7 @@
 title: How to Use Python Sdk
 ---
 
-# threatmapper
+# ThreatMapper Python SDK
 A client library for accessing Deepfence ThreatMapper
 
 ## How to Install

diff --git a/docs/docs/tips/automating-scans.md b/docs/docs/tips/automating-scans.md
@@ -19,8 +19,10 @@ The results of automated scans are added to the **Vulnerability Scans** report,
 
 ThreatMapper presents a series of APIs that you can use to enumerate nodes and run scans:
 
-* [https://deepfence.github.io/deepfence_runtime_api/](https://deepfence.github.io/deepfence_runtime_api/)
-
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
 
 ### Scanning Workloads before Deployment
 

diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -170,6 +170,7 @@ const sidebars = {
         'developers/build',
         'developers/deploy-console',
         'developers/deploy-agent',
+        'developers/api-reference',
         'developers/python-sdk',
       ],
     },

diff --git a/docs/versioned_docs/version-v2.2/developers/api-reference.md b/docs/versioned_docs/version-v2.2/developers/api-reference.md
@@ -0,0 +1,11 @@
+---
+title: REST API Reference
+---
+
+# REST API Reference
+
+To access the interactive API documentation, enter the following URL in your web browser
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
diff --git a/docs/versioned_docs/version-v2.2/developers/index.md b/docs/versioned_docs/version-v2.2/developers/index.md
@@ -1,18 +1,13 @@
 ---
-title: ThreatMapper Architecture
+title: Developer Resources
 ---
 
-# ThreatMapper Architecture
-
-:::info
-
-Help needed to provide architectural information for developers
-
-:::
+# Developer Resources
 
 Resources:
  * [How to build Deepfence ThreatMapper](build)
- * [How To Use Python Sdk](https://github.com/deepfence/threatmapper-python-client/blob/main/README.md)
+ * [REST API Reference](api-reference)
+ * [How To Use Python Sdk](python-sdk)
 
 ```mdx-code-block
 import DocCardList from '@theme/DocCardList';

diff --git a/docs/versioned_docs/version-v2.3/developers/api-reference.md b/docs/versioned_docs/version-v2.3/developers/api-reference.md
@@ -0,0 +1,11 @@
+---
+title: REST API Reference
+---
+
+# REST API Reference
+
+To access the interactive API documentation, enter the following URL in your web browser
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
diff --git a/docs/versioned_docs/version-v2.3/developers/index.md b/docs/versioned_docs/version-v2.3/developers/index.md
@@ -1,18 +1,13 @@
 ---
-title: ThreatMapper Architecture
+title: Developer Resources
 ---
 
-# ThreatMapper Architecture
-
-:::info
-
-Help needed to provide architectural information for developers
-
-:::
+# Developer Resources
 
 Resources:
  * [How to build Deepfence ThreatMapper](build)
- * [How To Use Python Sdk](https://github.com/deepfence/threatmapper-python-client/blob/main/README.md)
+ * [REST API Reference](api-reference)
+ * [How To Use Python Sdk](python-sdk)
 
 ```mdx-code-block
 import DocCardList from '@theme/DocCardList';

diff --git a/docs/versioned_docs/version-v2.3/developers/python-sdk.md b/docs/versioned_docs/version-v2.3/developers/python-sdk.md
@@ -2,7 +2,7 @@
 title: How to Use Python Sdk
 ---
 
-# threatmapper
+# ThreatMapper Python SDK
 A client library for accessing Deepfence ThreatMapper
 
 ## How to Install

diff --git a/docs/versioned_docs/version-v2.3/tips/automating-scans.md b/docs/versioned_docs/version-v2.3/tips/automating-scans.md
@@ -19,8 +19,10 @@ The results of automated scans are added to the **Vulnerability Scans** report,
 
 ThreatMapper presents a series of APIs that you can use to enumerate nodes and run scans:
 
-* [https://deepfence.github.io/deepfence_runtime_api/](https://deepfence.github.io/deepfence_runtime_api/)
-
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
 
 ### Scanning Workloads before Deployment
 

diff --git a/docs/versioned_docs/version-v2.4/developers/api-reference.md b/docs/versioned_docs/version-v2.4/developers/api-reference.md
@@ -0,0 +1,11 @@
+---
+title: REST API Reference
+---
+
+# REST API Reference
+
+To access the interactive API documentation, enter the following URL in your web browser
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
diff --git a/docs/versioned_docs/version-v2.4/developers/index.md b/docs/versioned_docs/version-v2.4/developers/index.md
@@ -1,18 +1,13 @@
 ---
-title: ThreatMapper Architecture
+title: Developer Resources
 ---
 
-# ThreatMapper Architecture
-
-:::info
-
-Help needed to provide architectural information for developers
-
-:::
+# Developer Resources
 
 Resources:
  * [How to build Deepfence ThreatMapper](build)
- * [How To Use Python Sdk](https://github.com/deepfence/threatmapper-python-client/blob/main/README.md)
+ * [REST API Reference](api-reference)
+ * [How To Use Python Sdk](python-sdk)
 
 ```mdx-code-block
 import DocCardList from '@theme/DocCardList';

diff --git a/docs/versioned_docs/version-v2.4/developers/python-sdk.md b/docs/versioned_docs/version-v2.4/developers/python-sdk.md
@@ -2,7 +2,7 @@
 title: How to Use Python Sdk
 ---
 
-# threatmapper
+# ThreatMapper Python SDK
 A client library for accessing Deepfence ThreatMapper
 
 ## How to Install

diff --git a/docs/versioned_docs/version-v2.4/tips/automating-scans.md b/docs/versioned_docs/version-v2.4/tips/automating-scans.md
@@ -19,8 +19,10 @@ The results of automated scans are added to the **Vulnerability Scans** report,
 
 ThreatMapper presents a series of APIs that you can use to enumerate nodes and run scans:
 
-* [https://deepfence.github.io/deepfence_runtime_api/](https://deepfence.github.io/deepfence_runtime_api/)
-
+```
+https://<CONSOLE_URL>/deepfence/swagger-ui/
+https://<CONSOLE_URL>/deepfence/openapi.json
+```
 
 ### Scanning Workloads before Deployment
 

diff --git a/docs/versioned_sidebars/version-v2.2-sidebars.json b/docs/versioned_sidebars/version-v2.2-sidebars.json
@@ -147,6 +147,7 @@
         "developers/build",
         "developers/deploy-console",
         "developers/deploy-agent",
+        "developers/api-reference",
         "developers/python-sdk"
       ]
     },

diff --git a/docs/versioned_sidebars/version-v2.3-sidebars.json b/docs/versioned_sidebars/version-v2.3-sidebars.json
@@ -147,6 +147,7 @@
         "developers/build",
         "developers/deploy-console",
         "developers/deploy-agent",
+        "developers/api-reference",
         "developers/python-sdk"
       ]
     },

diff --git a/docs/versioned_sidebars/version-v2.4-sidebars.json b/docs/versioned_sidebars/version-v2.4-sidebars.json
@@ -147,6 +147,7 @@
         "developers/build",
         "developers/deploy-console",
         "developers/deploy-agent",
+        "developers/api-reference",
         "developers/python-sdk"
       ]
     },

diff --git a/docs/vulnerability_feeds/listing.json b/docs/vulnerability_feeds/listing.json
@@ -28,28 +28,28 @@
     ],
     "5": [
       {
-        "built": "2024-11-13T13:10:58.260261244Z",
+        "built": "2024-11-20T01:33:52.440183664Z",
         "version": 5,
-        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-13_13-07-13/threatintel-vuln-v5-2024-11-13_13-07-13.tar.gz",
-        "checksum": "d581d31e0c0c35591f96bf83787be2e15d8c68776144a1e86166df1f1087f6ff"
+        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-20_01-30-09/threatintel-vuln-v5-2024-11-20_01-30-09.tar.gz",
+        "checksum": "eb08ff334929aaa62e42474ac44df3f6a296d8f1d6fd5861c4c34775b7ba608c"
       },
       {
-        "built": "2024-11-14T01:33:25.903558371Z",
+        "built": "2024-11-20T13:12:15.751735771Z",
         "version": 5,
-        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-14_01-29-49/threatintel-vuln-v5-2024-11-14_01-29-49.tar.gz",
-        "checksum": "18daaa2e4bc24dc122c0c0b06c04004b50641dca3b66b926128129f7b79d45e6"
+        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-20_13-08-27/threatintel-vuln-v5-2024-11-20_13-08-27.tar.gz",
+        "checksum": "88eb06bdaaa0cc58234b76c9db91d39be4c0816d1c83ecdff8cccfa5afcdf24a"
       },
       {
-        "built": "2024-11-14T13:11:40.115762725Z",
+        "built": "2024-11-21T01:33:56.389777835Z",
         "version": 5,
-        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-14_13-07-58/threatintel-vuln-v5-2024-11-14_13-07-58.tar.gz",
-        "checksum": "de5421ea322443b7d1a04aa3d690fc1b2533b365c2c7ba8a5e94c4271b1531fe"
+        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-21_01-30-07/threatintel-vuln-v5-2024-11-21_01-30-07.tar.gz",
+        "checksum": "60063279771817f4584a08149ba7a92ef6a4f314e6b0d2857aa88d5603871102"
       },
       {
-        "built": "2024-11-15T01:33:51.946166247Z",
+        "built": "2024-11-21T13:12:37.632497219Z",
         "version": 5,
-        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-15_01-30-10/threatintel-vuln-v5-2024-11-15_01-30-10.tar.gz",
-        "checksum": "bbcfc3fb3af38a1231cc8fad26bb2af5f876dd4ce98ebd2029d2e66362d0ab29"
+        "url": "https://threat-intel.deepfence.io/vulnerability-db/releases/download/threatintel-vuln-v5-2024-11-21_13-08-46/threatintel-vuln-v5-2024-11-21_13-08-46.tar.gz",
+        "checksum": "7f25862e0372762a46b20965149fc38d62a8ae1084b0dbbad5e307d921feb827"
       }
     ]
   }