UNPKG

@vercel/sdk

Version:

<p align="center"> <a href="https://vercel.com"> <img src="https://assets.vercel.com/image/upload/v1588805858/repositories/vercel/logo.png" height="96"> <h3 align="center">Vercel</h3> </a> <p align="center">Develop. Preview. Ship.</p> </p>

80 lines 3.84 kB
import * as z from "zod/v3"; import { Result as SafeParseResult } from "../types/fp.js"; import { SDKValidationError } from "./sdkvalidationerror.js"; export type GetRollingReleaseConfigRequest = { /** * Project ID or project name (URL-encoded) */ idOrName: string; /** * The Team identifier to perform the request on behalf of. */ teamId?: string | undefined; /** * The Team slug to perform the request on behalf of. */ slug?: string | undefined; }; /** * An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. */ export type GetRollingReleaseConfigStages = { /** * The percentage of traffic to serve to the canary deployment (0-100) */ targetPercentage: number; /** * Whether or not this stage requires manual approval to proceed */ requireApproval?: boolean | undefined; /** * Duration in minutes for automatic advancement to the next stage */ duration?: number | undefined; /** * Whether to linearly shift traffic over the duration of this stage */ linearShift?: boolean | undefined; }; /** * Project-level rolling release configuration that defines how deployments should be gradually rolled out */ export type GetRollingReleaseConfigRollingRelease = { /** * The environment that the release targets, currently only supports production. Adding in case we want to configure with alias groups or custom environments. */ target: string; /** * An array of all the stages required during a deployment release. Each stage defines a target percentage and advancement rules. The final stage must always have targetPercentage: 100. */ stages?: Array<GetRollingReleaseConfigStages> | null | undefined; /** * Whether the request served by a canary deployment should return a header indicating a canary was served. Defaults to `false` when omitted. */ canaryResponseHeader?: boolean | undefined; }; export type GetRollingReleaseConfigResponseBody = { /** * Project-level rolling release configuration that defines how deployments should be gradually rolled out */ rollingRelease: GetRollingReleaseConfigRollingRelease | null; }; /** @internal */ export type GetRollingReleaseConfigRequest$Outbound = { idOrName: string; teamId?: string | undefined; slug?: string | undefined; }; /** @internal */ export declare const GetRollingReleaseConfigRequest$outboundSchema: z.ZodType<GetRollingReleaseConfigRequest$Outbound, z.ZodTypeDef, GetRollingReleaseConfigRequest>; export declare function getRollingReleaseConfigRequestToJSON(getRollingReleaseConfigRequest: GetRollingReleaseConfigRequest): string; /** @internal */ export declare const GetRollingReleaseConfigStages$inboundSchema: z.ZodType<GetRollingReleaseConfigStages, z.ZodTypeDef, unknown>; export declare function getRollingReleaseConfigStagesFromJSON(jsonString: string): SafeParseResult<GetRollingReleaseConfigStages, SDKValidationError>; /** @internal */ export declare const GetRollingReleaseConfigRollingRelease$inboundSchema: z.ZodType<GetRollingReleaseConfigRollingRelease, z.ZodTypeDef, unknown>; export declare function getRollingReleaseConfigRollingReleaseFromJSON(jsonString: string): SafeParseResult<GetRollingReleaseConfigRollingRelease, SDKValidationError>; /** @internal */ export declare const GetRollingReleaseConfigResponseBody$inboundSchema: z.ZodType<GetRollingReleaseConfigResponseBody, z.ZodTypeDef, unknown>; export declare function getRollingReleaseConfigResponseBodyFromJSON(jsonString: string): SafeParseResult<GetRollingReleaseConfigResponseBody, SDKValidationError>; //# sourceMappingURL=getrollingreleaseconfigop.d.ts.map