Skip to content

fix: appendAsyncAPIDocument to handle string and object inputs correctly#2028

Open
Ishita-190 wants to merge 2 commits intoasyncapi:masterfrom
Ishita-190:ishi
Open

fix: appendAsyncAPIDocument to handle string and object inputs correctly#2028
Ishita-190 wants to merge 2 commits intoasyncapi:masterfrom
Ishita-190:ishi

Conversation

@Ishita-190
Copy link

Fixes: #2026

Description
Made changes to src/domains/services/archiver.service.ts
Added:

public appendAsyncAPIDocument(
  archive: Archiver,
  asyncapi: string | object,
  fileName = 'asyncapi',
) {
  const content =
    typeof asyncapi === 'string'
      ? asyncapi
      : JSON.stringify(asyncapi, null, 2);

  const language = retrieveLangauge(content);
  const extension = language === 'yaml' ? 'yml' : 'json';

  archive.append(content, { name: `${fileName}.${extension}` });
}
  • Created a simple test script (test-archiver.ts) to pass a YAML string to appendAsyncAPIDocument
  • Ran the test using:
npx ts-node -r tsconfig-paths/register test-archiver.ts 
  • Checked the generated zip to verify proper formatting

Before:

image

After:

image

@changeset-bot
Copy link

changeset-bot bot commented Feb 19, 2026

⚠️ No Changeset found

Latest commit: 259d505

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@Ishita-190
Copy link
Author

@AayushSaini101 Sir, I've made the changes, also please take a look at #1969 when you have time, it's been open for quite some time now, thanks!

@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: To Triage

Development

Successfully merging this pull request may close these issues.

[BUG] : AsyncAPI document is double-stringified in generated ZIP output

1 participant

Comments