Streamline management of API collections #1

2026-08-19T14:23:39+02:00

administrator commented

2026-08-19 14:23:39 +02:00

Description

Add scripts to facilitate fruition of Bruno API collections

Reason

Bruno API has been chosen as a substitute of Postman because of limitations in multi-user collaboration in its "free" version.
While Bruno is very similar to Postman in many aspects, it still needs to be installed by every user who needs to call internal APIs: to make it easier to call HTTP requests, many scripts and tools have been added to convert Bruno requests to VSCode/httpyac requests, allowing users to be able to use them without installing Bruno itself.

Since many collections make use of secrets, a main environment file has been created to propagate such secrets to all collections; some configuration scripts have also been added to streamline such process.

Remarks

Even if Bruno is not scrictly needed to run requests, one has still to install VSCode and httpyac extension

Details

move Bruno collections to own folder (this allows for automatic generation of different formats under autodocs folder)
add automatic generation of httpyac requests (Bruno scripts are not automatically refactored!)
add scripts to automatically generate environments and values for Bruno collections
add scripts to automatically generate environments and values for httpyac requests

Co-authors

N/A

Check-lists

Common

At least 1 unit-test added.

Note: no tests have been added, as the utility scripts are Powershell-based.

Database

N/A

## Description Add scripts to facilitate fruition of Bruno API collections ### Reason Bruno API has been chosen as a substitute of Postman because of limitations in multi-user collaboration in its "free" version. While Bruno is very similar to Postman in many aspects, it still needs to be installed by every user who needs to call internal APIs: to make it easier to call HTTP requests, many scripts and tools have been added to convert Bruno requests to VSCode/httpyac requests, allowing users to be able to use them without installing Bruno itself. Since many collections make use of secrets, a main environment file has been created to propagate such secrets to all collections; some configuration scripts have also been added to streamline such process. ### Remarks Even if Bruno is not scrictly needed to run requests, one has still to install VSCode and httpyac extension ### Details - move Bruno collections to own folder (this allows for automatic generation of different formats under autodocs folder) - add automatic generation of httpyac requests (Bruno scripts are not automatically refactored!) - add scripts to automatically generate environments and values for Bruno collections - add scripts to automatically generate environments and values for httpyac requests ## Co-authors N/A ## Check-lists ### Common - [ ] At least 1 unit-test added. Note: no tests have been added, as the utility scripts are Powershell-based. ### Database N/A

administrator added 42 commits 2026-08-19 14:23:39 +02:00

add AI generated script aa272dfc55

add gitignore for automatically generated stuff

refactor 8851717532

- add YAML module and remove python child process
- add collection headers to each request
- fix authorization header emission
- create .env.template file with environment variables

emit also variable value in the env template 0b1a7becb8

fix duplicate query string parameters 25c271f291

variables from collection environments are rendered as dotenv variables c03706d251

add disabled variables as commented and enabled as parametrized ba01e76c75

ai refactor 2727ec67e3

- add missing headers and body with relative content-type
- fix double quotes for empty variables (not needed by VSCode REST client)
- strip comments from JSON data

fix unwanted generation of additional _dotenv_ variables f531310718

fix authorization headers generation b00dee4f10

add unit tests

fix rendering of environment-backed variables 42b8f337af

update variable values generation to empty string 5f7feec2a8

change autogenerated requests path to autogen/httpyac

clean destination of all files and empty subfolders f8358c9361

remove whitespace in stripped JSON comments 3f75f567f3

fix starting @ to commented variables 12f7c18362

add copy of JS files f16afd8baa

add equivalent powershell script 525d4f4cf0

add warning message for unparseable JSON in body data 4caf0d855e

add info on JS files added 5f2b014a11

first part of conversion of node functions bdaef511f3

Merge branch 'main' into script-autogenerate-http 2486f4a8c7

elixForms API v2 2dec14af4a

- update EFTL for table of amounts with year

second part of conversion from nodejs to powershell e282ab8576

add environment setup script c5db2f3ae9

add pwsh required module powershell-yaml 08b418c513

rename pwsh script to generate-http-requests 650d62a29c

fixes on nodejs script cb6d7d91a5

- add missing headers generation
- sort variables (for testing, may be disabled)
- skip environments when no file is actually present

refactor on pwsh script 63c6bce3cc

- take account of pwsh quirks...
- add missing headers generation
- add missing rendering of variables
- make 99.9% equal to nodejs script

rename nodejs package configurations e036ab9eaa

move nodejs script to tools folder 907e67125a

add json file for environment definition cd5dc41832

add script to create and configure json environment file 4157e539f6

add script to update api collections env files 2ab210c13b

fix EFTL output for delibera tempate 8298e60bc4

fix setup environment for node tools a70e06a83f

Merge branch 'main' into script-autogenerate-http 2d9de2a7ae

Merge branch 'main' into script-autogenerate-http 09ff0cacad

major refactor ca9ba75c21

- change autogenerated folder to autodocs/httpyac
- renamed many environment variables
- add config section to env template to manage different apps
- cleanup bruno environments for easier automation of env files
- add pre-request and post-response scripts from bruno
- manage EFTL-specific scripts
- add scripts to setup json template
- add scripts to update environment files

move bruno collections in own folder 044c54ab7b

remove node tools 1fd36fd957

rename scripts and fix collections location 5ae3b93436

add runner to find CCT instances by contract 80b134e32a