Auto-Complete Required Request Body Parameters when Inserting Commands (

#156)

* Add Required Body Parameters when Inserting Commands

Signed-off-by: Snehil Shah <[email protected]>

* Format Code

Signed-off-by: Snehil Shah <[email protected]>

* Refactor

Signed-off-by: Snehil Shah <[email protected]>

---------

Signed-off-by: Snehil Shah <[email protected]>

src/components/CodeEditorWindow/Menu/CommandsDrawer/CommandsDrawer.jsx

@@ -7,6 +7,7 @@ import Close from '@mui/icons-material/Close';
 import useMediaQuery from '@mui/material/useMediaQuery';
 import { useSnackbar } from 'notistack';
 import { getSnackbarOptions } from '../../../Common/utils/snackbarOptions';
+import { resolveRequiredBodyParams } from '../../config/CommandsDrawerUtils';
 
 const CommandsDrawer = ({ open, toggleDrawer, handleInsertCommand }) => {
   const [allCommands, setAllCommands] = useState([]);
@@ -26,13 +27,18 @@ const CommandsDrawer = ({ open, toggleDrawer, handleInsertCommand }) => {
               const description = data.paths[path][method].summary;
               const tags = data.paths[path][method].tags;
               const hasRequestBody = !!data.paths[path][method].requestBody;
+              let requiredBodyParameters = null;
+              if (hasRequestBody) {
+                requiredBodyParameters = resolveRequiredBodyParams(data, data.paths[path][method].requestBody.content);
+              }
 
               return {
                 method: method.toUpperCase(),
                 command,
                 description,
                 hasRequestBody,
                 tags,
+                requiredBodyParameters,
               };
             });
           })

src/components/CodeEditorWindow/Menu/CommandsDrawer/CommandsTable.jsx

@@ -132,7 +132,13 @@ const CommandsTable = ({ commands, handleInsertCommand }) => {
 
   const handleClick = (command) => {
     const commandText = `${command.method} ${command.command.substring(1)}${
-      command.hasRequestBody ? ' \n{\n  \n}' : ''
+      command.hasRequestBody
+        ? ` \n{\n  ${
+            command.requiredBodyParameters
+              ? command.requiredBodyParameters.map((param) => `"${param}": `).join(',\n  ')
+              : ''
+          }\n}`
+        : ''
     }`;
 
     handleInsertCommand(commandText);

src/components/CodeEditorWindow/config/CommandsDrawerUtils.js

@@ -0,0 +1,12 @@
+export const resolveRequiredBodyParams = function (openapi, requestBodyContent) {
+  const contentType = Object.keys(requestBodyContent)[0];
+  if ('$ref' in requestBodyContent[contentType].schema) {
+    const refPath = requestBodyContent[contentType].schema.$ref;
+    // parse and navigate to the ref
+    const pathComponents = refPath.slice(2).split('/');
+    const schema = pathComponents.reduce((doc, pathComponent) => doc[pathComponent], openapi);
+    return schema.required;
+  } else {
+    return requestBodyContent[contentType].schema.required;
+  }
+};