Skip to content

Conversation

@TuannasCodeCatastrophe
Copy link
Contributor

@TuannasCodeCatastrophe TuannasCodeCatastrophe commented Nov 17, 2025

Description

Jobs to be done (optional)
Users need clear instructions on how to export Insomnia collection run results as a JSON file using the Inso CLI.
This how-to will help users safely generate, review, and share run results while understanding how Insomnia protects sensitive information through redaction and truncation.

Definition of done
Write a new how-to guide on exporting collection run results to a JSON file with the Inso CLI.
Add the guide to:
https://developer.konghq.com/inso-cli/#how-to-guides

Information
Jira
Confluence
Due date (optional)
19 Nov

Size
Rough estimate of effort:

M (Medium) Example: writing a UI how to for a straightforward product, adding a plugin example

Fixes #3451

Preview Links

https://deploy-preview-3493--kongdeveloper.netlify.app/how-to/export-collection-run-results/

https://deploy-preview-3493--kongdeveloper.netlify.app/insomnia/collection-run-results-export/

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@TuannasCodeCatastrophe TuannasCodeCatastrophe added this to the Insomnia V12.1 milestone Nov 17, 2025
@TuannasCodeCatastrophe TuannasCodeCatastrophe requested a review from a team as a code owner November 17, 2025 14:45
@TuannasCodeCatastrophe TuannasCodeCatastrophe added do not merge Issues/ PRs whose changes should not be merged at this time release-docs Docs for release product:insomnia labels Nov 17, 2025
@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


TuannasCodeCatastrophe seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@netlify
Copy link

netlify bot commented Nov 17, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit b30ce51
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/692d8f8e80b6ca0008bef16f
😎 Deploy Preview https://deploy-preview-3493--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@TuannasCodeCatastrophe TuannasCodeCatastrophe marked this pull request as draft November 17, 2025 14:45
@TuannasCodeCatastrophe TuannasCodeCatastrophe marked this pull request as ready for review November 17, 2025 15:17
@TuannasCodeCatastrophe TuannasCodeCatastrophe changed the base branch from main to InsomniaV12.1 November 17, 2025 15:47
Copy link
Contributor

@Guaris Guaris left a comment

Choose a reason for hiding this comment

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

I noticed that app/insomnia/export-collection-run-results.md is using

content_type: reference
layout: reference

But according to the issue I was expecting a how-to.

@TuannasCodeCatastrophe
Copy link
Contributor Author

TuannasCodeCatastrophe commented Nov 18, 2025

I noticed that app/insomnia/export-collection-run-results.md is using

content_type: reference
layout: reference

But according to the issue I was expecting a how-to.

@Guaris Yes, I changed from How-to to Reference after the team meeting were we discussed minimizing how-to's and aiming for reference instead at the minute, and I thought this ticket was an opportunity to apply that.
The original commit was a how-to, but then I changed it to the reference.

@lena-larionova
Copy link
Contributor

aiming for reference instead at the minute, and I thought this ticket was an opportunity to apply that.
The original commit was a how-to, but then I changed it to the reference.

Ah, sorry about the confusion - the goal is still to write how-tos if possible. If this started as a how-to, it should stay that way! For Gateway, we were talking about writing some references for now because Gateway can be pretty complex and we might not have time to test everything properly before release day. If we can't guarantee that something works, then it shouldn't be a how-to; but if it's testable and verifiable, into how-to it goes.

@TuannasCodeCatastrophe
Copy link
Contributor Author

Ah, sorry about the confusion - the goal is still to write how-tos if possible. If this started as a how-to, it should stay that way! For Gateway, we were talking about writing some references for now because Gateway can be pretty complex and we might not have time to test everything properly before release day. If we can't guarantee that something works, then it shouldn't be a how-to; but if it's testable and verifiable, into how-to it goes.

It's my bad, sorry! I've updated my thinking process:
- If we can't guarantee that something works, then it shouldn't be a how-to; but if it's testable and verifiable, into how-to it goes.
Is the rule for future me.

Additionally, thanks for the review @lena-larionova !

@TuannasCodeCatastrophe
Copy link
Contributor Author

@fabianrbz Hi Fabian! I think that this Broken Links / build (pull_request) error similar to this one on 3449? What do you think?

Base automatically changed from release/insomnia-v12.1 to main November 21, 2025 17:51
@TuannasCodeCatastrophe
Copy link
Contributor Author

Update:
Inso CLI on windows does not work as expected -> help required & requested for validation step.

Next steps: Extrapolate reference material from How-to > Outcome: Reference draft & How-to draft

@TuannasCodeCatastrophe
Copy link
Contributor Author

Inso CLI not behaving as expected - Slack convos
1
2

@TuannasCodeCatastrophe
Copy link
Contributor Author

@fabianrbz I still get the deploy link error in my PRs - do you know how I can stop them?

@Guaris
Copy link
Contributor

Guaris commented Dec 2, 2025

Yesterday I mentioned that we should have navtabs for windows and OSX, but now I understand that ./ syntax isn't Windows specific. Don't add the navtabs to this doc. We need to ask the Insomnia team what the preferred method for using InsoCLI on Windows is.

Also, remove the ./ from all the instructions.

@TuannasCodeCatastrophe

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

Labels

do not merge Issues/ PRs whose changes should not be merged at this time product:insomnia release-docs Docs for release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feat (Insomnia) How-to export collection run results to JSON (Inso CLI)

5 participants