Add deeplink above code block that links to the API reference for eac…

…h request in the console (#142) * Add deeplink to the docs for each request in the console Signed-off-by: Snehil Shah <[email protected]> * Move Core Logic to `autocomplete-openapi` module Signed-off-by: Snehil Shah <[email protected]> * Fix Failing Workflow Signed-off-by: Snehil Shah <[email protected]> * Refactor for 0c1f910256fb88b82875eef34a5056776d5a18f7 Signed-off-by: Snehil Shah <[email protected]> * Refactor for a5693f7d5e811544a4fe245d630347c7b5148b0e Signed-off-by: Snehil Shah <[email protected]> * Format Source Code Signed-off-by: Snehil Shah <[email protected]> * refactor for `autocomplete-openapi=0.1.2` Signed-off-by: Snehil Shah <[email protected]> * fix workflow Signed-off-by: Snehil Shah <[email protected]> * Update src/components/EditorCommon/config/Rules.js Co-authored-by: Kartik Gupta <[email protected]> * Update openapi import in Rules.js to use the "raw" query parameter --------- Signed-off-by: Snehil Shah <[email protected]> Co-authored-by: Kartik Gupta <[email protected]> Co-authored-by: kartik-gupta-ij <[email protected]>
qdrant · Apr 20, 2024 · 4f91cba · 4f91cba
1 parent 5db568c
commit 4f91cba
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 10 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,7 +25,7 @@
     "@uppy/react": "^3.1.2",
     "@uppy/xhr-upload": "^3.3.1",
     "@vitejs/plugin-react": "^4.0.0",
-    "autocomplete-openapi": "^0.1.1",
+    "autocomplete-openapi": "^0.1.2",
     "axios": "^1.6.7",
     "chart.js": "^4.3.0",
     "chroma-js": "^2.4.2",

diff --git a/src/components/CodeEditorWindow/index.jsx b/src/components/CodeEditorWindow/index.jsx
@@ -19,6 +19,7 @@ const CodeEditorWindow = ({ onChange, code, onChangeResult, setRequestCount }) =
 
   let runBtnCommandId = null;
   let beautifyBtnCommandId = null;
+  let docsBtnCommandId = null;
 
   const handleEditorChange = (code) => {
     onChange('code', code);
@@ -74,10 +75,15 @@ const CodeEditorWindow = ({ onChange, code, onChangeResult, setRequestCount }) =
       ''
     );
 
+    docsBtnCommandId = editor.addCommand(0, async (_ctx, ...args) => {
+      const docsURL = args[0];
+      window.open(docsURL, '_blank');
+    });
+
     // Register Code Lens Provider (Run Button)
     lensesRef.current = monaco.languages.registerCodeLensProvider(
       'custom-language',
-      btnconfig(runBtnCommandId, beautifyBtnCommandId)
+      btnconfig(runBtnCommandId, beautifyBtnCommandId, docsBtnCommandId)
     );
 
     // Listen for Mouse Postion Change

diff --git a/src/components/EditorCommon/config/Rules.js b/src/components/EditorCommon/config/Rules.js
@@ -1,4 +1,10 @@
+import { OpenapiDocs } from 'autocomplete-openapi/src/request-docs';
+import openapi from '/openapi.json??url&raw';
+
 const Method = ['POST', 'GET', 'PUT', 'DELETE', 'PATCH', 'HEAD'];
+const DOCS_BASE_URL = 'https://qdrant.github.io/qdrant/redoc/index.html#tag/';
+
+const apiDocs = new OpenapiDocs(JSON.parse(openapi));
 
 export const Rules = {
   Method,
@@ -54,7 +60,7 @@ export const options = {
   },
 };
 
-export function btnconfig(commandId, beutifyCommandId) {
+export function btnconfig(commandId, beutifyCommandId, docsCommandId) {
   return {
     // function takes model and token as arguments
     provideCodeLenses: function (model) {
@@ -88,6 +94,20 @@ export function btnconfig(commandId, beutifyCommandId) {
             arguments: [codeBlocks[i]],
           },
         });
+
+        const terminal = apiDocs.getRequestDocs(codeBlocks[i].blockText.split('\n')[0]);
+        if (terminal) {
+          const docsURL = DOCS_BASE_URL + terminal.tags[0] + '/operation/' + terminal.operationId;
+          lenses.push({
+            range,
+            id: 'DOCS',
+            command: {
+              id: docsCommandId,
+              title: 'DOCS',
+              arguments: [docsURL],
+            },
+          });
+        }
       }
 
       return {