fix: api docs and add org docs (#1071)

ComposioHQ · Dec 22, 2024 · 27d8d1a · 27d8d1a
1 parent 1fd2acb
commit 27d8d1a
Show file tree

Hide file tree

Showing 12 changed files with 42 additions and 6 deletions.
diff --git a/docs/api-reference/client/delete-project.mdx b/docs/api-reference/client/delete-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /api/v1/client/auth/project/delete/{projectId}
+---
diff --git a/docs/api-reference/client/get-org-api-key.mdx b/docs/api-reference/client/get-org-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /api/v1/client/auth/org/api_key
+---
diff --git a/docs/api-reference/client/regenerate-org-api-key.mdx b/docs/api-reference/client/regenerate-org-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /api/v1/client/auth/org/api_key/regenerate
+---
diff --git a/docs/api-reference/projects/create-new-project.mdx b/docs/api-reference/projects/create-new-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /api/v1/org/projects/create
+---
diff --git a/docs/api-reference/projects/delete-project.mdx b/docs/api-reference/projects/delete-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: delete /api/v1/org/projects/{projectId}
+---
diff --git a/docs/api-reference/projects/get-project.mdx b/docs/api-reference/projects/get-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /api/v1/org/projects/{projectId}
+---
diff --git a/docs/api-reference/projects/list-all-projects.mdx b/docs/api-reference/projects/list-all-projects.mdx
@@ -0,0 +1,3 @@
+---
+openapi: get /api/v1/org/projects
+---
diff --git a/docs/api-reference/projects/regenerate-project-api-key.mdx b/docs/api-reference/projects/regenerate-project-api-key.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /api/v1/org/projects/{projectId}/api-key/regenerate
+---
diff --git a/docs/api-reference/projects/rename-project.mdx b/docs/api-reference/projects/rename-project.mdx
@@ -0,0 +1,3 @@
+---
+openapi: post /api/v1/org/projects/{projectId}/rename
+---
diff --git a/docs/composio_openapi.json b/docs/composio_openapi.json
diff --git a/docs/mint.json b/docs/mint.json
@@ -186,7 +186,6 @@
         "introduction/foundations/components/workspace",
         "faq/api_key/api_key",
         "faq/api_key/cli",
-        "enterprise/intro",
         "faq/integrations_and_connections/list_of_tools",
         "faq/supported_llms/supported_llm"
       ]
@@ -251,9 +250,7 @@
   {
     "group": "Client",
     "pages": [
-      "api-reference/client/get-user-info",
-      "api-reference/client/get-projects",
-      "api-reference/client/add-new-project"
+      "api-reference/client/get-user-info"
     ]
   },
   {
@@ -286,6 +283,17 @@
       "api-reference/logs/post-logs"
     ]
   },
+  {
+    "group": "Projects",
+    "pages": [
+      "api-reference/projects/list-all-projects",
+      "api-reference/projects/get-project",
+      "api-reference/projects/regenerate-project-api-key",
+      "api-reference/projects/create-new-project",
+      "api-reference/projects/delete-project",
+      "api-reference/projects/rename-project"
+    ]
+  },
   {
     "group": "Team",
     "pages": [

diff --git a/docs/package.json b/docs/package.json
@@ -1,7 +1,8 @@
 {
 	"scripts": {
 		"dev": "mintlify dev",
-		"generate:dev": "wget https://staging-backend.composio.dev/openapi.json -O composio_openapi.json && pnpm generate",
+		"openapi:validate": "mintlify openapi-check composio_openapi.json",
+		"generate:docs": "curl -o composio_openapi.json https://backend.composio.dev/openapi.json && pnpm generate",
 		"generate": "rm -rf api-reference || true && npx @mintlify/scraping@latest openapi-file ./composio_openapi.json -o api-reference && node scripts/render_mint_json_template.js"
 	},
 	"dependencies": {