horizechCLI
Referencelatest · 0.1.2

Registry API

The HTTP calls behind the commands, for debugging and scripting.

Registry calls go to https://api.horizech.com with Authorization: Bearer <access token> when signed in. Responses are the envelope { Success, Data, ErrorCode, AdditionalErrorInformation }, except a successful download, which is the zip with X-Package-Version, X-Package-Channel and X-Package-File-Hash headers.

MethodPathUsed by
GET/api/v1/packagespackage list, finding --org
GET/api/v1/packages/:org/:codepackage info, publish
GET/api/v1/packages/:org/:code/versionspackage versions
GET/api/v1/packages/:org/:code/versions/:version/manifestpublish, promote
GET/api/v1/packages/:org/:code/versions/:version/downloaddownload
POST/api/v1/packagespublish --create
POST/api/v1/packages/publishpublish
POST/api/v1/packages/:org/:code/promotepromote

Publishing (multipart)

FieldValue
OrganizationSlugThe organization.
CodeThe package code.
ChannelAlways sent; dev by default.
Manifestpackage.hws from the zip (without a byte-order mark).
FileThe zip.
ReleaseNotesFrom --notes, when given.

Identity provider

On https://horizech.com.

MethodPathUsed by
GET/OAuth2/Authorizelogin, in the browser
POST/OAuth2/Tokenlogin, refreshing
GET/OAuth2/UserInfologin, whoami
GET/OAuth2/Logoutlogout