IMPORT API BRUNO

Imports a bundled OpenCollection YAML (Bruno) API collection into BroadSQL's API catalog: creates the API (with environments, folders, and endpoints of every HTTP method) if it does not exist yet, or safely re-imports into an existing one: an object present in the source is created or updated, an object from a previous import no longer present in the source is left untouched, never deleted. Every HTTP verb is imported and listed by SHOW ENDPOINTS; GET, HEAD, POST, PUT, PATCH, and DELETE can be executed (RUN refuses OPTIONS and any other verb). Scripts, assertions and request/response automation are never imported. Only the bundled (single-file) OpenCollection YAML format is supported.

Arguments

<filePath> (mandatory) path to a bundled OpenCollection YAML file, quote if it contains spaces; <apiId> (mandatory) the API identifier to create or re-import into

Examples

IMPORT API BRUNO "C:\bruno\demo.yml" DEMO;

Notes

Imports a bundled OpenCollection YAML (Bruno) API collection into BroadSQL's API catalog: IMPORT API BRUNO <filePath> <apiId>. See the "SPRINT XT02: Universal API Client" design doc under docs/.

Creates apiId (with its mandatory default version) the first time it is used; re-running against an already-imported apiId is a safe, idempotent re-import: an object already known by its source identity is updated, a new one is inserted, an object from a previous import no longer present in the source is left completely untouched, never deleted (sprint doc requirement 7). Every HTTP verb is imported and becomes visible via SHOW ENDPOINTS; this release executes every verb except OPTIONS (see RUN). Scripts, assertions and pre/post request automation are recognized during import and counted, never persisted or shown.

Only the bundled (bundled: true) single-file OpenCollection format is supported in this release: the format the user currently exports from Bruno. Directory-based (multi-file) collections are not yet read.

Last modified in release 5.2.5.