fix: oas should import requests where possible by jackkav · Pull Request #9632 · Kong/insomnia

jackkav · 2026-02-03T10:47:48Z

This appears to have worked previously. Just had to fix the api spec detection

jackkav · 2026-02-05T17:22:21Z

packages/insomnia/src/common/import.ts

+        let insomnia5Import: ExportedModel[] = [];
+        if (contentStr.startsWith('type: ')) {
+          const { data, error } = tryImportV5Data(contentStr);
+          insomnia5Import = data as ExportedModel[];
+          v5Error = error;
+        }


I did this because the error spam was killing my debugging experience

jackkav · 2026-02-05T17:22:50Z

packages/insomnia/src/common/import.ts

@@ -251,6 +255,7 @@ export async function scanResources(importEntries: ImportEntry[]): Promise<ScanR
        unitTests,
        unitTestSuites,
        requests: [...requests, ...websocketRequests, ...grpcRequests, ...socketIoRequests],
+        requestGroups,


This was most of what was broken about imports before, if im not mistaken

jackkav · 2026-02-05T17:23:19Z

packages/insomnia/src/common/import.ts

-  // in order to support import from api spec yaml
-  if (resourceCacheItem?.importer?.id && isApiSpecImport(resourceCacheItem.importer)) {
+  // support import from both insomnia export and api spec yaml
+  if (resources.find(isApiSpec) || isApiSpecImport(resourceCacheItem.importer)) {


this makes the next code support both v5 and oas

jackkav · 2026-02-05T17:23:46Z

packages/insomnia/src/common/import.ts

+  if (isGitProject(project)) {
+    await models.workspaceMeta.update(workspaceMeta, {
+      gitFilePath: `${newWorkspace.name}-${newWorkspace._id}.yaml`,
+    });
+  }


moved this down since it was duplicated

Copilot

Pull request overview

This PR adjusts import scanning and workspace creation to better detect API spec vs Insomnia exports, aiming to ensure OpenAPI/Swagger imports can include generated requests (and related group structure) where possible.

Changes:

Tightened Insomnia v5 detection during scanning to avoid mis-detecting non-v5 content.
Exposed requestGroups in scan results alongside requests.
Updated new-workspace import flow to create design workspaces when API specs are involved, and adjusted git workspace metadata handling.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File	Description
packages/insomnia/src/routes/import.scan.tsx	Removes commented-out import parsing snippet from the cURL scan path.
packages/insomnia/src/common/import.ts	Updates scan heuristics, includes request groups in scan output, and changes new-workspace import behavior for API specs and git projects.
packages/insomnia-smoke-test/tests/smoke/command-palette.test.ts	Adds an extra navigation step in the command palette smoke test.

Comments suppressed due to low confidence (2)

packages/insomnia/src/common/import.ts:618

The condition resources.find(isApiSpec) || isApiSpecImport(resourceCacheItem.importer) treats any import that contains an ApiSpec model as a raw API-spec-YAML import. For Insomnia exports that include an ApiSpec resource (e.g. v5 spec workspace export / workspace duplication), this will incorrectly write apiSpec.contents from resourceCacheItem.content (which can be the entire export payload/JSON) and force contentType: 'yaml'. Split the cases: for OAS importers, use the raw content string; for Insomnia exports containing an ApiSpec resource, use that resource's contents/contentType and preserve the workspace scope/name from the exported workspace.

  // support import from both insomnia export and api spec yaml
  if (resources.find(isApiSpec) || isApiSpecImport(resourceCacheItem.importer)) {
    newWorkspace = await models.workspace.create({
      name: workspaceToImport?.name,
      scope: 'design',
      parentId: projectId,
    });

    await models.apiSpec.updateOrCreateForParentId(newWorkspace._id, {
      contents: resourceCacheItem.content as string | undefined,
      contentType: 'yaml',
      fileName: workspaceToImport?.name,
    });

packages/insomnia/src/common/import.ts:618

The updated import path for API spec vs Insomnia export (the resources.find(isApiSpec) branch) changes workspace creation and apiSpec persistence logic, but there are no unit tests covering this regression-prone behavior (e.g. importing an Insomnia v5 export that contains an ApiSpec should persist apiSpec.contents from the model, not the raw file, and should still import generated requests/groups). Add tests in packages/insomnia/src/common/__tests__/import.test.ts that exercise importResourcesToProject() for an import file containing an ApiSpec resource.

  // support import from both insomnia export and api spec yaml
  if (resources.find(isApiSpec) || isApiSpecImport(resourceCacheItem.importer)) {
    newWorkspace = await models.workspace.create({
      name: workspaceToImport?.name,
      scope: 'design',
      parentId: projectId,
    });

    await models.apiSpec.updateOrCreateForParentId(newWorkspace._id, {
      contents: resourceCacheItem.content as string | undefined,
      contentType: 'yaml',
      fileName: workspaceToImport?.name,
    });

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-06T14:44:23Z

packages/insomnia/src/common/import.ts


+  if (isGitProject(project)) {
+    await models.workspaceMeta.update(workspaceMeta, {
+      gitFilePath: `${newWorkspace.name}-${newWorkspace._id}.yaml`,


gitFilePath is derived from newWorkspace.name without sanitization. Workspace names can contain path separators or other unsafe characters, which can create invalid paths or unintended directories in git-backed projects. Use the existing safeToUseInsomniaFileNameWithExt() helper (and path.join if needed) to generate a safe .yaml file name.

Suggested change

gitFilePath: `${newWorkspace.name}-${newWorkspace._id}.yaml`,

gitFilePath: safeToUseInsomniaFileNameWithExt(`${newWorkspace.name}-${newWorkspace._id}`, 'yaml'),

Copilot · 2026-02-06T14:44:24Z

packages/insomnia/src/common/import.ts

+        let insomnia5Import: ExportedModel[] = [];
+        if (contentStr.startsWith('type: ')) {
+          const { data, error } = tryImportV5Data(contentStr);
+          insomnia5Import = data as ExportedModel[];
+          v5Error = error;
+        }


scanResources only attempts Insomnia v5 import when contentStr.startsWith('type: '). Valid v5 YAML may include a BOM, leading whitespace, --- document start, or comments before type:, which would skip v5 parsing and change behavior/error reporting. Consider using contentStr.trimStart() and/or a regex that tolerates YAML preambles (and ideally verifies the value matches *.insomnia.rest/5.0) rather than a strict prefix match.

Copilot · 2026-02-06T14:44:24Z

packages/insomnia/src/common/import.ts

@@ -251,6 +255,7 @@ export async function scanResources(importEntries: ImportEntry[]): Promise<ScanR
        unitTests,
        unitTestSuites,
        requests: [...requests, ...websocketRequests, ...grpcRequests, ...socketIoRequests],
+        requestGroups,
        workspaces,


requestGroups is added to the returned scan result, but ScanResult interface does not declare this property. This makes the new data invisible to typed consumers and encourages any usage. Add requestGroups?: RequestGroup[] (and necessary import/type) to ScanResult to keep the contract accurate.

gatzjames · 2026-02-06T14:49:37Z

packages/insomnia/src/common/import.ts

-        const { data: insomnia5Import, error } = tryImportV5Data(contentStr);
-        v5Error = error;
+        let insomnia5Import: ExportedModel[] = [];
+        if (contentStr.startsWith('type: ')) {


Not sure if this will be true for all yaml imports.
Maybe we can improve the error logging instead?

jackkav requested a review from a team February 3, 2026 11:32

jackkav force-pushed the fix/oas-with-requests branch 2 times, most recently from 7621ab2 to 2570ca5 Compare February 3, 2026 13:44

jackkav requested review from gatzjames and yaoweiprc February 4, 2026 14:55

jackkav commented Feb 5, 2026

View reviewed changes

jackkav added 3 commits February 6, 2026 15:40

first pass

e666824

support v5 import too

c4ef223

mark oas correctly

0157b67

Copilot AI review requested due to automatic review settings February 6, 2026 14:40

gatzjames force-pushed the fix/oas-with-requests branch from 2570ca5 to 0157b67 Compare February 6, 2026 14:40

Copilot started reviewing on behalf of gatzjames February 6, 2026 14:40 View session

Copilot AI reviewed Feb 6, 2026

View reviewed changes

gatzjames approved these changes Feb 6, 2026

View reviewed changes

gatzjames reviewed Feb 6, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: oas should import requests where possible#9632

fix: oas should import requests where possible#9632
jackkav wants to merge 3 commits intoKong:developfrom
jackkav:fix/oas-with-requests

jackkav commented Feb 3, 2026 •

edited

Loading

Uh oh!

jackkav Feb 5, 2026

Uh oh!

jackkav Feb 5, 2026

Uh oh!

jackkav Feb 5, 2026

Uh oh!

jackkav Feb 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

Copilot AI Feb 6, 2026

Uh oh!

gatzjames Feb 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	gitFilePath: `${newWorkspace.name}-${newWorkspace._id}.yaml`,
	gitFilePath: safeToUseInsomniaFileNameWithExt(`${newWorkspace.name}-${newWorkspace._id}`, 'yaml'),

Conversation

jackkav commented Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jackkav Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

jackkav Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

jackkav Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

jackkav Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

gatzjames Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jackkav commented Feb 3, 2026 •

edited

Loading