Review an install
Shows what installing the component into the project, or updating its install, would do: the version the range resolves to, the capabilities it adds, and the props and events it adds, removes or changes.
Nothing changes.
Guide: Publishing
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The registry component's id, cmp_pkg_....
Query parameters
The version range to review: *, an exact version such as 1.2.0, ^1.2.0 (same major version) or ~1.2.0 (same minor version). Defaults to the install's range, or for a new install ^ the newest ready version.
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/registry-components/cmp_pkg_h2j7k4l9z1x6c3v8b5n0m4q7/install-review?versionRange=%5E1.2.0" \ -H "Authorization: Bearer vh_sk_..."{ "registryComponentId": "cmp_pkg_h2j7k4l9z1x6c3v8b5n0m4q7", "versionRange": "^1.2.0", "currentVersionId": "cmp_pkg_ver_w8e3r6t1y4u9i2o7p5a0s3d6", "currentVersion": "1.2.0", "targetVersionId": "cmp_pkg_ver_e5r8t2y6u0i3o7p1a4s9d2f6", "targetVersion": "1.3.0", "targetCapabilities": [ "commerce", "analytics" ], "addedCapabilities": [ "analytics" ], "changes": [ { "kind": "capability_added", "name": "analytics" } ], "isConsentRequired": true}{ "error": { "type": "invalid_request", "code": "invalid_version_range", "message": "The version range is invalid. \"1.x\" is not a version range: use *, an exact version (1.2.3), ^1.2.3 or ~1.2.3.", "param": "versionRange" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "conflict", "code": "no_matching_version", "message": "No installable version of acme/plan-picker matches ^2.0.0.", "param": "versionRange" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_version_range | — |
| 409 | conflict | no_matching_version | — |
| 409 | conflict | no_installable_version | — |
| 409 | conflict | registry_component_deprecated | — |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Component registry
- Retrieve the registry publisher
GET - Claim a registry namespace
PUT - List registry components
GET - Publish a component bundle
POST - Publish a project component
POST - Retrieve a registry component
GET - Update a registry component
PATCH - List a registry component's versions
GET - Retrieve a registry component version
GET - Update a registry component version
PATCH - Retrieve a version's file
GET - List installed components
GET - Install a registry component
POST - Retrieve an install
GET - Update an install
PATCH - Uninstall a registry component
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.