Document req.headerList and res.headerList scripting API#95
Open
mintlify[bot] wants to merge 1 commit into
Open
Document req.headerList and res.headerList scripting API#95mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Adds reference documentation for the new PropertyList API exposed via req.headerList (read-write) and res.headerList (read-only) introduced in usebruno/bruno#7673. Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds reference documentation for the new
PropertyListAPI exposed viareq.headerList(read-write) andres.headerList(read-only), introduced in usebruno/bruno#7673 (merged May 5, 2026).Changes
testing/script/request/request-object.mdx— adds aheaderListsection documenting all read, search, iteration, transform, and write methods onreq.headerList, including handling of disabled headers.testing/script/response/response-object.mdx— adds aheaderListsection documenting the read-only API onres.headerList, with a note that write methods throw.Context
The existing
req.headers/res.headersraw objects remain unchanged for backward compatibility. The newheaderListAPI provides:get,has,one,indexOf)forEach,map,reduce,filter,find)toObject,toString,toJSON)req.headerList(append,set,delete,clear,populate,repopulate,assimilate)req.headerListMethod naming aligns with the MDN Web API Headers interface.
Validation
mint validate— passedmint broken-links— no new broken links introduced