Merge branch 'master' into master

Author: emmanuel-ferdman

frontend/libs/console/legacy-ce/src/lib/components/Services/ApiExplorer/Rest/Form/ExportOpenAPI.test.tsx

@@ -0,0 +1,165 @@
+import { removeRequestBodyFromGetOperations } from './ExportOpenAPI';
+
+// We're only testing the removeRequestBodyFromGetOperations function directly
+// No need to mock React components or hooks
+
+describe('removeRequestBodyFromGetOperations', () => {
+  it('should remove requestBody from GET operations', () => {
+    // Create a test OpenAPI spec with a GET operation that has a requestBody
+    const testSpec = {
+      paths: {
+        '/api/test': {
+          get: {
+            summary: 'Test GET',
+            parameters: [
+              {
+                in: 'query',
+                name: 'name',
+                schema: {
+                  type: 'string',
+                },
+              },
+            ],
+            requestBody: {
+              content: {
+                'application/json': {
+                  schema: {
+                    properties: {
+                      name: {
+                        type: 'string',
+                      },
+                    },
+                  },
+                },
+              },
+            },
+            responses: {
+              '200': {
+                description: 'OK',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    // Process the spec
+    const processedSpec = removeRequestBodyFromGetOperations(testSpec);
+
+    // Verify that the requestBody was removed from the GET operation
+    expect(processedSpec.paths['/api/test'].get.requestBody).toBeUndefined();
+
+    // Verify that other properties were preserved
+    expect(processedSpec.paths['/api/test'].get.summary).toBe('Test GET');
+    expect(processedSpec.paths['/api/test'].get.parameters).toEqual([
+      {
+        in: 'query',
+        name: 'name',
+        schema: {
+          type: 'string',
+        },
+      },
+    ]);
+  });
+
+  it('should not modify POST operations with requestBody', () => {
+    // Create a test OpenAPI spec with a POST operation that has a requestBody
+    const testSpec = {
+      paths: {
+        '/api/test': {
+          post: {
+            summary: 'Test POST',
+            requestBody: {
+              content: {
+                'application/json': {
+                  schema: {
+                    properties: {
+                      name: {
+                        type: 'string',
+                      },
+                    },
+                  },
+                },
+              },
+            },
+            responses: {
+              '200': {
+                description: 'OK',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    // Process the spec
+    const processedSpec = removeRequestBodyFromGetOperations(testSpec);
+
+    // Verify that the requestBody was preserved in the POST operation
+    expect(processedSpec.paths['/api/test'].post.requestBody).toEqual(
+      testSpec.paths['/api/test'].post.requestBody
+    );
+  });
+
+  it('should handle GET operations without requestBody', () => {
+    // Create a test OpenAPI spec with a GET operation that doesn't have a requestBody
+    const testSpec = {
+      paths: {
+        '/api/test': {
+          get: {
+            summary: 'Test GET',
+            parameters: [
+              {
+                in: 'query',
+                name: 'name',
+                schema: {
+                  type: 'string',
+                },
+              },
+            ],
+            responses: {
+              '200': {
+                description: 'OK',
+              },
+            },
+          },
+        },
+      },
+    };
+
+    // Process the spec
+    const processedSpec = removeRequestBodyFromGetOperations(testSpec);
+
+    // Verify that the operation was not modified
+    expect(processedSpec.paths['/api/test'].get).toEqual(
+      testSpec.paths['/api/test'].get
+    );
+  });
+
+  it('should handle specs without paths', () => {
+    // Create a test OpenAPI spec without paths
+    const testSpec = {
+      info: {
+        title: 'Test API',
+        version: '1.0.0',
+      },
+    };
+
+    // Process the spec
+    const processedSpec = removeRequestBodyFromGetOperations(testSpec);
+
+    // Verify that the spec was not modified
+    expect(processedSpec).toEqual(testSpec);
+  });
+
+  it('should handle empty specs', () => {
+    // Create an empty test OpenAPI spec
+    const testSpec = {};
+
+    // Process the spec
+    const processedSpec = removeRequestBodyFromGetOperations(testSpec);
+
+    // Verify that the spec was not modified
+    expect(processedSpec).toEqual(testSpec);
+  });
+});

frontend/libs/console/legacy-ce/src/lib/components/Services/ApiExplorer/Rest/Form/ExportOpenAPI.tsx

@@ -8,6 +8,32 @@ import { Analytics } from '../../../../../features/Analytics';
 import endpoints from '../../../../../Endpoints';
 import { downloadObjectAsJsonFile } from '../../../../Common/utils/export.utils';
 
+// Function to remove requestBody from GET operations in OpenAPI spec
+export const removeRequestBodyFromGetOperations = (openApiSpec: any) => {
+  const modifiedSpec = JSON.parse(JSON.stringify(openApiSpec));
+
+  // Check if paths exist in the spec
+  if (modifiedSpec.paths) {
+    // Iterate through all paths
+    Object.entries(modifiedSpec.paths).forEach(
+      ([_path, pathItem]: [string, any]) => {
+        // Check if there's a GET operation with requestBody
+        if (pathItem.get && pathItem.get.requestBody) {
+          // Remove the requestBody from GET operations
+          delete pathItem.get.requestBody;
+        }
+      }
+    );
+  }
+
+  return modifiedSpec;
+};
+
+// Export for testing
+export const __testExports = {
+  removeRequestBodyFromGetOperations,
+};
+
 const fetchData = async (httpClient: Axios) => {
   try {
     const response = await httpClient.get(endpoints?.exportOpenApi);
@@ -33,7 +59,11 @@ export const ExportOpenApiButton = () => {
       enabled: false,
       retry: 0,
       onSuccess: data => {
-        downloadObjectAsJsonFile('OpenAPISpec.json', data);
+        // Process the OpenAPI spec to remove requestBody from GET operations
+        const processedData = removeRequestBodyFromGetOperations(data);
+
+        // Download the modified OpenAPI spec
+        downloadObjectAsJsonFile('OpenAPISpec.json', processedData);
         hasuraToast({
           title: 'OpenApiSpec Exported Successfully!',
           type: 'success',

server/src-rsr/catalog_versions.txt

@@ -240,5 +240,7 @@ v2.45.3 48
 v2.47.0 48
 v2.36.11 48
 v2.36.12 48
-v2.48.0 48
+v2.48.0-beta.1 48
 v2.36.13 48
+v2.48.0 48
+v2.48.1 48