fix: JSON response examples being saved as [object Object] in YAML format by sanjaikumar-bruno · Pull Request #6488 · usebruno/bruno

sanjaikumar-bruno · 2025-12-23T09:11:51Z

Issue:
When saving JSON response examples in YAML format, the response body content was being saved as [object Object] instead of the actual JSON data. This occurred because String() was used to convert the content, which doesn't properly serialize objects.

Fix:
Updated stringifyHttpRequest.ts to check the content type before serialization:

If content is a string, use it as-is
Otherwise, use JSON.stringify() to properly serialize objects, arrays, and primitives

The fix is similar to how we are handling JSON in bru,

bruno/packages/bruno-lang/v2/src/example/jsonToBru.js

Lines 212 to 229 in b61d221

    
             if (responseBody) { 
        
               bru += '  body: {\n'; 
        
               if (responseBody.type) { 
        
                 bru += `    type: ${responseBody.type}\n`; 
        
               } 
        
               if (responseBody.content !== undefined) { 
        
                 let contentString = typeof responseBody.content === 'string' ? responseBody.content : JSON.stringify(responseBody.content, null, 2); 
        
                 bru += `    content: '''\n${indentStringCustom(contentString, 6)}\n    '''\n`; 
        
               } 
        
               bru += '  }\n\n'; 
        
             } 
        
             bru = stripLastLine(bru); 
        
             bru += '}'; 
        
           }

…ectly

coderabbitai · 2025-12-23T09:12:02Z

Walkthrough

Modified stringifyHttpRequest.ts to improve example response body serialization. When stringifying response bodies, non-string content is now JSON-stringified with pretty-printing formatting instead of direct coercion, ensuring consistent readable output.

Changes

Cohort / File(s)	Change Summary
Response body serialization `packages/bruno-filestore/src/formats/yml/items/stringifyHttpRequest.ts`	Introduced `contentString` variable to handle content formatting—strings used as-is, non-strings JSON-stringified with indentation for readability

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested labels

size/XS

Suggested reviewers

lohit-bruno
helloanoop
bijin-bruno

Poem

✨ Pretty JSON, line by line,
No more squished strings in the design,
Stringify with care and grace,
Readability wins the race! 📋

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main fix: preventing JSON response examples from being incorrectly serialized as '[object Object]' in YAML format.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

fix: update stringifyHttpRequest to handle response body content corr…

626fb3d

…ectly

sanjaikumar-bruno requested review from bijin-bruno, helloanoop, lohit-bruno and naman-bruno as code owners December 23, 2025 09:11

pull-request-size bot added the size/XS label Dec 23, 2025

bijin-bruno approved these changes Dec 23, 2025

View reviewed changes

bijin-bruno merged commit 87c8934 into usebruno:main Dec 23, 2025
8 checks passed

sanjaikumar-bruno deleted the fix/yml-example-response-content-serialization branch December 23, 2025 10:28

coderabbitai bot mentioned this pull request Dec 28, 2025

Save response example to a separate file #6530

Open

4 tasks

coderabbitai bot mentioned this pull request Feb 1, 2026

fix: cURL import NDJSON in request body as text #7002

Merged

6 tasks

coderabbitai bot mentioned this pull request Feb 17, 2026

isJson assertion fails after res.setBody() with parsed object #7175

Closed

5 tasks

This was referenced Feb 25, 2026

Response Example Not Rendering Correctly in Bruno #7288

Open

req.setBody converting binary uint8array to json #7330

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: JSON response examples being saved as [object Object] in YAML format#6488

fix: JSON response examples being saved as [object Object] in YAML format#6488
bijin-bruno merged 1 commit intousebruno:mainfrom
sanjaikumar-bruno:fix/yml-example-response-content-serialization

sanjaikumar-bruno commented Dec 23, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Dec 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	if (responseBody) {
	bru += ' body: {\n';

	if (responseBody.type) {
	bru += ` type: ${responseBody.type}\n`;
	}

	if (responseBody.content !== undefined) {
	let contentString = typeof responseBody.content === 'string' ? responseBody.content : JSON.stringify(responseBody.content, null, 2);
	bru += ` content: '''\n${indentStringCustom(contentString, 6)}\n '''\n`;
	}

	bru += ' }\n\n';
	}

	bru = stripLastLine(bru);
	bru += '}';
	}

Conversation

sanjaikumar-bruno commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Dec 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Suggested labels

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sanjaikumar-bruno commented Dec 23, 2025 •

edited

Loading

coderabbitai bot commented Dec 23, 2025 •

edited

Loading