Install

Dry-run a GitHub package install

post/api/v1/install/github/plan

Request

  • Base URL: https://api-docs.busabase.com
  • URL: https://api-docs.busabase.com/api/v1/install/github/plan
  • Auth: none declared

Request body

repoUrlstring required

GitHub repo URL: https://github.com/<owner>/<repo>[/tree/<ref>[/<subdir>]]. Only GitHub hosts are accepted.

intoFolderstring

Slug of the folder to install into. Defaults to the package manifest's name.

renameboolean

Resolve slug collisions by suffixing (-2, -3, …) instead of refusing. Never overwrites anything.

autoMergeboolean

Response

What installing this package would create: the node outline, per-base record counts, slug collisions, warnings, and whether autoMerge is required. Creates nothing.

targetFolderSlugstring required
warningsstring[]
requiresAutoMergeboolean required
applicableboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.