Update docs - API documentation link (#2374)

Update docs
deepfence · Nov 21, 2024 · 695d1e4 · 695d1e4
1 parent 031154c
commit 695d1e4
Show file tree

Hide file tree

Showing 18 changed files with 79 additions and 45 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"
       ]
     },