@argos-ci/api-client 0.18.0 → 0.18.1-alpha.0
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/index.d.mts +306 -2
- package/package.json +2 -2
package/dist/index.d.mts
CHANGED
|
@@ -25,6 +25,70 @@ interface paths {
|
|
|
25
25
|
patch?: never;
|
|
26
26
|
trace?: never;
|
|
27
27
|
};
|
|
28
|
+
"/deployments": {
|
|
29
|
+
parameters: {
|
|
30
|
+
query?: never;
|
|
31
|
+
header?: never;
|
|
32
|
+
path?: never;
|
|
33
|
+
cookie?: never;
|
|
34
|
+
};
|
|
35
|
+
get?: never;
|
|
36
|
+
put?: never;
|
|
37
|
+
post: operations["createDeployment"];
|
|
38
|
+
delete?: never;
|
|
39
|
+
options?: never;
|
|
40
|
+
head?: never;
|
|
41
|
+
patch?: never;
|
|
42
|
+
trace?: never;
|
|
43
|
+
};
|
|
44
|
+
"/deployments/{deploymentId}": {
|
|
45
|
+
parameters: {
|
|
46
|
+
query?: never;
|
|
47
|
+
header?: never;
|
|
48
|
+
path?: never;
|
|
49
|
+
cookie?: never;
|
|
50
|
+
};
|
|
51
|
+
get: operations["getDeployment"];
|
|
52
|
+
put?: never;
|
|
53
|
+
post?: never;
|
|
54
|
+
delete?: never;
|
|
55
|
+
options?: never;
|
|
56
|
+
head?: never;
|
|
57
|
+
patch?: never;
|
|
58
|
+
trace?: never;
|
|
59
|
+
};
|
|
60
|
+
"/deployments/{deploymentId}/finalize": {
|
|
61
|
+
parameters: {
|
|
62
|
+
query?: never;
|
|
63
|
+
header?: never;
|
|
64
|
+
path?: never;
|
|
65
|
+
cookie?: never;
|
|
66
|
+
};
|
|
67
|
+
get?: never;
|
|
68
|
+
put?: never;
|
|
69
|
+
post: operations["finalizeDeployment"];
|
|
70
|
+
delete?: never;
|
|
71
|
+
options?: never;
|
|
72
|
+
head?: never;
|
|
73
|
+
patch?: never;
|
|
74
|
+
trace?: never;
|
|
75
|
+
};
|
|
76
|
+
"/deployments/resolve/{domain}": {
|
|
77
|
+
parameters: {
|
|
78
|
+
query?: never;
|
|
79
|
+
header?: never;
|
|
80
|
+
path?: never;
|
|
81
|
+
cookie?: never;
|
|
82
|
+
};
|
|
83
|
+
get: operations["resolveDeploymentDomain"];
|
|
84
|
+
put?: never;
|
|
85
|
+
post?: never;
|
|
86
|
+
delete?: never;
|
|
87
|
+
options?: never;
|
|
88
|
+
head?: never;
|
|
89
|
+
patch?: never;
|
|
90
|
+
trace?: never;
|
|
91
|
+
};
|
|
28
92
|
"/builds/finalize": {
|
|
29
93
|
parameters: {
|
|
30
94
|
query?: never;
|
|
@@ -177,7 +241,8 @@ interface paths {
|
|
|
177
241
|
type webhooks = Record<string, never>;
|
|
178
242
|
interface components {
|
|
179
243
|
schemas: {
|
|
180
|
-
/** @description SHA1 hash */Sha1Hash: string;
|
|
244
|
+
/** @description SHA1 hash */Sha1Hash: string;
|
|
245
|
+
GitBranch: string; /** @description SHA256 hash */
|
|
181
246
|
Sha256Hash: string;
|
|
182
247
|
/**
|
|
183
248
|
* @description A unique identifier for the build
|
|
@@ -516,7 +581,7 @@ interface operations {
|
|
|
516
581
|
content: {
|
|
517
582
|
"application/json": {
|
|
518
583
|
/** @description The commit the build is running on */commit: components["schemas"]["Sha1Hash"]; /** @description The branch the build is running on */
|
|
519
|
-
branch:
|
|
584
|
+
branch: components["schemas"]["GitBranch"]; /** @description Keys of screenshot files */
|
|
520
585
|
screenshotKeys: components["schemas"]["Sha256Hash"][]; /** @description Keys of Playwright trace files */
|
|
521
586
|
pwTraceKeys?: components["schemas"]["Sha256Hash"][]; /** @description The name of the build (for multi-build setups) */
|
|
522
587
|
name?: string | null; /** @description Whether to run the build in parallel */
|
|
@@ -596,6 +661,245 @@ interface operations {
|
|
|
596
661
|
};
|
|
597
662
|
};
|
|
598
663
|
};
|
|
664
|
+
createDeployment: {
|
|
665
|
+
parameters: {
|
|
666
|
+
query?: never;
|
|
667
|
+
header?: never;
|
|
668
|
+
path?: never;
|
|
669
|
+
cookie?: never;
|
|
670
|
+
};
|
|
671
|
+
requestBody?: {
|
|
672
|
+
content: {
|
|
673
|
+
"application/json": {
|
|
674
|
+
/** @description The commit SHA */commit: components["schemas"]["Sha1Hash"]; /** @description The branch name */
|
|
675
|
+
branch: components["schemas"]["GitBranch"]; /** @description The pull request number */
|
|
676
|
+
prNumber?: number | null;
|
|
677
|
+
/**
|
|
678
|
+
* @description The deployment environment
|
|
679
|
+
* @default preview
|
|
680
|
+
* @enum {string}
|
|
681
|
+
*/
|
|
682
|
+
environment?: "preview" | "production"; /** @description List of files to deploy */
|
|
683
|
+
files: {
|
|
684
|
+
path: string;
|
|
685
|
+
hash: components["schemas"]["Sha256Hash"];
|
|
686
|
+
size: number;
|
|
687
|
+
contentType: string;
|
|
688
|
+
}[];
|
|
689
|
+
};
|
|
690
|
+
};
|
|
691
|
+
};
|
|
692
|
+
responses: {
|
|
693
|
+
/** @description Deployment created */201: {
|
|
694
|
+
headers: {
|
|
695
|
+
[name: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
content: {
|
|
698
|
+
"application/json": {
|
|
699
|
+
deploymentId: string;
|
|
700
|
+
uploadFiles: {
|
|
701
|
+
path: string;
|
|
702
|
+
hash: string; /** Format: uri */
|
|
703
|
+
uploadUrl: string;
|
|
704
|
+
}[];
|
|
705
|
+
};
|
|
706
|
+
};
|
|
707
|
+
}; /** @description Invalid parameters */
|
|
708
|
+
400: {
|
|
709
|
+
headers: {
|
|
710
|
+
[name: string]: unknown;
|
|
711
|
+
};
|
|
712
|
+
content: {
|
|
713
|
+
"application/json": components["schemas"]["Error"];
|
|
714
|
+
};
|
|
715
|
+
}; /** @description Unauthorized */
|
|
716
|
+
401: {
|
|
717
|
+
headers: {
|
|
718
|
+
[name: string]: unknown;
|
|
719
|
+
};
|
|
720
|
+
content: {
|
|
721
|
+
"application/json": components["schemas"]["Error"];
|
|
722
|
+
};
|
|
723
|
+
}; /** @description Server error */
|
|
724
|
+
500: {
|
|
725
|
+
headers: {
|
|
726
|
+
[name: string]: unknown;
|
|
727
|
+
};
|
|
728
|
+
content: {
|
|
729
|
+
"application/json": components["schemas"]["Error"];
|
|
730
|
+
};
|
|
731
|
+
};
|
|
732
|
+
};
|
|
733
|
+
};
|
|
734
|
+
getDeployment: {
|
|
735
|
+
parameters: {
|
|
736
|
+
query?: never;
|
|
737
|
+
header?: never;
|
|
738
|
+
path: {
|
|
739
|
+
/** @description The deployment ID */deploymentId: string;
|
|
740
|
+
};
|
|
741
|
+
cookie?: never;
|
|
742
|
+
};
|
|
743
|
+
requestBody?: never;
|
|
744
|
+
responses: {
|
|
745
|
+
/** @description Deployment details */200: {
|
|
746
|
+
headers: {
|
|
747
|
+
[name: string]: unknown;
|
|
748
|
+
};
|
|
749
|
+
content: {
|
|
750
|
+
"application/json": {
|
|
751
|
+
id: string; /** @enum {string} */
|
|
752
|
+
status: "pending" | "ready" | "error"; /** @enum {string} */
|
|
753
|
+
environment: "preview" | "production";
|
|
754
|
+
branch: components["schemas"]["GitBranch"];
|
|
755
|
+
commitSha: components["schemas"]["Sha256Hash"]; /** Format: uri */
|
|
756
|
+
url: string;
|
|
757
|
+
createdAt: string;
|
|
758
|
+
};
|
|
759
|
+
};
|
|
760
|
+
}; /** @description Invalid parameters */
|
|
761
|
+
400: {
|
|
762
|
+
headers: {
|
|
763
|
+
[name: string]: unknown;
|
|
764
|
+
};
|
|
765
|
+
content: {
|
|
766
|
+
"application/json": components["schemas"]["Error"];
|
|
767
|
+
};
|
|
768
|
+
}; /** @description Unauthorized */
|
|
769
|
+
401: {
|
|
770
|
+
headers: {
|
|
771
|
+
[name: string]: unknown;
|
|
772
|
+
};
|
|
773
|
+
content: {
|
|
774
|
+
"application/json": components["schemas"]["Error"];
|
|
775
|
+
};
|
|
776
|
+
}; /** @description Not found */
|
|
777
|
+
404: {
|
|
778
|
+
headers: {
|
|
779
|
+
[name: string]: unknown;
|
|
780
|
+
};
|
|
781
|
+
content: {
|
|
782
|
+
"application/json": components["schemas"]["Error"];
|
|
783
|
+
};
|
|
784
|
+
}; /** @description Server error */
|
|
785
|
+
500: {
|
|
786
|
+
headers: {
|
|
787
|
+
[name: string]: unknown;
|
|
788
|
+
};
|
|
789
|
+
content: {
|
|
790
|
+
"application/json": components["schemas"]["Error"];
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
};
|
|
794
|
+
};
|
|
795
|
+
finalizeDeployment: {
|
|
796
|
+
parameters: {
|
|
797
|
+
query?: never;
|
|
798
|
+
header?: never;
|
|
799
|
+
path: {
|
|
800
|
+
/** @description The deployment ID */deploymentId: string;
|
|
801
|
+
};
|
|
802
|
+
cookie?: never;
|
|
803
|
+
};
|
|
804
|
+
requestBody?: never;
|
|
805
|
+
responses: {
|
|
806
|
+
/** @description Deployment finalized */200: {
|
|
807
|
+
headers: {
|
|
808
|
+
[name: string]: unknown;
|
|
809
|
+
};
|
|
810
|
+
content: {
|
|
811
|
+
"application/json": {
|
|
812
|
+
id: string; /** @enum {string} */
|
|
813
|
+
status: "pending" | "ready" | "error"; /** @enum {string} */
|
|
814
|
+
environment: "preview" | "production";
|
|
815
|
+
branch: components["schemas"]["GitBranch"];
|
|
816
|
+
commitSha: components["schemas"]["Sha256Hash"]; /** Format: uri */
|
|
817
|
+
url: string;
|
|
818
|
+
createdAt: string;
|
|
819
|
+
};
|
|
820
|
+
};
|
|
821
|
+
}; /** @description Invalid parameters */
|
|
822
|
+
400: {
|
|
823
|
+
headers: {
|
|
824
|
+
[name: string]: unknown;
|
|
825
|
+
};
|
|
826
|
+
content: {
|
|
827
|
+
"application/json": components["schemas"]["Error"];
|
|
828
|
+
};
|
|
829
|
+
}; /** @description Unauthorized */
|
|
830
|
+
401: {
|
|
831
|
+
headers: {
|
|
832
|
+
[name: string]: unknown;
|
|
833
|
+
};
|
|
834
|
+
content: {
|
|
835
|
+
"application/json": components["schemas"]["Error"];
|
|
836
|
+
};
|
|
837
|
+
}; /** @description Not found */
|
|
838
|
+
404: {
|
|
839
|
+
headers: {
|
|
840
|
+
[name: string]: unknown;
|
|
841
|
+
};
|
|
842
|
+
content: {
|
|
843
|
+
"application/json": components["schemas"]["Error"];
|
|
844
|
+
};
|
|
845
|
+
}; /** @description Server error */
|
|
846
|
+
500: {
|
|
847
|
+
headers: {
|
|
848
|
+
[name: string]: unknown;
|
|
849
|
+
};
|
|
850
|
+
content: {
|
|
851
|
+
"application/json": components["schemas"]["Error"];
|
|
852
|
+
};
|
|
853
|
+
};
|
|
854
|
+
};
|
|
855
|
+
};
|
|
856
|
+
resolveDeploymentDomain: {
|
|
857
|
+
parameters: {
|
|
858
|
+
query?: never;
|
|
859
|
+
header?: never;
|
|
860
|
+
path: {
|
|
861
|
+
/** @description A deployment domain or URL */domain: string;
|
|
862
|
+
};
|
|
863
|
+
cookie?: never;
|
|
864
|
+
};
|
|
865
|
+
requestBody?: never;
|
|
866
|
+
responses: {
|
|
867
|
+
/** @description Deployment domain resolved */200: {
|
|
868
|
+
headers: {
|
|
869
|
+
[name: string]: unknown;
|
|
870
|
+
};
|
|
871
|
+
content: {
|
|
872
|
+
"application/json": {
|
|
873
|
+
deploymentId: string;
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
}; /** @description Invalid parameters */
|
|
877
|
+
400: {
|
|
878
|
+
headers: {
|
|
879
|
+
[name: string]: unknown;
|
|
880
|
+
};
|
|
881
|
+
content: {
|
|
882
|
+
"application/json": components["schemas"]["Error"];
|
|
883
|
+
};
|
|
884
|
+
}; /** @description Not found */
|
|
885
|
+
404: {
|
|
886
|
+
headers: {
|
|
887
|
+
[name: string]: unknown;
|
|
888
|
+
};
|
|
889
|
+
content: {
|
|
890
|
+
"application/json": components["schemas"]["Error"];
|
|
891
|
+
};
|
|
892
|
+
}; /** @description Server error */
|
|
893
|
+
500: {
|
|
894
|
+
headers: {
|
|
895
|
+
[name: string]: unknown;
|
|
896
|
+
};
|
|
897
|
+
content: {
|
|
898
|
+
"application/json": components["schemas"]["Error"];
|
|
899
|
+
};
|
|
900
|
+
};
|
|
901
|
+
};
|
|
902
|
+
};
|
|
599
903
|
finalizeBuilds: {
|
|
600
904
|
parameters: {
|
|
601
905
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@argos-ci/api-client",
|
|
3
3
|
"description": "Argos API Client library.",
|
|
4
|
-
"version": "0.18.0",
|
|
4
|
+
"version": "0.18.1-alpha.0+4f1cfa9",
|
|
5
5
|
"author": "Smooth Code",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"repository": {
|
|
@@ -52,5 +52,5 @@
|
|
|
52
52
|
"debug": "^4.4.3",
|
|
53
53
|
"openapi-fetch": "^0.17.0"
|
|
54
54
|
},
|
|
55
|
-
"gitHead": "
|
|
55
|
+
"gitHead": "4f1cfa9db40cef760779b553b622524abcf6b199"
|
|
56
56
|
}
|