SDK: releases

The releases area has 7 methods on the client. Each takes one object of path, query and body arguments and an optional CallOptions, and returns a promise of the response body. A refused call rejects with OverlaneApiError (see the SDK index).

releasesGet

Read a release

• Request: GET on /v1/tenants/{tenantId}/releases/{releaseId}

releasesGet(args: { tenantId: string; releaseId: string }, options?: CallOptions): Promise<Record<string, unknown>>

releasesList

List releases

• Request: GET on /v1/tenants/{tenantId}/releases

releasesList(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

releasesPromote

Promote a release to a channel (release class)

• Request: POST on /v1/tenants/{tenantId}/releases/{releaseId}/promote
• Needs an approval for agents: class release_promotion

releasesPromote(args: { tenantId: string; releaseId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>

releasesPromotionGet

Read how internal releases reach stable (automatic after a soak, or by hand)

• Request: GET on /v1/tenants/{tenantId}/release-promotion

releasesPromotionGet(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>

releasesPromotionPut

Change how internal releases reach stable (release class)

• Request: PUT on /v1/tenants/{tenantId}/release-promotion
• Needs an approval for agents: class release_promotion

releasesPromotionPut(args: { tenantId: string; body: PutReleasePromotionRequest }, options?: CallOptions): Promise<Record<string, unknown>>

releasesPublish

Publish a signed release (release class)

• Request: POST on /v1/tenants/{tenantId}/releases
• Needs an approval for agents: class release_promotion

releasesPublish(args: { tenantId: string; body: PublishReleaseRequest }, options?: CallOptions): Promise<Record<string, unknown>>

releasesWithdraw

Withdraw a release (release class)

• Request: POST on /v1/tenants/{tenantId}/releases/{releaseId}/withdraw
• Needs an approval for agents: class release_promotion

releasesWithdraw(args: { tenantId: string; releaseId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<Record<string, unknown>>