Skip to content

feat: add Bruno collections generated from Postman sources - #1759

Open
neeshsilva wants to merge 1 commit into
vtex:masterfrom
neeshsilva:feat/bruno-collections
Open

feat: add Bruno collections generated from Postman sources#1759
neeshsilva wants to merge 1 commit into
vtex:masterfrom
neeshsilva:feat/bruno-collections

Conversation

@neeshsilva

Copy link
Copy Markdown

Adds BrunoCollections/, a Bruno equivalent of PostmanCollections/ written in the OpenCollection format (opencollection: 1.0.0): 92 collections, 297 folders, 1183 requests and 92 environments, one self-contained collection per API to mirror the one-file-per-API layout of the Postman sources.

A workspace.yml links all 92 so they open together from the title-bar workspace switcher. Bruno does not support nesting collections, so the container is a workspace rather than a parent collection.

The 1126 portman-generated pm.* test blocks do not run in Bruno and were rewritten against its test()/expect() API, including 804 JSON-schema assertions compiled through the bundled ajv, which resolves under the default safe script sandbox.

Generation lives in BrunoCollections/_tools and is rerunnable via convert.sh, so this directory can be refreshed as the portman workflow updates PostmanCollections/. Secret variables are declared with no value, keeping credentials out of the committed files.

Types of changes

  • New content (endpoints, descriptions or fields from scratch)
  • Improvement (make an endpoint's title or description even better)
  • Spelling and grammar accuracy (self-explanatory)

Changelog

Do not forget to update your changes to our Developer Portal's changelog. Did you create a release note?

  • Yes, I already created a release note about this change.
  • Not yet, but I'm going to.
  • No, it's just a fix.

Adds BrunoCollections/, a Bruno equivalent of PostmanCollections/ written in the OpenCollection format (opencollection: 1.0.0): 92 collections, 297 folders, 1183 requests and 92 environments, one self-contained collection per API to mirror the one-file-per-API layout of the Postman sources.

A workspace.yml links all 92 so they open together from the title-bar workspace switcher.
Bruno does not support nesting collections, so the container is a workspace rather than a parent collection.

The 1126 portman-generated pm.* test blocks do not run in Bruno and were rewritten against its test()/expect() API, including 804 JSON-schema assertions compiled through the bundled ajv, which resolves under the default `safe` script sandbox.

Generation lives in BrunoCollections/_tools and is rerunnable via convert.sh, so this directory can be refreshed as the portman workflow updates PostmanCollections/.
Secret variables are declared with no value, keeping credentials out of the committed files.
@vtex-pr-sentinel

Copy link
Copy Markdown

🛡️ SDD Check — action required

I couldn't detect an SDD in this PR. Please check one option below (requires write access to the repo):

  • SDD lives in another PR — paste the SDD PR URL here:
  • This PR doesn't need an SDD
  • SDD applies, but I'm not adopting it in this PR

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant