@northflank/js-client 0.7.1-beta.0 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api-client.d.ts +749 -384
- package/dist/cjs/api-client.js +1 -1
- package/dist/esm/api-client.d.ts +749 -384
- package/dist/esm/api-client.js +1 -1
- package/package.json +1 -1
package/dist/cjs/api-client.d.ts
CHANGED
|
@@ -59,6 +59,7 @@ declare type PortForwardingInfo = {
|
|
|
59
59
|
portName?: string;
|
|
60
60
|
protocol?: 'HTTP' | 'TCP' | 'UDP';
|
|
61
61
|
hostnames: string[];
|
|
62
|
+
ipOnly: boolean;
|
|
62
63
|
};
|
|
63
64
|
interface PortTunnel extends EventEmitter {
|
|
64
65
|
readonly bindTo?: {
|
|
@@ -211,7 +212,7 @@ declare type ListServicesResult = {
|
|
|
211
212
|
/** Details about the current deployment status. */
|
|
212
213
|
'deployment'?: {
|
|
213
214
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
214
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
215
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
215
216
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
216
217
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
217
218
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -747,6 +748,10 @@ declare type CreateAddonData = {
|
|
|
747
748
|
}[];
|
|
748
749
|
/** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
|
|
749
750
|
'pitrEnabled'?: boolean;
|
|
751
|
+
'typeSpecificSettings'?: {
|
|
752
|
+
/** Postgres only: enable high-availability mode. */
|
|
753
|
+
'postgresHAEnabled'?: boolean;
|
|
754
|
+
};
|
|
750
755
|
};
|
|
751
756
|
/** Creates a new addon */
|
|
752
757
|
declare class CreateAddonEndpoint extends PostApiEndpoint<CreateAddonRequest, CreateAddonResult> {
|
|
@@ -796,6 +801,10 @@ declare type PutAddonResult = {
|
|
|
796
801
|
}[];
|
|
797
802
|
/** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
|
|
798
803
|
'pitrEnabled'?: boolean;
|
|
804
|
+
'typeSpecificSettings'?: {
|
|
805
|
+
/** Postgres only: enable high-availability mode. */
|
|
806
|
+
'postgresHAEnabled'?: boolean;
|
|
807
|
+
};
|
|
799
808
|
/** Identifier for the addon. Example: "example-addon" */
|
|
800
809
|
'id': string;
|
|
801
810
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -854,6 +863,10 @@ declare type PutAddonData = {
|
|
|
854
863
|
}[];
|
|
855
864
|
/** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
|
|
856
865
|
'pitrEnabled'?: boolean;
|
|
866
|
+
'typeSpecificSettings'?: {
|
|
867
|
+
/** Postgres only: enable high-availability mode. */
|
|
868
|
+
'postgresHAEnabled'?: boolean;
|
|
869
|
+
};
|
|
857
870
|
};
|
|
858
871
|
/** Creates or updates an addon */
|
|
859
872
|
declare class PutAddonEndpoint extends PutApiEndpoint<PutAddonRequest, PutAddonResult> {
|
|
@@ -974,6 +987,10 @@ declare type PatchAddonResult = {
|
|
|
974
987
|
}[];
|
|
975
988
|
/** Enables point-in-time recovery (PITR) for the addon (if supported by the addon type). */
|
|
976
989
|
'pitrEnabled'?: boolean;
|
|
990
|
+
'typeSpecificSettings'?: {
|
|
991
|
+
/** Postgres only: enable high-availability mode. */
|
|
992
|
+
'postgresHAEnabled'?: boolean;
|
|
993
|
+
};
|
|
977
994
|
/** Identifier for the addon. Example: "example-addon" */
|
|
978
995
|
'id': string;
|
|
979
996
|
/** Full identifier used for deployment Example: "/example-user/default-project/example-addon" */
|
|
@@ -2488,9 +2505,9 @@ declare type CreateClusterData = {
|
|
|
2488
2505
|
'description'?: string;
|
|
2489
2506
|
/** Cloud provider to be used for the selected resource Example: "gcp" */
|
|
2490
2507
|
'provider': 'gcp' | 'aws' | 'azure' | 'do';
|
|
2491
|
-
/** Region of the cluster. */
|
|
2508
|
+
/** Region of the cluster. Example: "europe-west2" */
|
|
2492
2509
|
'region': string;
|
|
2493
|
-
/** Kubernetes version of the cluster. */
|
|
2510
|
+
/** Kubernetes version of the cluster. Example: "1.23.8" */
|
|
2494
2511
|
'kubernetesVersion': string;
|
|
2495
2512
|
/** Existing integration to use for this cluster. Example: "gcp-integration" */
|
|
2496
2513
|
'integrationId'?: string;
|
|
@@ -2528,9 +2545,40 @@ declare type CreateClusterData = {
|
|
|
2528
2545
|
/** Zones in which the node pool should be provisioned. */
|
|
2529
2546
|
'availabilityZones'?: string[];
|
|
2530
2547
|
}[];
|
|
2548
|
+
'settings': {
|
|
2549
|
+
/** Determines if builds are run on Northflank infrastructure */
|
|
2550
|
+
'useNorthflankBuilder'?: boolean;
|
|
2551
|
+
'builds'?: {
|
|
2552
|
+
/** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
|
|
2553
|
+
'plan'?: string;
|
|
2554
|
+
};
|
|
2555
|
+
/** Request modifiers to use for different resources. */
|
|
2556
|
+
'requestModifiers'?: {
|
|
2557
|
+
/** Request modifiers for services */
|
|
2558
|
+
'services'?: {
|
|
2559
|
+
'cpu': number;
|
|
2560
|
+
'memory': number;
|
|
2561
|
+
};
|
|
2562
|
+
/** Request modifiers for jobs */
|
|
2563
|
+
'jobs'?: {
|
|
2564
|
+
'cpu': number;
|
|
2565
|
+
'memory': number;
|
|
2566
|
+
};
|
|
2567
|
+
/** Request modifiers for builds */
|
|
2568
|
+
'builds'?: {
|
|
2569
|
+
'cpu': number;
|
|
2570
|
+
'memory': number;
|
|
2571
|
+
};
|
|
2572
|
+
/** Request modifiers for addons */
|
|
2573
|
+
'addons'?: {
|
|
2574
|
+
'cpu': number;
|
|
2575
|
+
'memory': number;
|
|
2576
|
+
};
|
|
2577
|
+
};
|
|
2578
|
+
};
|
|
2531
2579
|
/** GCP specific data. Required when `provider` is `gcp`. */
|
|
2532
2580
|
'gcp'?: {
|
|
2533
|
-
/** ID of the GCP project the cluster will be provisioned in. */
|
|
2581
|
+
/** ID of the GCP project the cluster will be provisioned in. Example: "example-project-id" */
|
|
2534
2582
|
'projectId': string;
|
|
2535
2583
|
};
|
|
2536
2584
|
};
|
|
@@ -2664,7 +2712,7 @@ declare type UpdateClusterParameters = {
|
|
|
2664
2712
|
declare type UpdateClusterData = {
|
|
2665
2713
|
/** The description of the cluster. Example: "This is an updated description." */
|
|
2666
2714
|
'description'?: string;
|
|
2667
|
-
'nodePools'
|
|
2715
|
+
'nodePools'?: {
|
|
2668
2716
|
/** Machine type to be used by the node pool. Example: "n2-standard-8" */
|
|
2669
2717
|
'nodeType': string;
|
|
2670
2718
|
/** Number of nodes to the node pool should be provisioned with. Example: 3 */
|
|
@@ -2688,6 +2736,37 @@ declare type UpdateClusterData = {
|
|
|
2688
2736
|
/** ID of existing node pool. Must be passed when modifying existing node pools. Not relevant for new node pools Example: "6aa96121-0345-43ad-bade-af36d540c222" */
|
|
2689
2737
|
'id'?: string;
|
|
2690
2738
|
}[];
|
|
2739
|
+
'settings'?: {
|
|
2740
|
+
/** Determines if builds are run on Northflank infrastructure */
|
|
2741
|
+
'useNorthflankBuilder'?: boolean;
|
|
2742
|
+
'builds'?: {
|
|
2743
|
+
/** Plan to use for builds if they are run on the cluster Example: "nf-compute-200" */
|
|
2744
|
+
'plan'?: string;
|
|
2745
|
+
};
|
|
2746
|
+
/** Request modifiers to use for different resources. */
|
|
2747
|
+
'requestModifiers'?: {
|
|
2748
|
+
/** Request modifiers for services */
|
|
2749
|
+
'services'?: {
|
|
2750
|
+
'cpu': number;
|
|
2751
|
+
'memory': number;
|
|
2752
|
+
};
|
|
2753
|
+
/** Request modifiers for jobs */
|
|
2754
|
+
'jobs'?: {
|
|
2755
|
+
'cpu': number;
|
|
2756
|
+
'memory': number;
|
|
2757
|
+
};
|
|
2758
|
+
/** Request modifiers for builds */
|
|
2759
|
+
'builds'?: {
|
|
2760
|
+
'cpu': number;
|
|
2761
|
+
'memory': number;
|
|
2762
|
+
};
|
|
2763
|
+
/** Request modifiers for addons */
|
|
2764
|
+
'addons'?: {
|
|
2765
|
+
'cpu': number;
|
|
2766
|
+
'memory': number;
|
|
2767
|
+
};
|
|
2768
|
+
};
|
|
2769
|
+
};
|
|
2691
2770
|
};
|
|
2692
2771
|
/** Update an existing cluster. */
|
|
2693
2772
|
declare class UpdateClusterEndpoint extends PostApiEndpoint<UpdateClusterRequest, UpdateClusterResult> {
|
|
@@ -2795,6 +2874,12 @@ declare type GetJobResult = {
|
|
|
2795
2874
|
'buildConfiguration'?: {
|
|
2796
2875
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
2797
2876
|
'pathIgnoreRules'?: string[];
|
|
2877
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
2878
|
+
'isAllowList'?: boolean;
|
|
2879
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
2880
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
2881
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
2882
|
+
'ciIgnoreFlags'?: string[];
|
|
2798
2883
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
2799
2884
|
'dockerfileTarget'?: string;
|
|
2800
2885
|
/** Include .git folder inside the build context */
|
|
@@ -2949,6 +3034,12 @@ declare type CreateJobManualResult = {
|
|
|
2949
3034
|
'buildConfiguration'?: {
|
|
2950
3035
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
2951
3036
|
'pathIgnoreRules'?: string[];
|
|
3037
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3038
|
+
'isAllowList'?: boolean;
|
|
3039
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3040
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3041
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3042
|
+
'ciIgnoreFlags'?: string[];
|
|
2952
3043
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
2953
3044
|
'dockerfileTarget'?: string;
|
|
2954
3045
|
/** Include .git folder inside the build context */
|
|
@@ -3169,6 +3260,12 @@ declare type CreateJobManualData = {
|
|
|
3169
3260
|
'buildConfiguration'?: {
|
|
3170
3261
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3171
3262
|
'pathIgnoreRules'?: string[];
|
|
3263
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3264
|
+
'isAllowList'?: boolean;
|
|
3265
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3266
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3267
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3268
|
+
'ciIgnoreFlags'?: string[];
|
|
3172
3269
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3173
3270
|
'dockerfileTarget'?: string;
|
|
3174
3271
|
/** Include .git folder inside the build context */
|
|
@@ -3180,12 +3277,12 @@ declare type CreateJobManualData = {
|
|
|
3180
3277
|
'dockerfile': {
|
|
3181
3278
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3182
3279
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3183
|
-
/** Should intermediate image layers be cached? */
|
|
3184
|
-
'useCache'?: boolean;
|
|
3185
3280
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3186
3281
|
'dockerFilePath': string;
|
|
3187
3282
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
3188
3283
|
'dockerWorkDir': string;
|
|
3284
|
+
/** Should intermediate image layers be cached? */
|
|
3285
|
+
'useCache'?: boolean;
|
|
3189
3286
|
};
|
|
3190
3287
|
} | {
|
|
3191
3288
|
'buildpack': {
|
|
@@ -3314,6 +3411,12 @@ declare type PutJobManualResult = {
|
|
|
3314
3411
|
'buildConfiguration'?: {
|
|
3315
3412
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3316
3413
|
'pathIgnoreRules'?: string[];
|
|
3414
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3415
|
+
'isAllowList'?: boolean;
|
|
3416
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3417
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3418
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3419
|
+
'ciIgnoreFlags'?: string[];
|
|
3317
3420
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3318
3421
|
'dockerfileTarget'?: string;
|
|
3319
3422
|
/** Include .git folder inside the build context */
|
|
@@ -3325,12 +3428,12 @@ declare type PutJobManualResult = {
|
|
|
3325
3428
|
'dockerfile': {
|
|
3326
3429
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3327
3430
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3328
|
-
/** Should intermediate image layers be cached? */
|
|
3329
|
-
'useCache'?: boolean;
|
|
3330
3431
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3331
3432
|
'dockerFilePath': string;
|
|
3332
3433
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
3333
3434
|
'dockerWorkDir': string;
|
|
3435
|
+
/** Should intermediate image layers be cached? */
|
|
3436
|
+
'useCache'?: boolean;
|
|
3334
3437
|
};
|
|
3335
3438
|
} | {
|
|
3336
3439
|
'buildpack': {
|
|
@@ -3533,6 +3636,12 @@ declare type PutJobManualData = {
|
|
|
3533
3636
|
'buildConfiguration'?: {
|
|
3534
3637
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3535
3638
|
'pathIgnoreRules'?: string[];
|
|
3639
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3640
|
+
'isAllowList'?: boolean;
|
|
3641
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3642
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3643
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3644
|
+
'ciIgnoreFlags'?: string[];
|
|
3536
3645
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3537
3646
|
'dockerfileTarget'?: string;
|
|
3538
3647
|
/** Include .git folder inside the build context */
|
|
@@ -3544,12 +3653,12 @@ declare type PutJobManualData = {
|
|
|
3544
3653
|
'dockerfile': {
|
|
3545
3654
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3546
3655
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3547
|
-
/** Should intermediate image layers be cached? */
|
|
3548
|
-
'useCache'?: boolean;
|
|
3549
3656
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3550
3657
|
'dockerFilePath': string;
|
|
3551
3658
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
3552
3659
|
'dockerWorkDir': string;
|
|
3660
|
+
/** Should intermediate image layers be cached? */
|
|
3661
|
+
'useCache'?: boolean;
|
|
3553
3662
|
};
|
|
3554
3663
|
} | {
|
|
3555
3664
|
'buildpack': {
|
|
@@ -3678,6 +3787,12 @@ declare type PatchJobManualResult = {
|
|
|
3678
3787
|
'buildConfiguration'?: {
|
|
3679
3788
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3680
3789
|
'pathIgnoreRules'?: string[];
|
|
3790
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3791
|
+
'isAllowList'?: boolean;
|
|
3792
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3793
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3794
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3795
|
+
'ciIgnoreFlags'?: string[];
|
|
3681
3796
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3682
3797
|
'dockerfileTarget'?: string;
|
|
3683
3798
|
/** Include .git folder inside the build context */
|
|
@@ -3689,12 +3804,12 @@ declare type PatchJobManualResult = {
|
|
|
3689
3804
|
'dockerfile': {
|
|
3690
3805
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3691
3806
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3692
|
-
/** Should intermediate image layers be cached? */
|
|
3693
|
-
'useCache'?: boolean;
|
|
3694
3807
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3695
3808
|
'dockerFilePath': string;
|
|
3696
3809
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
3697
3810
|
'dockerWorkDir': string;
|
|
3811
|
+
/** Should intermediate image layers be cached? */
|
|
3812
|
+
'useCache'?: boolean;
|
|
3698
3813
|
};
|
|
3699
3814
|
} | {
|
|
3700
3815
|
'buildpack': {
|
|
@@ -3786,17 +3901,23 @@ declare type PatchJobManualData = {
|
|
|
3786
3901
|
'buildConfiguration'?: {
|
|
3787
3902
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3788
3903
|
'pathIgnoreRules'?: string[];
|
|
3904
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
3905
|
+
'isAllowList'?: boolean;
|
|
3906
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
3907
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
3908
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
3909
|
+
'ciIgnoreFlags'?: string[];
|
|
3789
3910
|
};
|
|
3790
3911
|
'buildSettings'?: {
|
|
3791
3912
|
'dockerfile'?: {
|
|
3792
3913
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
3793
3914
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
3794
|
-
/** Should intermediate image layers be cached? */
|
|
3795
|
-
'useCache'?: boolean;
|
|
3796
3915
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
3797
3916
|
'dockerFilePath'?: string;
|
|
3798
3917
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
3799
3918
|
'dockerWorkDir'?: string;
|
|
3919
|
+
/** Should intermediate image layers be cached? */
|
|
3920
|
+
'useCache'?: boolean;
|
|
3800
3921
|
};
|
|
3801
3922
|
'buildpack'?: {
|
|
3802
3923
|
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
@@ -3882,6 +4003,12 @@ declare type CreateJobCronResult = {
|
|
|
3882
4003
|
'buildConfiguration'?: {
|
|
3883
4004
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
3884
4005
|
'pathIgnoreRules'?: string[];
|
|
4006
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4007
|
+
'isAllowList'?: boolean;
|
|
4008
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4009
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4010
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4011
|
+
'ciIgnoreFlags'?: string[];
|
|
3885
4012
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
3886
4013
|
'dockerfileTarget'?: string;
|
|
3887
4014
|
/** Include .git folder inside the build context */
|
|
@@ -4108,6 +4235,12 @@ declare type CreateJobCronData = {
|
|
|
4108
4235
|
'buildConfiguration'?: {
|
|
4109
4236
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4110
4237
|
'pathIgnoreRules'?: string[];
|
|
4238
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4239
|
+
'isAllowList'?: boolean;
|
|
4240
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4241
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4242
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4243
|
+
'ciIgnoreFlags'?: string[];
|
|
4111
4244
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4112
4245
|
'dockerfileTarget'?: string;
|
|
4113
4246
|
/** Include .git folder inside the build context */
|
|
@@ -4119,12 +4252,12 @@ declare type CreateJobCronData = {
|
|
|
4119
4252
|
'dockerfile': {
|
|
4120
4253
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4121
4254
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4122
|
-
/** Should intermediate image layers be cached? */
|
|
4123
|
-
'useCache'?: boolean;
|
|
4124
4255
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4125
4256
|
'dockerFilePath': string;
|
|
4126
4257
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
4127
4258
|
'dockerWorkDir': string;
|
|
4259
|
+
/** Should intermediate image layers be cached? */
|
|
4260
|
+
'useCache'?: boolean;
|
|
4128
4261
|
};
|
|
4129
4262
|
} | {
|
|
4130
4263
|
'buildpack': {
|
|
@@ -4257,6 +4390,12 @@ declare type PutJobCronResult = {
|
|
|
4257
4390
|
'buildConfiguration'?: {
|
|
4258
4391
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4259
4392
|
'pathIgnoreRules'?: string[];
|
|
4393
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4394
|
+
'isAllowList'?: boolean;
|
|
4395
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4396
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4397
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4398
|
+
'ciIgnoreFlags'?: string[];
|
|
4260
4399
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4261
4400
|
'dockerfileTarget'?: string;
|
|
4262
4401
|
/** Include .git folder inside the build context */
|
|
@@ -4268,12 +4407,12 @@ declare type PutJobCronResult = {
|
|
|
4268
4407
|
'dockerfile': {
|
|
4269
4408
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4270
4409
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4271
|
-
/** Should intermediate image layers be cached? */
|
|
4272
|
-
'useCache'?: boolean;
|
|
4273
4410
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4274
4411
|
'dockerFilePath': string;
|
|
4275
4412
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
4276
4413
|
'dockerWorkDir': string;
|
|
4414
|
+
/** Should intermediate image layers be cached? */
|
|
4415
|
+
'useCache'?: boolean;
|
|
4277
4416
|
};
|
|
4278
4417
|
} | {
|
|
4279
4418
|
'buildpack': {
|
|
@@ -4480,6 +4619,12 @@ declare type PutJobCronData = {
|
|
|
4480
4619
|
'buildConfiguration'?: {
|
|
4481
4620
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4482
4621
|
'pathIgnoreRules'?: string[];
|
|
4622
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4623
|
+
'isAllowList'?: boolean;
|
|
4624
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4625
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4626
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4627
|
+
'ciIgnoreFlags'?: string[];
|
|
4483
4628
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4484
4629
|
'dockerfileTarget'?: string;
|
|
4485
4630
|
/** Include .git folder inside the build context */
|
|
@@ -4491,12 +4636,12 @@ declare type PutJobCronData = {
|
|
|
4491
4636
|
'dockerfile': {
|
|
4492
4637
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4493
4638
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4494
|
-
/** Should intermediate image layers be cached? */
|
|
4495
|
-
'useCache'?: boolean;
|
|
4496
4639
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4497
4640
|
'dockerFilePath': string;
|
|
4498
4641
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
4499
4642
|
'dockerWorkDir': string;
|
|
4643
|
+
/** Should intermediate image layers be cached? */
|
|
4644
|
+
'useCache'?: boolean;
|
|
4500
4645
|
};
|
|
4501
4646
|
} | {
|
|
4502
4647
|
'buildpack': {
|
|
@@ -4629,6 +4774,12 @@ declare type PatchJobCronResult = {
|
|
|
4629
4774
|
'buildConfiguration'?: {
|
|
4630
4775
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4631
4776
|
'pathIgnoreRules'?: string[];
|
|
4777
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4778
|
+
'isAllowList'?: boolean;
|
|
4779
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4780
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4781
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4782
|
+
'ciIgnoreFlags'?: string[];
|
|
4632
4783
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
4633
4784
|
'dockerfileTarget'?: string;
|
|
4634
4785
|
/** Include .git folder inside the build context */
|
|
@@ -4640,12 +4791,12 @@ declare type PatchJobCronResult = {
|
|
|
4640
4791
|
'dockerfile': {
|
|
4641
4792
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4642
4793
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4643
|
-
/** Should intermediate image layers be cached? */
|
|
4644
|
-
'useCache'?: boolean;
|
|
4645
4794
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4646
4795
|
'dockerFilePath': string;
|
|
4647
4796
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
4648
4797
|
'dockerWorkDir': string;
|
|
4798
|
+
/** Should intermediate image layers be cached? */
|
|
4799
|
+
'useCache'?: boolean;
|
|
4649
4800
|
};
|
|
4650
4801
|
} | {
|
|
4651
4802
|
'buildpack': {
|
|
@@ -4741,17 +4892,23 @@ declare type PatchJobCronData = {
|
|
|
4741
4892
|
'buildConfiguration'?: {
|
|
4742
4893
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
4743
4894
|
'pathIgnoreRules'?: string[];
|
|
4895
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
4896
|
+
'isAllowList'?: boolean;
|
|
4897
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
4898
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
4899
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
4900
|
+
'ciIgnoreFlags'?: string[];
|
|
4744
4901
|
};
|
|
4745
4902
|
'buildSettings'?: {
|
|
4746
4903
|
'dockerfile'?: {
|
|
4747
4904
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
4748
4905
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
4749
|
-
/** Should intermediate image layers be cached? */
|
|
4750
|
-
'useCache'?: boolean;
|
|
4751
4906
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
4752
4907
|
'dockerFilePath'?: string;
|
|
4753
4908
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
4754
4909
|
'dockerWorkDir'?: string;
|
|
4910
|
+
/** Should intermediate image layers be cached? */
|
|
4911
|
+
'useCache'?: boolean;
|
|
4755
4912
|
};
|
|
4756
4913
|
'buildpack'?: {
|
|
4757
4914
|
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
@@ -5441,6 +5598,12 @@ declare type UpdateJobBuildoptionsData = {
|
|
|
5441
5598
|
};
|
|
5442
5599
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
5443
5600
|
'pathIgnoreRules'?: string[];
|
|
5601
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
5602
|
+
'isAllowList'?: boolean;
|
|
5603
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
5604
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
5605
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
5606
|
+
'ciIgnoreFlags'?: string[];
|
|
5444
5607
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
5445
5608
|
'dockerfileTarget'?: string;
|
|
5446
5609
|
/** Include .git folder inside the build context */
|
|
@@ -5460,9 +5623,21 @@ declare type UpdateJobBuildoptionsData = {
|
|
|
5460
5623
|
};
|
|
5461
5624
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
5462
5625
|
'pathIgnoreRules'?: string[];
|
|
5626
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
5627
|
+
'isAllowList'?: boolean;
|
|
5628
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
5629
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
5630
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
5631
|
+
'ciIgnoreFlags'?: string[];
|
|
5463
5632
|
} | {
|
|
5464
5633
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
5465
5634
|
'pathIgnoreRules'?: string[];
|
|
5635
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
5636
|
+
'isAllowList'?: boolean;
|
|
5637
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
5638
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
5639
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
5640
|
+
'ciIgnoreFlags'?: string[];
|
|
5466
5641
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
5467
5642
|
'dockerfileTarget'?: string;
|
|
5468
5643
|
/** Include .git folder inside the build context */
|
|
@@ -6106,6 +6281,8 @@ declare type ListLogsinksResult = {
|
|
|
6106
6281
|
'logSinks': {
|
|
6107
6282
|
/** Name of the log sink. Example: "example-log-sink" */
|
|
6108
6283
|
'name': string;
|
|
6284
|
+
/** Identifier for the Log Sink Example: "example-project" */
|
|
6285
|
+
'id': string;
|
|
6109
6286
|
/** Description of the log sink. Example: "This is an example log sink." */
|
|
6110
6287
|
'description'?: string;
|
|
6111
6288
|
/** If `true`, only logs from the projects in `projects` will be sent to the log sink. Example: true */
|
|
@@ -6371,6 +6548,8 @@ declare class CreateLogsinkEndpoint extends PostApiEndpoint<CreateLogsinkRequest
|
|
|
6371
6548
|
declare type GetLogsinkResult = {
|
|
6372
6549
|
/** Name of the log sink. Example: "example-log-sink" */
|
|
6373
6550
|
'name': string;
|
|
6551
|
+
/** Identifier for the Log Sink Example: "example-project" */
|
|
6552
|
+
'id': string;
|
|
6374
6553
|
/** Description of the log sink. Example: "This is an example log sink." */
|
|
6375
6554
|
'description'?: string;
|
|
6376
6555
|
/** If `true`, only logs from the projects in `projects` will be sent to the log sink. Example: true */
|
|
@@ -6406,7 +6585,58 @@ declare type GetLogsinkResult = {
|
|
|
6406
6585
|
'default_api_key': string;
|
|
6407
6586
|
/** The Datadog region. Example: "eu" */
|
|
6408
6587
|
'region': 'eu' | 'us' | 'us3' | 'us5';
|
|
6409
|
-
} | any
|
|
6588
|
+
} | any | {
|
|
6589
|
+
/** Uri to send logs to. Example: "my.log-collector.com" */
|
|
6590
|
+
'uri': string;
|
|
6591
|
+
/** Encoding options */
|
|
6592
|
+
'encoding'?: {
|
|
6593
|
+
/** Codec to encode logs in Example: "json" */
|
|
6594
|
+
'codec': 'text' | 'json';
|
|
6595
|
+
};
|
|
6596
|
+
'auth': {
|
|
6597
|
+
/** No authentication strategy Example: "none" */
|
|
6598
|
+
'strategy': 'none';
|
|
6599
|
+
} | {
|
|
6600
|
+
/** Basic HTTP authentication strategy. Example: "basic" */
|
|
6601
|
+
'strategy': 'basic';
|
|
6602
|
+
/** Username for basic http authentication. Example: "my-user" */
|
|
6603
|
+
'user'?: string;
|
|
6604
|
+
/** Password for basic http authentication. Example: "secret-password" */
|
|
6605
|
+
'password': string;
|
|
6606
|
+
} | {
|
|
6607
|
+
/** Bearer token authentication strategy. Example: "bearer" */
|
|
6608
|
+
'strategy': 'bearer';
|
|
6609
|
+
/** Token for bearer token authentication. Example: "my-token" */
|
|
6610
|
+
'token'?: string;
|
|
6611
|
+
};
|
|
6612
|
+
} | {
|
|
6613
|
+
/** Endpoint for the AWS S3 or compatible API bucket. Example: "my.bucket.com" */
|
|
6614
|
+
'endpoint': string;
|
|
6615
|
+
/** Region of the S3 bucket. Example: "eu-west-2" */
|
|
6616
|
+
'region': 'eu-west-1' | 'eu-west-2' | 'eu-west-3' | 'eu-central-1' | 'eu-south-1' | 'eu-north-1' | 'us-west-1' | 'us-west-2' | 'us-east-1' | 'us-east2';
|
|
6617
|
+
/** Authentication object. */
|
|
6618
|
+
'auth'?: {
|
|
6619
|
+
/** Access key id for the bucket. Example: "PMSACIHNUIASDBWQDS" */
|
|
6620
|
+
'accessKeyId': string;
|
|
6621
|
+
/** Secret access key for the bucket. Example: "HA1PLMNOEAEYUHAJQMSDUJQS" */
|
|
6622
|
+
'secretAccessKey': string;
|
|
6623
|
+
};
|
|
6624
|
+
/** Name of the S3 Bucket. Example: "northflank-logs" */
|
|
6625
|
+
'bucket': string;
|
|
6626
|
+
/** Log file compression method. Example: "gzip" */
|
|
6627
|
+
'compression': 'gzip' | 'none';
|
|
6628
|
+
} | {
|
|
6629
|
+
/** Logtail Source Token Example: "vhnqrLygVQ5GnSQUTZamKvAq" */
|
|
6630
|
+
'token': string;
|
|
6631
|
+
} | {
|
|
6632
|
+
/** Ingestion Key Example: "b1dd3feb585asd1a3e9edpo9kmn5e590hg9" */
|
|
6633
|
+
'api_key': string;
|
|
6634
|
+
} | {
|
|
6635
|
+
/** Honeycomb API Key Example: "b1dd3feb585asd1a3e9" */
|
|
6636
|
+
'api_key': string;
|
|
6637
|
+
/** Name of the dataset Example: "staging-logs" */
|
|
6638
|
+
'dataset': string;
|
|
6639
|
+
};
|
|
6410
6640
|
};
|
|
6411
6641
|
declare type GetLogsinkCall = (opts: GetLogsinkRequest) => Promise<ApiCallResponse<GetLogsinkResult>>;
|
|
6412
6642
|
declare type GetLogsinkRequest = {
|
|
@@ -7866,7 +8096,7 @@ declare type CreateServiceCombinedResult = {
|
|
|
7866
8096
|
/** Details about the current deployment status. */
|
|
7867
8097
|
'deployment'?: {
|
|
7868
8098
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
7869
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
8099
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
7870
8100
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
7871
8101
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
7872
8102
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -7944,6 +8174,12 @@ declare type CreateServiceCombinedResult = {
|
|
|
7944
8174
|
'buildConfiguration': {
|
|
7945
8175
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
7946
8176
|
'pathIgnoreRules'?: string[];
|
|
8177
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
8178
|
+
'isAllowList'?: boolean;
|
|
8179
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
8180
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
8181
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
8182
|
+
'ciIgnoreFlags'?: string[];
|
|
7947
8183
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
7948
8184
|
'dockerfileTarget'?: string;
|
|
7949
8185
|
/** Include .git folder inside the build context */
|
|
@@ -8025,6 +8261,10 @@ declare type CreateServiceCombinedData = {
|
|
|
8025
8261
|
'storageSize'?: number;
|
|
8026
8262
|
};
|
|
8027
8263
|
};
|
|
8264
|
+
'strategy'?: {
|
|
8265
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
8266
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
8267
|
+
};
|
|
8028
8268
|
};
|
|
8029
8269
|
'ports'?: {
|
|
8030
8270
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -8074,12 +8314,12 @@ declare type CreateServiceCombinedData = {
|
|
|
8074
8314
|
'dockerfile': {
|
|
8075
8315
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
8076
8316
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
8077
|
-
/** Should intermediate image layers be cached? */
|
|
8078
|
-
'useCache'?: boolean;
|
|
8079
8317
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
8080
8318
|
'dockerFilePath': string;
|
|
8081
8319
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
8082
8320
|
'dockerWorkDir': string;
|
|
8321
|
+
/** Should intermediate image layers be cached? */
|
|
8322
|
+
'useCache'?: boolean;
|
|
8083
8323
|
};
|
|
8084
8324
|
} | {
|
|
8085
8325
|
'buildpack': {
|
|
@@ -8096,6 +8336,12 @@ declare type CreateServiceCombinedData = {
|
|
|
8096
8336
|
'buildConfiguration'?: {
|
|
8097
8337
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8098
8338
|
'pathIgnoreRules'?: string[];
|
|
8339
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
8340
|
+
'isAllowList'?: boolean;
|
|
8341
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
8342
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
8343
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
8344
|
+
'ciIgnoreFlags'?: string[];
|
|
8099
8345
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
8100
8346
|
'dockerfileTarget'?: string;
|
|
8101
8347
|
/** Include .git folder inside the build context */
|
|
@@ -8182,6 +8428,10 @@ declare type PutServiceCombinedResult = {
|
|
|
8182
8428
|
'storageSize'?: number;
|
|
8183
8429
|
};
|
|
8184
8430
|
};
|
|
8431
|
+
'strategy'?: {
|
|
8432
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
8433
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
8434
|
+
};
|
|
8185
8435
|
};
|
|
8186
8436
|
'ports'?: {
|
|
8187
8437
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -8231,12 +8481,12 @@ declare type PutServiceCombinedResult = {
|
|
|
8231
8481
|
'dockerfile': {
|
|
8232
8482
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
8233
8483
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
8234
|
-
/** Should intermediate image layers be cached? */
|
|
8235
|
-
'useCache'?: boolean;
|
|
8236
8484
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
8237
8485
|
'dockerFilePath': string;
|
|
8238
8486
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
8239
8487
|
'dockerWorkDir': string;
|
|
8488
|
+
/** Should intermediate image layers be cached? */
|
|
8489
|
+
'useCache'?: boolean;
|
|
8240
8490
|
};
|
|
8241
8491
|
} | {
|
|
8242
8492
|
'buildpack': {
|
|
@@ -8253,6 +8503,12 @@ declare type PutServiceCombinedResult = {
|
|
|
8253
8503
|
'buildConfiguration'?: {
|
|
8254
8504
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8255
8505
|
'pathIgnoreRules'?: string[];
|
|
8506
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
8507
|
+
'isAllowList'?: boolean;
|
|
8508
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
8509
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
8510
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
8511
|
+
'ciIgnoreFlags'?: string[];
|
|
8256
8512
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
8257
8513
|
'dockerfileTarget'?: string;
|
|
8258
8514
|
/** Include .git folder inside the build context */
|
|
@@ -8316,7 +8572,7 @@ declare type PutServiceCombinedResult = {
|
|
|
8316
8572
|
/** Details about the current deployment status. */
|
|
8317
8573
|
'deployment'?: {
|
|
8318
8574
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
8319
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
8575
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
8320
8576
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
8321
8577
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
8322
8578
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -8370,6 +8626,10 @@ declare type PutServiceCombinedData = {
|
|
|
8370
8626
|
'storageSize'?: number;
|
|
8371
8627
|
};
|
|
8372
8628
|
};
|
|
8629
|
+
'strategy'?: {
|
|
8630
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
8631
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
8632
|
+
};
|
|
8373
8633
|
};
|
|
8374
8634
|
'ports'?: {
|
|
8375
8635
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -8419,12 +8679,12 @@ declare type PutServiceCombinedData = {
|
|
|
8419
8679
|
'dockerfile': {
|
|
8420
8680
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
8421
8681
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
8422
|
-
/** Should intermediate image layers be cached? */
|
|
8423
|
-
'useCache'?: boolean;
|
|
8424
8682
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
8425
8683
|
'dockerFilePath': string;
|
|
8426
8684
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
8427
8685
|
'dockerWorkDir': string;
|
|
8686
|
+
/** Should intermediate image layers be cached? */
|
|
8687
|
+
'useCache'?: boolean;
|
|
8428
8688
|
};
|
|
8429
8689
|
} | {
|
|
8430
8690
|
'buildpack': {
|
|
@@ -8441,6 +8701,12 @@ declare type PutServiceCombinedData = {
|
|
|
8441
8701
|
'buildConfiguration'?: {
|
|
8442
8702
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8443
8703
|
'pathIgnoreRules'?: string[];
|
|
8704
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
8705
|
+
'isAllowList'?: boolean;
|
|
8706
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
8707
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
8708
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
8709
|
+
'ciIgnoreFlags'?: string[];
|
|
8444
8710
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
8445
8711
|
'dockerfileTarget'?: string;
|
|
8446
8712
|
/** Include .git folder inside the build context */
|
|
@@ -8527,6 +8793,10 @@ declare type PatchServiceCombinedResult = {
|
|
|
8527
8793
|
'storageSize'?: number;
|
|
8528
8794
|
};
|
|
8529
8795
|
};
|
|
8796
|
+
'strategy'?: {
|
|
8797
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
8798
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
8799
|
+
};
|
|
8530
8800
|
};
|
|
8531
8801
|
'ports'?: {
|
|
8532
8802
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -8576,12 +8846,12 @@ declare type PatchServiceCombinedResult = {
|
|
|
8576
8846
|
'dockerfile': {
|
|
8577
8847
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
8578
8848
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
8579
|
-
/** Should intermediate image layers be cached? */
|
|
8580
|
-
'useCache'?: boolean;
|
|
8581
8849
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
8582
8850
|
'dockerFilePath': string;
|
|
8583
8851
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
8584
8852
|
'dockerWorkDir': string;
|
|
8853
|
+
/** Should intermediate image layers be cached? */
|
|
8854
|
+
'useCache'?: boolean;
|
|
8585
8855
|
};
|
|
8586
8856
|
} | {
|
|
8587
8857
|
'buildpack': {
|
|
@@ -8598,6 +8868,12 @@ declare type PatchServiceCombinedResult = {
|
|
|
8598
8868
|
'buildConfiguration'?: {
|
|
8599
8869
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8600
8870
|
'pathIgnoreRules'?: string[];
|
|
8871
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
8872
|
+
'isAllowList'?: boolean;
|
|
8873
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
8874
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
8875
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
8876
|
+
'ciIgnoreFlags'?: string[];
|
|
8601
8877
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
8602
8878
|
'dockerfileTarget'?: string;
|
|
8603
8879
|
/** Include .git folder inside the build context */
|
|
@@ -8661,7 +8937,7 @@ declare type PatchServiceCombinedResult = {
|
|
|
8661
8937
|
/** Details about the current deployment status. */
|
|
8662
8938
|
'deployment'?: {
|
|
8663
8939
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
8664
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
8940
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
8665
8941
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
8666
8942
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
8667
8943
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -8706,6 +8982,10 @@ declare type PatchServiceCombinedData = {
|
|
|
8706
8982
|
'storageSize'?: number;
|
|
8707
8983
|
};
|
|
8708
8984
|
};
|
|
8985
|
+
'strategy'?: {
|
|
8986
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
8987
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
8988
|
+
};
|
|
8709
8989
|
};
|
|
8710
8990
|
'ports'?: {
|
|
8711
8991
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -8755,12 +9035,12 @@ declare type PatchServiceCombinedData = {
|
|
|
8755
9035
|
'dockerfile'?: {
|
|
8756
9036
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
8757
9037
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
8758
|
-
/** Should intermediate image layers be cached? */
|
|
8759
|
-
'useCache'?: boolean;
|
|
8760
9038
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
8761
9039
|
'dockerFilePath'?: string;
|
|
8762
9040
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
8763
9041
|
'dockerWorkDir'?: string;
|
|
9042
|
+
/** Should intermediate image layers be cached? */
|
|
9043
|
+
'useCache'?: boolean;
|
|
8764
9044
|
};
|
|
8765
9045
|
'buildpack'?: {
|
|
8766
9046
|
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
@@ -8776,6 +9056,12 @@ declare type PatchServiceCombinedData = {
|
|
|
8776
9056
|
'buildConfiguration'?: {
|
|
8777
9057
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
8778
9058
|
'pathIgnoreRules'?: string[];
|
|
9059
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
9060
|
+
'isAllowList'?: boolean;
|
|
9061
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
9062
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
9063
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
9064
|
+
'ciIgnoreFlags'?: string[];
|
|
8779
9065
|
};
|
|
8780
9066
|
/** An object containing the runtime environment to set for the service. Keys may only contain letters, numbers, hyphens, forward slashes and dots. Example: {"VARIABLE_1":"abcdef","VARIABLE_2":"12345"} */
|
|
8781
9067
|
'runtimeEnvironment'?: any;
|
|
@@ -8851,7 +9137,7 @@ declare type CreateServiceDeploymentResult = {
|
|
|
8851
9137
|
/** Details about the current deployment status. */
|
|
8852
9138
|
'deployment'?: {
|
|
8853
9139
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
8854
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
9140
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
8855
9141
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
8856
9142
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
8857
9143
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -8967,6 +9253,10 @@ declare type CreateServiceDeploymentData = {
|
|
|
8967
9253
|
'storageSize'?: number;
|
|
8968
9254
|
};
|
|
8969
9255
|
};
|
|
9256
|
+
'strategy'?: {
|
|
9257
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9258
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9259
|
+
};
|
|
8970
9260
|
'internal': {
|
|
8971
9261
|
/** ID of the build service to deploy Example: "example-build-service" */
|
|
8972
9262
|
'id'?: string;
|
|
@@ -9006,6 +9296,10 @@ declare type CreateServiceDeploymentData = {
|
|
|
9006
9296
|
'storageSize'?: number;
|
|
9007
9297
|
};
|
|
9008
9298
|
};
|
|
9299
|
+
'strategy'?: {
|
|
9300
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9301
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9302
|
+
};
|
|
9009
9303
|
'external': {
|
|
9010
9304
|
/** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
|
|
9011
9305
|
'imagePath': string;
|
|
@@ -9041,6 +9335,10 @@ declare type CreateServiceDeploymentData = {
|
|
|
9041
9335
|
'storageSize'?: number;
|
|
9042
9336
|
};
|
|
9043
9337
|
};
|
|
9338
|
+
'strategy'?: {
|
|
9339
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9340
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9341
|
+
};
|
|
9044
9342
|
};
|
|
9045
9343
|
'ports'?: {
|
|
9046
9344
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -9149,6 +9447,10 @@ declare type PutServiceDeploymentResult = {
|
|
|
9149
9447
|
'storageSize'?: number;
|
|
9150
9448
|
};
|
|
9151
9449
|
};
|
|
9450
|
+
'strategy'?: {
|
|
9451
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9452
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9453
|
+
};
|
|
9152
9454
|
'internal'?: {
|
|
9153
9455
|
/** ID of the build service to deploy Example: "example-build-service" */
|
|
9154
9456
|
'id'?: string;
|
|
@@ -9243,7 +9545,7 @@ declare type PutServiceDeploymentResult = {
|
|
|
9243
9545
|
/** Details about the current deployment status. */
|
|
9244
9546
|
'deployment'?: {
|
|
9245
9547
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
9246
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
9548
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
9247
9549
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
9248
9550
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
9249
9551
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -9298,6 +9600,10 @@ declare type PutServiceDeploymentData = {
|
|
|
9298
9600
|
'storageSize'?: number;
|
|
9299
9601
|
};
|
|
9300
9602
|
};
|
|
9603
|
+
'strategy'?: {
|
|
9604
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9605
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9606
|
+
};
|
|
9301
9607
|
'internal': {
|
|
9302
9608
|
/** ID of the build service to deploy Example: "example-build-service" */
|
|
9303
9609
|
'id'?: string;
|
|
@@ -9337,6 +9643,10 @@ declare type PutServiceDeploymentData = {
|
|
|
9337
9643
|
'storageSize'?: number;
|
|
9338
9644
|
};
|
|
9339
9645
|
};
|
|
9646
|
+
'strategy'?: {
|
|
9647
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9648
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9649
|
+
};
|
|
9340
9650
|
'external': {
|
|
9341
9651
|
/** Image to be deployed. When not deploying from Dockerhub the URL must be specified. Example: "nginx:latest" */
|
|
9342
9652
|
'imagePath': string;
|
|
@@ -9372,6 +9682,10 @@ declare type PutServiceDeploymentData = {
|
|
|
9372
9682
|
'storageSize'?: number;
|
|
9373
9683
|
};
|
|
9374
9684
|
};
|
|
9685
|
+
'strategy'?: {
|
|
9686
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9687
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9688
|
+
};
|
|
9375
9689
|
};
|
|
9376
9690
|
'ports'?: {
|
|
9377
9691
|
/** The name used to identify the port. Example: "port-1" */
|
|
@@ -9480,6 +9794,10 @@ declare type PatchServiceDeploymentResult = {
|
|
|
9480
9794
|
'storageSize'?: number;
|
|
9481
9795
|
};
|
|
9482
9796
|
};
|
|
9797
|
+
'strategy'?: {
|
|
9798
|
+
/** Configures the instance roll out strategy of your service. Currently only available via feature flag. */
|
|
9799
|
+
'type'?: 'recreate' | 'rollout-steady' | 'rollout-balanced' | 'rollout-fast';
|
|
9800
|
+
};
|
|
9483
9801
|
'internal'?: {
|
|
9484
9802
|
/** ID of the build service to deploy Example: "example-build-service" */
|
|
9485
9803
|
'id'?: string;
|
|
@@ -9574,7 +9892,7 @@ declare type PatchServiceDeploymentResult = {
|
|
|
9574
9892
|
/** Details about the current deployment status. */
|
|
9575
9893
|
'deployment'?: {
|
|
9576
9894
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
9577
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
9895
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
9578
9896
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
9579
9897
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
9580
9898
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -9701,7 +10019,7 @@ declare type CreateServiceBuildResult = {
|
|
|
9701
10019
|
/** Details about the current deployment status. */
|
|
9702
10020
|
'deployment'?: {
|
|
9703
10021
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
9704
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
10022
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
9705
10023
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
9706
10024
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
9707
10025
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -9788,12 +10106,12 @@ declare type CreateServiceBuildData = {
|
|
|
9788
10106
|
'dockerfile': {
|
|
9789
10107
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
9790
10108
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
9791
|
-
/** Should intermediate image layers be cached? */
|
|
9792
|
-
'useCache'?: boolean;
|
|
9793
10109
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
9794
10110
|
'dockerFilePath': string;
|
|
9795
10111
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
9796
10112
|
'dockerWorkDir': string;
|
|
10113
|
+
/** Should intermediate image layers be cached? */
|
|
10114
|
+
'useCache'?: boolean;
|
|
9797
10115
|
};
|
|
9798
10116
|
} | {
|
|
9799
10117
|
'buildpack': {
|
|
@@ -9814,6 +10132,12 @@ declare type CreateServiceBuildData = {
|
|
|
9814
10132
|
'branchRestrictions'?: string[];
|
|
9815
10133
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
9816
10134
|
'pathIgnoreRules'?: string[];
|
|
10135
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10136
|
+
'isAllowList'?: boolean;
|
|
10137
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10138
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10139
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10140
|
+
'ciIgnoreFlags'?: string[];
|
|
9817
10141
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
9818
10142
|
'dockerfileTarget'?: string;
|
|
9819
10143
|
/** Include .git folder inside the build context */
|
|
@@ -9858,12 +10182,12 @@ declare type PutServiceBuildResult = {
|
|
|
9858
10182
|
'dockerfile': {
|
|
9859
10183
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
9860
10184
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
9861
|
-
/** Should intermediate image layers be cached? */
|
|
9862
|
-
'useCache'?: boolean;
|
|
9863
10185
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
9864
10186
|
'dockerFilePath': string;
|
|
9865
10187
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
9866
10188
|
'dockerWorkDir': string;
|
|
10189
|
+
/** Should intermediate image layers be cached? */
|
|
10190
|
+
'useCache'?: boolean;
|
|
9867
10191
|
};
|
|
9868
10192
|
} | {
|
|
9869
10193
|
'buildpack': {
|
|
@@ -9884,6 +10208,12 @@ declare type PutServiceBuildResult = {
|
|
|
9884
10208
|
'branchRestrictions'?: string[];
|
|
9885
10209
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
9886
10210
|
'pathIgnoreRules'?: string[];
|
|
10211
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10212
|
+
'isAllowList'?: boolean;
|
|
10213
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10214
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10215
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10216
|
+
'ciIgnoreFlags'?: string[];
|
|
9887
10217
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
9888
10218
|
'dockerfileTarget'?: string;
|
|
9889
10219
|
/** Include .git folder inside the build context */
|
|
@@ -9947,12 +10277,12 @@ declare type PutServiceBuildData = {
|
|
|
9947
10277
|
'dockerfile': {
|
|
9948
10278
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
9949
10279
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
9950
|
-
/** Should intermediate image layers be cached? */
|
|
9951
|
-
'useCache'?: boolean;
|
|
9952
10280
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
9953
10281
|
'dockerFilePath': string;
|
|
9954
10282
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
9955
10283
|
'dockerWorkDir': string;
|
|
10284
|
+
/** Should intermediate image layers be cached? */
|
|
10285
|
+
'useCache'?: boolean;
|
|
9956
10286
|
};
|
|
9957
10287
|
} | {
|
|
9958
10288
|
'buildpack': {
|
|
@@ -9973,6 +10303,12 @@ declare type PutServiceBuildData = {
|
|
|
9973
10303
|
'branchRestrictions'?: string[];
|
|
9974
10304
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
9975
10305
|
'pathIgnoreRules'?: string[];
|
|
10306
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10307
|
+
'isAllowList'?: boolean;
|
|
10308
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10309
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10310
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10311
|
+
'ciIgnoreFlags'?: string[];
|
|
9976
10312
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
9977
10313
|
'dockerfileTarget'?: string;
|
|
9978
10314
|
/** Include .git folder inside the build context */
|
|
@@ -10017,12 +10353,12 @@ declare type PatchServiceBuildResult = {
|
|
|
10017
10353
|
'dockerfile': {
|
|
10018
10354
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
10019
10355
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
10020
|
-
/** Should intermediate image layers be cached? */
|
|
10021
|
-
'useCache'?: boolean;
|
|
10022
10356
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
10023
10357
|
'dockerFilePath': string;
|
|
10024
10358
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
10025
10359
|
'dockerWorkDir': string;
|
|
10360
|
+
/** Should intermediate image layers be cached? */
|
|
10361
|
+
'useCache'?: boolean;
|
|
10026
10362
|
};
|
|
10027
10363
|
} | {
|
|
10028
10364
|
'buildpack': {
|
|
@@ -10043,6 +10379,12 @@ declare type PatchServiceBuildResult = {
|
|
|
10043
10379
|
'branchRestrictions'?: string[];
|
|
10044
10380
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10045
10381
|
'pathIgnoreRules'?: string[];
|
|
10382
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10383
|
+
'isAllowList'?: boolean;
|
|
10384
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10385
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10386
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10387
|
+
'ciIgnoreFlags'?: string[];
|
|
10046
10388
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
10047
10389
|
'dockerfileTarget'?: string;
|
|
10048
10390
|
/** Include .git folder inside the build context */
|
|
@@ -10106,12 +10448,12 @@ declare type PatchServiceBuildData = {
|
|
|
10106
10448
|
'dockerfile'?: {
|
|
10107
10449
|
/** Build engine to use. Defaults to recommended build engine `kaniko` Example: "kaniko" */
|
|
10108
10450
|
'buildEngine'?: 'kaniko' | 'buildkit';
|
|
10109
|
-
/** Should intermediate image layers be cached? */
|
|
10110
|
-
'useCache'?: boolean;
|
|
10111
10451
|
/** The file path of the Dockerfile. Example: "/Dockerfile" */
|
|
10112
10452
|
'dockerFilePath'?: string;
|
|
10113
10453
|
/** The working directory of the Dockerfile. Example: "/" */
|
|
10114
10454
|
'dockerWorkDir'?: string;
|
|
10455
|
+
/** Should intermediate image layers be cached? */
|
|
10456
|
+
'useCache'?: boolean;
|
|
10115
10457
|
};
|
|
10116
10458
|
'buildpack'?: {
|
|
10117
10459
|
/** Buildpack stack to use. Defaults to recommended stack `HEROKU_22_CLASSIC`. Example: "HEROKU_22_CLASSIC" */
|
|
@@ -10131,6 +10473,12 @@ declare type PatchServiceBuildData = {
|
|
|
10131
10473
|
'branchRestrictions'?: string[];
|
|
10132
10474
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10133
10475
|
'pathIgnoreRules'?: string[];
|
|
10476
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
10477
|
+
'isAllowList'?: boolean;
|
|
10478
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
10479
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
10480
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
10481
|
+
'ciIgnoreFlags'?: string[];
|
|
10134
10482
|
};
|
|
10135
10483
|
/** An object containing the build arguments to set for the service Example: {"ARGUMENT_1":"abcdef","ARGUMENT_2":"12345"} */
|
|
10136
10484
|
'buildArguments'?: any;
|
|
@@ -10181,7 +10529,7 @@ declare type GetServiceResult = {
|
|
|
10181
10529
|
/** Details about the current deployment status. */
|
|
10182
10530
|
'deployment'?: {
|
|
10183
10531
|
/** The current status of the deployment. Example: "COMPLETED" */
|
|
10184
|
-
'status': 'IN_PROGRESS' | 'COMPLETED';
|
|
10532
|
+
'status': 'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED';
|
|
10185
10533
|
/** The reason the current deployment was started. Example: "DEPLOYING" */
|
|
10186
10534
|
'reason': 'SCALING' | 'DEPLOYING';
|
|
10187
10535
|
/** The timestamp of when the deployment reached this status. Example: "2021-11-29T11:47:16.624Z" */
|
|
@@ -10832,6 +11180,12 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
10832
11180
|
'branchRestrictions'?: string[];
|
|
10833
11181
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10834
11182
|
'pathIgnoreRules'?: string[];
|
|
11183
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
11184
|
+
'isAllowList'?: boolean;
|
|
11185
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
11186
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
11187
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
11188
|
+
'ciIgnoreFlags'?: string[];
|
|
10835
11189
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
10836
11190
|
'dockerfileTarget'?: string;
|
|
10837
11191
|
/** Include .git folder inside the build context */
|
|
@@ -10851,6 +11205,12 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
10851
11205
|
};
|
|
10852
11206
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10853
11207
|
'pathIgnoreRules'?: string[];
|
|
11208
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
11209
|
+
'isAllowList'?: boolean;
|
|
11210
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
11211
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
11212
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
11213
|
+
'ciIgnoreFlags'?: string[];
|
|
10854
11214
|
} | {
|
|
10855
11215
|
/** An array of pull request build rules. Only supported for build services. Each commit belonging to a pull request on a branch that matches one of the provided build rules will be built automatically. */
|
|
10856
11216
|
'prRestrictions'?: string[];
|
|
@@ -10858,6 +11218,12 @@ declare type UpdateServiceBuildoptionsData = {
|
|
|
10858
11218
|
'branchRestrictions'?: string[];
|
|
10859
11219
|
/** An array of path ignore rules. A commit will only be built if a file has been changed that does not match any of the ignore rules. Path ignore rules follow `.gitignore` syntax. */
|
|
10860
11220
|
'pathIgnoreRules'?: string[];
|
|
11221
|
+
/** If `true`, the functionality of `pathIgnoreRules` will be inverted. A commit will only be built if a file has been changed that matches one or more of the rules in `pathIgnoreRules`. */
|
|
11222
|
+
'isAllowList'?: boolean;
|
|
11223
|
+
/** If `true`, enables commit ignore flags. If a commit message contains one or more of the flags in `ciIgnoreFlags`, that commit will not be built. */
|
|
11224
|
+
'ciIgnoreFlagsEnabled'?: boolean;
|
|
11225
|
+
/** An array of commit ignore flags. If a commit message contains one or more of these flags, that commit will not be built. Defaults to `[, "[skip ci]", "[ci skip]", "[no ci]", "[skip nf]", "[nf skip]", "[northflank skip]", "[skip northflank]"]` Example: ["[skip ci]","[ci skip]","[no ci]","[skip nf]","[nf skip]","[northflank skip]","[skip northflank]"] */
|
|
11226
|
+
'ciIgnoreFlags'?: string[];
|
|
10861
11227
|
/** If your Dockerfile contains multiple build stages, you can specify the target stage by entering its name here. */
|
|
10862
11228
|
'dockerfileTarget'?: string;
|
|
10863
11229
|
/** Include .git folder inside the build context */
|
|
@@ -11307,23 +11673,18 @@ declare class GetServicePullrequestsEndpoint extends GetApiEndpoint<GetServicePu
|
|
|
11307
11673
|
declare type ListTemplatesResult = {
|
|
11308
11674
|
/** An array of template objects. */
|
|
11309
11675
|
'templates': {
|
|
11310
|
-
/**
|
|
11676
|
+
/** Name of the template. Example: "Example Template" */
|
|
11677
|
+
'name': string;
|
|
11678
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
11679
|
+
'description'?: string;
|
|
11680
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11681
|
+
'apiVersion': 'v1';
|
|
11682
|
+
/** Identifier for the template Example: "example-template" */
|
|
11311
11683
|
'id': string;
|
|
11312
|
-
/**
|
|
11313
|
-
'createdAt'
|
|
11314
|
-
/**
|
|
11315
|
-
'updatedAt'
|
|
11316
|
-
/** If true, this template runs automatically after any changes are applied. */
|
|
11317
|
-
'autorun': boolean;
|
|
11318
|
-
/** Details about the template. */
|
|
11319
|
-
'content': {
|
|
11320
|
-
/** Name of the template. Example: "Example Template" */
|
|
11321
|
-
'name': string;
|
|
11322
|
-
/** Description of the template. Example: "This is a sample template." */
|
|
11323
|
-
'description'?: string;
|
|
11324
|
-
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11325
|
-
'apiVersion': 'v1';
|
|
11326
|
-
};
|
|
11684
|
+
/** time of creation */
|
|
11685
|
+
'createdAt'?: string;
|
|
11686
|
+
/** time of update */
|
|
11687
|
+
'updatedAt'?: string;
|
|
11327
11688
|
}[];
|
|
11328
11689
|
};
|
|
11329
11690
|
declare type ListTemplatesCall = (opts: ListTemplatesRequest) => Promise<ApiCallResponse<ListTemplatesResult>>;
|
|
@@ -11350,123 +11711,113 @@ declare class ListTemplatesEndpoint extends GetApiEndpoint<ListTemplatesRequest,
|
|
|
11350
11711
|
declare type CreateTemplateResult = {
|
|
11351
11712
|
/** Details about the newly created template. */
|
|
11352
11713
|
'template': {
|
|
11353
|
-
/**
|
|
11714
|
+
/** Name of the template. Example: "Example Template" */
|
|
11715
|
+
'name': string;
|
|
11716
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
11717
|
+
'description'?: string;
|
|
11718
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11719
|
+
'apiVersion': 'v1';
|
|
11720
|
+
/** Details of the project the template will run in. */
|
|
11721
|
+
'project': {
|
|
11722
|
+
/** The ID of the project to use. */
|
|
11723
|
+
'id': string;
|
|
11724
|
+
} | {
|
|
11725
|
+
'spec': {
|
|
11726
|
+
/** The name of the project. Example: "New Project" */
|
|
11727
|
+
'name': string;
|
|
11728
|
+
/** The description of the project. Example: "This is a new project." */
|
|
11729
|
+
'description'?: string;
|
|
11730
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11731
|
+
'color'?: string;
|
|
11732
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
11733
|
+
'region': string;
|
|
11734
|
+
} | {
|
|
11735
|
+
/** The name of the project. Example: "New Project" */
|
|
11736
|
+
'name': string;
|
|
11737
|
+
/** The description of the project. Example: "This is a new project." */
|
|
11738
|
+
'description'?: string;
|
|
11739
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11740
|
+
'color'?: string;
|
|
11741
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
11742
|
+
'clusterId'?: string;
|
|
11743
|
+
};
|
|
11744
|
+
};
|
|
11745
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11746
|
+
'arguments'?: any;
|
|
11747
|
+
'spec': any;
|
|
11748
|
+
/** Identifier for the template Example: "example-template" */
|
|
11354
11749
|
'id': string;
|
|
11355
|
-
|
|
11356
|
-
|
|
11357
|
-
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
11358
|
-
'updatedAt': string;
|
|
11359
|
-
/** If true, this template runs automatically after any changes are applied. */
|
|
11360
|
-
'autorun': boolean;
|
|
11361
|
-
/** Details about the GitOps settings for the template. */
|
|
11362
|
-
'vcsData'?: {
|
|
11363
|
-
/** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11364
|
-
'repoUrl': string;
|
|
11365
|
-
/** The VCS provider for the template. Example: "github" */
|
|
11750
|
+
'gitops'?: {
|
|
11751
|
+
/** The VCS provider to use. Example: "github" */
|
|
11366
11752
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11367
|
-
/** If projectType is self-hosted, the ID of the self-hosted vcs
|
|
11753
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11368
11754
|
'selfHostedVcsId'?: string;
|
|
11369
|
-
/**
|
|
11755
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11756
|
+
'accountLogin'?: string;
|
|
11757
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11758
|
+
'repoUrl': string;
|
|
11759
|
+
/** The name of the branch to use. Example: "main" */
|
|
11370
11760
|
'branch': string;
|
|
11371
|
-
/** The file path to the template in the repository. Example: "northflank.json" */
|
|
11761
|
+
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
11372
11762
|
'filePath': string;
|
|
11373
11763
|
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
11374
11764
|
'templateSha': string;
|
|
11375
11765
|
};
|
|
11376
|
-
|
|
11377
|
-
|
|
11378
|
-
|
|
11379
|
-
'name': string;
|
|
11380
|
-
/** Description of the template. Example: "This is a sample template." */
|
|
11381
|
-
'description'?: string;
|
|
11382
|
-
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11383
|
-
'apiVersion': 'v1';
|
|
11384
|
-
/** Details of the project the template will run in. */
|
|
11385
|
-
'project': {
|
|
11386
|
-
/** The ID of the project to use. */
|
|
11387
|
-
'id': string;
|
|
11388
|
-
} | {
|
|
11389
|
-
'spec': {
|
|
11390
|
-
/** The name of the project. Example: "New Project" */
|
|
11391
|
-
'name': string;
|
|
11392
|
-
/** The description of the project. Example: "This is a new project." */
|
|
11393
|
-
'description'?: string;
|
|
11394
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11395
|
-
'color'?: string;
|
|
11396
|
-
/** The region the project will be hosted in. Example: "europe-west" */
|
|
11397
|
-
'region': string;
|
|
11398
|
-
} | {
|
|
11399
|
-
/** The name of the project. Example: "New Project" */
|
|
11400
|
-
'name': string;
|
|
11401
|
-
/** The description of the project. Example: "This is a new project." */
|
|
11402
|
-
'description'?: string;
|
|
11403
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11404
|
-
'color'?: string;
|
|
11405
|
-
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
11406
|
-
'clusterId'?: string;
|
|
11407
|
-
};
|
|
11408
|
-
};
|
|
11409
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11410
|
-
'arguments'?: any;
|
|
11411
|
-
'refs'?: any;
|
|
11412
|
-
'spec': any;
|
|
11766
|
+
'options': {
|
|
11767
|
+
/** Whether autorun is enabled */
|
|
11768
|
+
'autorun': boolean;
|
|
11413
11769
|
};
|
|
11770
|
+
/** time of creation */
|
|
11771
|
+
'createdAt'?: string;
|
|
11772
|
+
/** time of update */
|
|
11773
|
+
'updatedAt'?: string;
|
|
11414
11774
|
};
|
|
11415
|
-
/** Details about the newly created template run. */
|
|
11416
11775
|
'templateRun'?: {
|
|
11417
|
-
/**
|
|
11418
|
-
'
|
|
11419
|
-
/**
|
|
11420
|
-
'
|
|
11421
|
-
/**
|
|
11422
|
-
'
|
|
11423
|
-
/** Details
|
|
11424
|
-
'
|
|
11425
|
-
/** ID of the
|
|
11426
|
-
'id': string;
|
|
11427
|
-
|
|
11428
|
-
'
|
|
11429
|
-
|
|
11430
|
-
|
|
11431
|
-
|
|
11432
|
-
|
|
11433
|
-
|
|
11434
|
-
|
|
11435
|
-
|
|
11436
|
-
|
|
11437
|
-
|
|
11438
|
-
|
|
11439
|
-
|
|
11440
|
-
|
|
11441
|
-
|
|
11442
|
-
/** The
|
|
11443
|
-
'
|
|
11444
|
-
|
|
11445
|
-
'
|
|
11446
|
-
/** The name of the project. Example: "New Project" */
|
|
11447
|
-
'name': string;
|
|
11448
|
-
/** The description of the project. Example: "This is a new project." */
|
|
11449
|
-
'description'?: string;
|
|
11450
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11451
|
-
'color'?: string;
|
|
11452
|
-
/** The region the project will be hosted in. Example: "europe-west" */
|
|
11453
|
-
'region': string;
|
|
11454
|
-
} | {
|
|
11455
|
-
/** The name of the project. Example: "New Project" */
|
|
11456
|
-
'name': string;
|
|
11457
|
-
/** The description of the project. Example: "This is a new project." */
|
|
11458
|
-
'description'?: string;
|
|
11459
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11460
|
-
'color'?: string;
|
|
11461
|
-
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
11462
|
-
'clusterId'?: string;
|
|
11463
|
-
};
|
|
11776
|
+
/** Name of the template. Example: "Example Template" */
|
|
11777
|
+
'name': string;
|
|
11778
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
11779
|
+
'description'?: string;
|
|
11780
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11781
|
+
'apiVersion': 'v1';
|
|
11782
|
+
/** Details of the project the template will run in. */
|
|
11783
|
+
'project': {
|
|
11784
|
+
/** The ID of the project to use. */
|
|
11785
|
+
'id': string;
|
|
11786
|
+
} | {
|
|
11787
|
+
'spec': {
|
|
11788
|
+
/** The name of the project. Example: "New Project" */
|
|
11789
|
+
'name': string;
|
|
11790
|
+
/** The description of the project. Example: "This is a new project." */
|
|
11791
|
+
'description'?: string;
|
|
11792
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11793
|
+
'color'?: string;
|
|
11794
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
11795
|
+
'region': string;
|
|
11796
|
+
} | {
|
|
11797
|
+
/** The name of the project. Example: "New Project" */
|
|
11798
|
+
'name': string;
|
|
11799
|
+
/** The description of the project. Example: "This is a new project." */
|
|
11800
|
+
'description'?: string;
|
|
11801
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11802
|
+
'color'?: string;
|
|
11803
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
11804
|
+
'clusterId'?: string;
|
|
11464
11805
|
};
|
|
11465
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11466
|
-
'arguments'?: any;
|
|
11467
|
-
'refs'?: any;
|
|
11468
|
-
'spec': any;
|
|
11469
11806
|
};
|
|
11807
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11808
|
+
'arguments'?: any;
|
|
11809
|
+
'spec': any;
|
|
11810
|
+
'refs'?: any;
|
|
11811
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
11812
|
+
'id': string;
|
|
11813
|
+
/** Identifier for the template Example: "example-template" */
|
|
11814
|
+
'templateId': string;
|
|
11815
|
+
/** Status of the template run Example: "pending" */
|
|
11816
|
+
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
11817
|
+
/** time of creation */
|
|
11818
|
+
'createdAt'?: string;
|
|
11819
|
+
/** time of update */
|
|
11820
|
+
'updatedAt'?: string;
|
|
11470
11821
|
};
|
|
11471
11822
|
};
|
|
11472
11823
|
declare type CreateTemplateCall = (opts: CreateTemplateRequest) => Promise<ApiCallResponse<CreateTemplateResult>>;
|
|
@@ -11507,7 +11858,6 @@ declare type CreateTemplateData = {
|
|
|
11507
11858
|
};
|
|
11508
11859
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11509
11860
|
'arguments'?: any;
|
|
11510
|
-
'refs'?: any;
|
|
11511
11861
|
'spec': any;
|
|
11512
11862
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11513
11863
|
'argumentOverrides'?: any;
|
|
@@ -11554,7 +11904,6 @@ declare type CreateTemplateData = {
|
|
|
11554
11904
|
};
|
|
11555
11905
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11556
11906
|
'arguments'?: any;
|
|
11557
|
-
'refs'?: any;
|
|
11558
11907
|
'spec': any;
|
|
11559
11908
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11560
11909
|
'argumentOverrides'?: any;
|
|
@@ -11569,14 +11918,14 @@ declare type CreateTemplateData = {
|
|
|
11569
11918
|
};
|
|
11570
11919
|
/** GitOps data for syncing this template with a file in version control. */
|
|
11571
11920
|
'gitops': {
|
|
11572
|
-
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11573
|
-
'repoUrl': string;
|
|
11574
11921
|
/** The VCS provider to use. Example: "github" */
|
|
11575
11922
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11576
11923
|
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11577
11924
|
'selfHostedVcsId'?: string;
|
|
11578
11925
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11579
11926
|
'accountLogin'?: string;
|
|
11927
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11928
|
+
'repoUrl': string;
|
|
11580
11929
|
/** The name of the branch to use. Example: "main" */
|
|
11581
11930
|
'branch': string;
|
|
11582
11931
|
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
@@ -11587,9 +11936,6 @@ declare type CreateTemplateData = {
|
|
|
11587
11936
|
'name': string;
|
|
11588
11937
|
/** Description of the template. Example: "This is a sample template." */
|
|
11589
11938
|
'description'?: string;
|
|
11590
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11591
|
-
'arguments'?: any;
|
|
11592
|
-
'refs'?: any;
|
|
11593
11939
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11594
11940
|
'argumentOverrides'?: any;
|
|
11595
11941
|
/** Additional options for the template creation. */
|
|
@@ -11603,14 +11949,14 @@ declare type CreateTemplateData = {
|
|
|
11603
11949
|
};
|
|
11604
11950
|
/** GitOps data for syncing this template with a file in version control. */
|
|
11605
11951
|
'gitops': {
|
|
11606
|
-
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11607
|
-
'repoUrl': string;
|
|
11608
11952
|
/** The VCS provider to use. Example: "github" */
|
|
11609
11953
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11610
11954
|
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11611
11955
|
'selfHostedVcsId'?: string;
|
|
11612
11956
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11613
11957
|
'accountLogin'?: string;
|
|
11958
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11959
|
+
'repoUrl': string;
|
|
11614
11960
|
/** The name of the branch to use. Example: "main" */
|
|
11615
11961
|
'branch': string;
|
|
11616
11962
|
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
@@ -11627,31 +11973,95 @@ declare class CreateTemplateEndpoint extends PostApiEndpoint<CreateTemplateReque
|
|
|
11627
11973
|
}
|
|
11628
11974
|
|
|
11629
11975
|
declare type GetTemplateResult = {
|
|
11630
|
-
/**
|
|
11976
|
+
/** Name of the template. Example: "Example Template" */
|
|
11977
|
+
'name': string;
|
|
11978
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
11979
|
+
'description'?: string;
|
|
11980
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11981
|
+
'apiVersion': 'v1';
|
|
11982
|
+
/** Details of the project the template will run in. */
|
|
11983
|
+
'project': {
|
|
11984
|
+
/** The ID of the project to use. */
|
|
11985
|
+
'id': string;
|
|
11986
|
+
} | {
|
|
11987
|
+
'spec': {
|
|
11988
|
+
/** The name of the project. Example: "New Project" */
|
|
11989
|
+
'name': string;
|
|
11990
|
+
/** The description of the project. Example: "This is a new project." */
|
|
11991
|
+
'description'?: string;
|
|
11992
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11993
|
+
'color'?: string;
|
|
11994
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
11995
|
+
'region': string;
|
|
11996
|
+
} | {
|
|
11997
|
+
/** The name of the project. Example: "New Project" */
|
|
11998
|
+
'name': string;
|
|
11999
|
+
/** The description of the project. Example: "This is a new project." */
|
|
12000
|
+
'description'?: string;
|
|
12001
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12002
|
+
'color'?: string;
|
|
12003
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
12004
|
+
'clusterId'?: string;
|
|
12005
|
+
};
|
|
12006
|
+
};
|
|
12007
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12008
|
+
'arguments'?: any;
|
|
12009
|
+
'spec': any;
|
|
12010
|
+
/** Identifier for the template Example: "example-template" */
|
|
11631
12011
|
'id': string;
|
|
11632
|
-
|
|
11633
|
-
|
|
11634
|
-
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
11635
|
-
'updatedAt': string;
|
|
11636
|
-
/** If true, this template runs automatically after any changes are applied. */
|
|
11637
|
-
'autorun': boolean;
|
|
11638
|
-
/** Details about the GitOps settings for the template. */
|
|
11639
|
-
'vcsData'?: {
|
|
11640
|
-
/** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11641
|
-
'repoUrl': string;
|
|
11642
|
-
/** The VCS provider for the template. Example: "github" */
|
|
12012
|
+
'gitops'?: {
|
|
12013
|
+
/** The VCS provider to use. Example: "github" */
|
|
11643
12014
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11644
|
-
/** If projectType is self-hosted, the ID of the self-hosted vcs
|
|
12015
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11645
12016
|
'selfHostedVcsId'?: string;
|
|
11646
|
-
/**
|
|
12017
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
12018
|
+
'accountLogin'?: string;
|
|
12019
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
12020
|
+
'repoUrl': string;
|
|
12021
|
+
/** The name of the branch to use. Example: "main" */
|
|
11647
12022
|
'branch': string;
|
|
11648
|
-
/** The file path to the template in the repository. Example: "northflank.json" */
|
|
12023
|
+
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
11649
12024
|
'filePath': string;
|
|
11650
12025
|
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
11651
12026
|
'templateSha': string;
|
|
11652
12027
|
};
|
|
11653
|
-
|
|
11654
|
-
|
|
12028
|
+
'options': {
|
|
12029
|
+
/** Whether autorun is enabled */
|
|
12030
|
+
'autorun': boolean;
|
|
12031
|
+
};
|
|
12032
|
+
/** time of creation */
|
|
12033
|
+
'createdAt'?: string;
|
|
12034
|
+
/** time of update */
|
|
12035
|
+
'updatedAt'?: string;
|
|
12036
|
+
};
|
|
12037
|
+
declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
|
|
12038
|
+
declare type GetTemplateRequest = {
|
|
12039
|
+
parameters: GetTemplateParameters;
|
|
12040
|
+
options?: GetTemplateOptions;
|
|
12041
|
+
};
|
|
12042
|
+
declare type GetTemplateParameters = {
|
|
12043
|
+
/** ID of the template */ 'templateId': string;
|
|
12044
|
+
};
|
|
12045
|
+
declare type GetTemplateOptions = {
|
|
12046
|
+
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
12047
|
+
'per_page'?: number;
|
|
12048
|
+
/** The page number to access. */
|
|
12049
|
+
'page'?: number;
|
|
12050
|
+
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
12051
|
+
'cursor'?: string;
|
|
12052
|
+
};
|
|
12053
|
+
/** Get information about the given template. */
|
|
12054
|
+
declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
|
|
12055
|
+
description: string;
|
|
12056
|
+
withAuth: boolean;
|
|
12057
|
+
requiredPermissions: string;
|
|
12058
|
+
endpointUrl: (opts: GetTemplateRequest) => string;
|
|
12059
|
+
body: () => undefined;
|
|
12060
|
+
}
|
|
12061
|
+
|
|
12062
|
+
declare type UpdateTemplateResult = {
|
|
12063
|
+
/** Details about the updated template. */
|
|
12064
|
+
'template': {
|
|
11655
12065
|
/** Name of the template. Example: "Example Template" */
|
|
11656
12066
|
'name': string;
|
|
11657
12067
|
/** Description of the template. Example: "This is a sample template." */
|
|
@@ -11685,61 +12095,35 @@ declare type GetTemplateResult = {
|
|
|
11685
12095
|
};
|
|
11686
12096
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11687
12097
|
'arguments'?: any;
|
|
11688
|
-
'refs'?: any;
|
|
11689
12098
|
'spec': any;
|
|
12099
|
+
/** Identifier for the template Example: "example-template" */
|
|
12100
|
+
'id': string;
|
|
12101
|
+
'gitops'?: {
|
|
12102
|
+
/** The VCS provider to use. Example: "github" */
|
|
12103
|
+
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
12104
|
+
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
12105
|
+
'selfHostedVcsId'?: string;
|
|
12106
|
+
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
12107
|
+
'accountLogin'?: string;
|
|
12108
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
12109
|
+
'repoUrl': string;
|
|
12110
|
+
/** The name of the branch to use. Example: "main" */
|
|
12111
|
+
'branch': string;
|
|
12112
|
+
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
12113
|
+
'filePath': string;
|
|
12114
|
+
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
12115
|
+
'templateSha': string;
|
|
12116
|
+
};
|
|
12117
|
+
'options': {
|
|
12118
|
+
/** Whether autorun is enabled */
|
|
12119
|
+
'autorun': boolean;
|
|
12120
|
+
};
|
|
12121
|
+
/** time of creation */
|
|
12122
|
+
'createdAt'?: string;
|
|
12123
|
+
/** time of update */
|
|
12124
|
+
'updatedAt'?: string;
|
|
11690
12125
|
};
|
|
11691
|
-
|
|
11692
|
-
declare type GetTemplateCall = (opts: GetTemplateRequest) => Promise<ApiCallResponse<GetTemplateResult>>;
|
|
11693
|
-
declare type GetTemplateRequest = {
|
|
11694
|
-
parameters: GetTemplateParameters;
|
|
11695
|
-
options?: GetTemplateOptions;
|
|
11696
|
-
};
|
|
11697
|
-
declare type GetTemplateParameters = {
|
|
11698
|
-
/** ID of the template */ 'templateId': string;
|
|
11699
|
-
};
|
|
11700
|
-
declare type GetTemplateOptions = {
|
|
11701
|
-
/** The number of results to display per request. Maximum of 100 results per page. */
|
|
11702
|
-
'per_page'?: number;
|
|
11703
|
-
/** The page number to access. */
|
|
11704
|
-
'page'?: number;
|
|
11705
|
-
/** The cursor returned from the previous page of results, used to request the next page. */
|
|
11706
|
-
'cursor'?: string;
|
|
11707
|
-
};
|
|
11708
|
-
/** Get information about the given template. */
|
|
11709
|
-
declare class GetTemplateEndpoint extends GetApiEndpoint<GetTemplateRequest, GetTemplateResult> {
|
|
11710
|
-
description: string;
|
|
11711
|
-
withAuth: boolean;
|
|
11712
|
-
requiredPermissions: string;
|
|
11713
|
-
endpointUrl: (opts: GetTemplateRequest) => string;
|
|
11714
|
-
body: () => undefined;
|
|
11715
|
-
}
|
|
11716
|
-
|
|
11717
|
-
declare type UpdateTemplateResult = {
|
|
11718
|
-
/** ID of the template. Example: "example-template" */
|
|
11719
|
-
'id': string;
|
|
11720
|
-
/** Timestamp of when the template was created. Example: "2022-06-14 15:10:42.842Z" */
|
|
11721
|
-
'createdAt': string;
|
|
11722
|
-
/** Timestamp of when the template was last updated. Example: "2022-06-14 15:10:42.842Z" */
|
|
11723
|
-
'updatedAt': string;
|
|
11724
|
-
/** If true, this template runs automatically after any changes are applied. */
|
|
11725
|
-
'autorun': boolean;
|
|
11726
|
-
/** Details about the GitOps settings for the template. */
|
|
11727
|
-
'vcsData'?: {
|
|
11728
|
-
/** URL of the Git repo the template is being synced with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11729
|
-
'repoUrl': string;
|
|
11730
|
-
/** The VCS provider for the template. Example: "github" */
|
|
11731
|
-
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11732
|
-
/** If projectType is self-hosted, the ID of the self-hosted vcs being used. */
|
|
11733
|
-
'selfHostedVcsId'?: string;
|
|
11734
|
-
/** The name of the branch. Example: "main" */
|
|
11735
|
-
'branch': string;
|
|
11736
|
-
/** The file path to the template in the repository. Example: "northflank.json" */
|
|
11737
|
-
'filePath': string;
|
|
11738
|
-
/** The SHA of the current commit that is being used for the template. Example: "8c7e040ee3737ddc3a713363ae72bbe960e9fb16" */
|
|
11739
|
-
'templateSha': string;
|
|
11740
|
-
};
|
|
11741
|
-
/** The content of the template. */
|
|
11742
|
-
'content'?: {
|
|
12126
|
+
'templateRun'?: {
|
|
11743
12127
|
/** Name of the template. Example: "Example Template" */
|
|
11744
12128
|
'name': string;
|
|
11745
12129
|
/** Description of the template. Example: "This is a sample template." */
|
|
@@ -11773,8 +12157,18 @@ declare type UpdateTemplateResult = {
|
|
|
11773
12157
|
};
|
|
11774
12158
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11775
12159
|
'arguments'?: any;
|
|
11776
|
-
'refs'?: any;
|
|
11777
12160
|
'spec': any;
|
|
12161
|
+
'refs'?: any;
|
|
12162
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
12163
|
+
'id': string;
|
|
12164
|
+
/** Identifier for the template Example: "example-template" */
|
|
12165
|
+
'templateId': string;
|
|
12166
|
+
/** Status of the template run Example: "pending" */
|
|
12167
|
+
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12168
|
+
/** time of creation */
|
|
12169
|
+
'createdAt'?: string;
|
|
12170
|
+
/** time of update */
|
|
12171
|
+
'updatedAt'?: string;
|
|
11778
12172
|
};
|
|
11779
12173
|
};
|
|
11780
12174
|
declare type UpdateTemplateCall = (opts: UpdateTemplateRequest) => Promise<ApiCallResponse<UpdateTemplateResult>>;
|
|
@@ -11819,7 +12213,6 @@ declare type UpdateTemplateData = {
|
|
|
11819
12213
|
};
|
|
11820
12214
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11821
12215
|
'arguments'?: any;
|
|
11822
|
-
'refs'?: any;
|
|
11823
12216
|
'spec': any;
|
|
11824
12217
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11825
12218
|
'argumentOverrides'?: any;
|
|
@@ -11862,7 +12255,6 @@ declare type UpdateTemplateData = {
|
|
|
11862
12255
|
};
|
|
11863
12256
|
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11864
12257
|
'arguments'?: any;
|
|
11865
|
-
'refs'?: any;
|
|
11866
12258
|
'spec': any;
|
|
11867
12259
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11868
12260
|
'argumentOverrides'?: any;
|
|
@@ -11873,14 +12265,14 @@ declare type UpdateTemplateData = {
|
|
|
11873
12265
|
};
|
|
11874
12266
|
/** GitOps data for syncing this template with a file in version control. If set to `null`, removes GitOps handling from this template. */
|
|
11875
12267
|
'gitops': {
|
|
11876
|
-
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11877
|
-
'repoUrl': string;
|
|
11878
12268
|
/** The VCS provider to use. Example: "github" */
|
|
11879
12269
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11880
12270
|
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11881
12271
|
'selfHostedVcsId'?: string;
|
|
11882
12272
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11883
12273
|
'accountLogin'?: string;
|
|
12274
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
12275
|
+
'repoUrl': string;
|
|
11884
12276
|
/** The name of the branch to use. Example: "main" */
|
|
11885
12277
|
'branch': string;
|
|
11886
12278
|
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
@@ -11891,9 +12283,6 @@ declare type UpdateTemplateData = {
|
|
|
11891
12283
|
'name': string;
|
|
11892
12284
|
/** Description of the template. Example: "This is a sample template." */
|
|
11893
12285
|
'description'?: string;
|
|
11894
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11895
|
-
'arguments'?: any;
|
|
11896
|
-
'refs'?: any;
|
|
11897
12286
|
/** Argument overrides stored outside of the template. If GitOps is enabled, these will not be saved in version control. */
|
|
11898
12287
|
'argumentOverrides'?: any;
|
|
11899
12288
|
/** Additional options for the template creation. */
|
|
@@ -11903,14 +12292,14 @@ declare type UpdateTemplateData = {
|
|
|
11903
12292
|
};
|
|
11904
12293
|
/** GitOps data for syncing this template with a file in version control. If set to `null`, removes GitOps handling from this template. */
|
|
11905
12294
|
'gitops': {
|
|
11906
|
-
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
11907
|
-
'repoUrl': string;
|
|
11908
12295
|
/** The VCS provider to use. Example: "github" */
|
|
11909
12296
|
'vcsService': 'bitbucket' | 'gitlab' | 'github' | 'self-hosted';
|
|
11910
12297
|
/** If projectType is self-hosted, the ID of the self-hosted vcs to use. */
|
|
11911
12298
|
'selfHostedVcsId'?: string;
|
|
11912
12299
|
/** By default, if you have multiple version control accounts of the same provider linked, Northflank will pick a linked account that has access to the repository. If `accountLogin` is provided, Northflank will instead use your linked account with that login name. Example: "github-user" */
|
|
11913
12300
|
'accountLogin'?: string;
|
|
12301
|
+
/** URL of the Git repo to sync the template with. Example: "https://github.com/northflank-examples/remix-postgres-redis-demo" */
|
|
12302
|
+
'repoUrl': string;
|
|
11914
12303
|
/** The name of the branch to use. Example: "main" */
|
|
11915
12304
|
'branch': string;
|
|
11916
12305
|
/** The file path to the template in the repository. If using an existing template, it should be in JSON format. Example: "northflank.json" */
|
|
@@ -11944,59 +12333,51 @@ declare class DeleteTemplateEndpoint extends DeleteApiEndpoint<DeleteTemplateReq
|
|
|
11944
12333
|
}
|
|
11945
12334
|
|
|
11946
12335
|
declare type RunTemplateResult = {
|
|
11947
|
-
/**
|
|
11948
|
-
'
|
|
11949
|
-
/**
|
|
11950
|
-
'
|
|
11951
|
-
/**
|
|
11952
|
-
'
|
|
11953
|
-
/** Details
|
|
11954
|
-
'
|
|
11955
|
-
/** ID of the
|
|
12336
|
+
/** Name of the template. Example: "Example Template" */
|
|
12337
|
+
'name': string;
|
|
12338
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
12339
|
+
'description'?: string;
|
|
12340
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
12341
|
+
'apiVersion': 'v1';
|
|
12342
|
+
/** Details of the project the template will run in. */
|
|
12343
|
+
'project': {
|
|
12344
|
+
/** The ID of the project to use. */
|
|
11956
12345
|
'id': string;
|
|
11957
|
-
|
|
11958
|
-
'
|
|
11959
|
-
|
|
11960
|
-
|
|
11961
|
-
|
|
11962
|
-
|
|
11963
|
-
|
|
11964
|
-
|
|
11965
|
-
|
|
11966
|
-
|
|
11967
|
-
'description'?: string;
|
|
11968
|
-
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
11969
|
-
'apiVersion': 'v1';
|
|
11970
|
-
/** Details of the project the template will run in. */
|
|
11971
|
-
'project': {
|
|
11972
|
-
/** The ID of the project to use. */
|
|
11973
|
-
'id': string;
|
|
12346
|
+
} | {
|
|
12347
|
+
'spec': {
|
|
12348
|
+
/** The name of the project. Example: "New Project" */
|
|
12349
|
+
'name': string;
|
|
12350
|
+
/** The description of the project. Example: "This is a new project." */
|
|
12351
|
+
'description'?: string;
|
|
12352
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12353
|
+
'color'?: string;
|
|
12354
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
12355
|
+
'region': string;
|
|
11974
12356
|
} | {
|
|
11975
|
-
|
|
11976
|
-
|
|
11977
|
-
|
|
11978
|
-
|
|
11979
|
-
|
|
11980
|
-
|
|
11981
|
-
|
|
11982
|
-
|
|
11983
|
-
'region': string;
|
|
11984
|
-
} | {
|
|
11985
|
-
/** The name of the project. Example: "New Project" */
|
|
11986
|
-
'name': string;
|
|
11987
|
-
/** The description of the project. Example: "This is a new project." */
|
|
11988
|
-
'description'?: string;
|
|
11989
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
11990
|
-
'color'?: string;
|
|
11991
|
-
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
11992
|
-
'clusterId'?: string;
|
|
11993
|
-
};
|
|
12357
|
+
/** The name of the project. Example: "New Project" */
|
|
12358
|
+
'name': string;
|
|
12359
|
+
/** The description of the project. Example: "This is a new project." */
|
|
12360
|
+
'description'?: string;
|
|
12361
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12362
|
+
'color'?: string;
|
|
12363
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
12364
|
+
'clusterId'?: string;
|
|
11994
12365
|
};
|
|
11995
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
11996
|
-
'arguments'?: any;
|
|
11997
|
-
'refs'?: any;
|
|
11998
|
-
'spec': any;
|
|
11999
12366
|
};
|
|
12367
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12368
|
+
'arguments'?: any;
|
|
12369
|
+
'spec': any;
|
|
12370
|
+
'refs'?: any;
|
|
12371
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
12372
|
+
'id': string;
|
|
12373
|
+
/** Identifier for the template Example: "example-template" */
|
|
12374
|
+
'templateId': string;
|
|
12375
|
+
/** Status of the template run Example: "pending" */
|
|
12376
|
+
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12377
|
+
/** time of creation */
|
|
12378
|
+
'createdAt'?: string;
|
|
12379
|
+
/** time of update */
|
|
12380
|
+
'updatedAt'?: string;
|
|
12000
12381
|
};
|
|
12001
12382
|
declare type RunTemplateCall = (opts: RunTemplateRequest) => Promise<ApiCallResponse<RunTemplateResult>>;
|
|
12002
12383
|
declare type RunTemplateRequest = {
|
|
@@ -12022,30 +12403,22 @@ declare class RunTemplateEndpoint extends PostApiEndpoint<RunTemplateRequest, Ru
|
|
|
12022
12403
|
declare type ListTemplaterunsResult = {
|
|
12023
12404
|
/** An array of template run objects. */
|
|
12024
12405
|
'templateRuns': {
|
|
12025
|
-
/**
|
|
12406
|
+
/** Name of the template. Example: "Example Template" */
|
|
12407
|
+
'name': string;
|
|
12408
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
12409
|
+
'description'?: string;
|
|
12410
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
12411
|
+
'apiVersion': 'v1';
|
|
12412
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
12026
12413
|
'id': string;
|
|
12027
|
-
/**
|
|
12028
|
-
'
|
|
12029
|
-
/**
|
|
12030
|
-
'
|
|
12031
|
-
/**
|
|
12032
|
-
'
|
|
12033
|
-
|
|
12034
|
-
|
|
12035
|
-
/** The name of the template Example: "Example Template" */
|
|
12036
|
-
'name': string;
|
|
12037
|
-
};
|
|
12038
|
-
/** Details about the template run. */
|
|
12039
|
-
'content': {
|
|
12040
|
-
/** Name of the template. Example: "Example Template" */
|
|
12041
|
-
'name': string;
|
|
12042
|
-
/** Description of the template. Example: "This is a sample template." */
|
|
12043
|
-
'description'?: string;
|
|
12044
|
-
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
12045
|
-
'apiVersion': 'v1';
|
|
12046
|
-
};
|
|
12047
|
-
/** Status of the template run. Example: "success" */
|
|
12048
|
-
'status': 'waiting' | 'failure' | 'retrying' | 'success' | 'unknown';
|
|
12414
|
+
/** Identifier for the template Example: "example-template" */
|
|
12415
|
+
'templateId': string;
|
|
12416
|
+
/** Status of the template run Example: "pending" */
|
|
12417
|
+
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12418
|
+
/** time of creation */
|
|
12419
|
+
'createdAt'?: string;
|
|
12420
|
+
/** time of update */
|
|
12421
|
+
'updatedAt'?: string;
|
|
12049
12422
|
}[];
|
|
12050
12423
|
};
|
|
12051
12424
|
declare type ListTemplaterunsCall = (opts: ListTemplaterunsRequest) => Promise<ApiCallResponse<ListTemplaterunsResult>>;
|
|
@@ -12074,59 +12447,51 @@ declare class ListTemplaterunsEndpoint extends GetApiEndpoint<ListTemplaterunsRe
|
|
|
12074
12447
|
}
|
|
12075
12448
|
|
|
12076
12449
|
declare type GetTemplaterunResult = {
|
|
12077
|
-
/**
|
|
12078
|
-
'
|
|
12079
|
-
/**
|
|
12080
|
-
'
|
|
12081
|
-
/**
|
|
12082
|
-
'
|
|
12083
|
-
/** Details
|
|
12084
|
-
'
|
|
12085
|
-
/** ID of the
|
|
12450
|
+
/** Name of the template. Example: "Example Template" */
|
|
12451
|
+
'name': string;
|
|
12452
|
+
/** Description of the template. Example: "This is a sample template." */
|
|
12453
|
+
'description'?: string;
|
|
12454
|
+
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
12455
|
+
'apiVersion': 'v1';
|
|
12456
|
+
/** Details of the project the template will run in. */
|
|
12457
|
+
'project': {
|
|
12458
|
+
/** The ID of the project to use. */
|
|
12086
12459
|
'id': string;
|
|
12087
|
-
|
|
12088
|
-
'
|
|
12089
|
-
|
|
12090
|
-
|
|
12091
|
-
|
|
12092
|
-
|
|
12093
|
-
|
|
12094
|
-
|
|
12095
|
-
|
|
12096
|
-
|
|
12097
|
-
'description'?: string;
|
|
12098
|
-
/** The version of the Northflank API to run the template against. Example: "v1" */
|
|
12099
|
-
'apiVersion': 'v1';
|
|
12100
|
-
/** Details of the project the template will run in. */
|
|
12101
|
-
'project': {
|
|
12102
|
-
/** The ID of the project to use. */
|
|
12103
|
-
'id': string;
|
|
12460
|
+
} | {
|
|
12461
|
+
'spec': {
|
|
12462
|
+
/** The name of the project. Example: "New Project" */
|
|
12463
|
+
'name': string;
|
|
12464
|
+
/** The description of the project. Example: "This is a new project." */
|
|
12465
|
+
'description'?: string;
|
|
12466
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12467
|
+
'color'?: string;
|
|
12468
|
+
/** The region the project will be hosted in. Example: "europe-west" */
|
|
12469
|
+
'region': string;
|
|
12104
12470
|
} | {
|
|
12105
|
-
|
|
12106
|
-
|
|
12107
|
-
|
|
12108
|
-
|
|
12109
|
-
|
|
12110
|
-
|
|
12111
|
-
|
|
12112
|
-
|
|
12113
|
-
'region': string;
|
|
12114
|
-
} | {
|
|
12115
|
-
/** The name of the project. Example: "New Project" */
|
|
12116
|
-
'name': string;
|
|
12117
|
-
/** The description of the project. Example: "This is a new project." */
|
|
12118
|
-
'description'?: string;
|
|
12119
|
-
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12120
|
-
'color'?: string;
|
|
12121
|
-
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
12122
|
-
'clusterId'?: string;
|
|
12123
|
-
};
|
|
12471
|
+
/** The name of the project. Example: "New Project" */
|
|
12472
|
+
'name': string;
|
|
12473
|
+
/** The description of the project. Example: "This is a new project." */
|
|
12474
|
+
'description'?: string;
|
|
12475
|
+
/** The color of the project in the Northflank App. Example: "#EF233C" */
|
|
12476
|
+
'color'?: string;
|
|
12477
|
+
/** The BYOC cluster this project will be hosted in. Example: "gcp-cluster-1" */
|
|
12478
|
+
'clusterId'?: string;
|
|
12124
12479
|
};
|
|
12125
|
-
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12126
|
-
'arguments'?: any;
|
|
12127
|
-
'refs'?: any;
|
|
12128
|
-
'spec': any;
|
|
12129
12480
|
};
|
|
12481
|
+
/** A set of arguments that can be referenced in a template using '${args.argumentName}'. */
|
|
12482
|
+
'arguments'?: any;
|
|
12483
|
+
'spec': any;
|
|
12484
|
+
'refs'?: any;
|
|
12485
|
+
/** Identifier for the template run Example: "3dd592f6-ce63-45ee-acf8-13dc5ec5235c" */
|
|
12486
|
+
'id': string;
|
|
12487
|
+
/** Identifier for the template Example: "example-template" */
|
|
12488
|
+
'templateId': string;
|
|
12489
|
+
/** Status of the template run Example: "pending" */
|
|
12490
|
+
'status': 'pending' | 'running' | 'success' | 'failure';
|
|
12491
|
+
/** time of creation */
|
|
12492
|
+
'createdAt'?: string;
|
|
12493
|
+
/** time of update */
|
|
12494
|
+
'updatedAt'?: string;
|
|
12130
12495
|
};
|
|
12131
12496
|
declare type GetTemplaterunCall = (opts: GetTemplaterunRequest) => Promise<ApiCallResponse<GetTemplaterunResult>>;
|
|
12132
12497
|
declare type GetTemplaterunRequest = {
|