forked from block65/openapi-codegen
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcommands.ts
More file actions
2649 lines (2441 loc) · 60.1 KB
/
commands.ts
File metadata and controls
2649 lines (2441 loc) · 60.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**
* This file was auto generated by @block65/openapi-codegen
*
* WARN: Do not edit directly.
*
* Generated on 2026-03-17T13:16:20.373Z
*
*/
/** eslint-disable max-classes */
import { Command, jsonStringify, stripUndefined } from "@block65/rest-client";
import type {
BuildPruneCommandInput,
BuildPruneCommandOutput,
BuildPruneCommandQuery,
ConfigCreateCommandInput,
ConfigCreateCommandOutput,
ConfigDeleteCommandInput,
ConfigInspectCommandInput,
ConfigInspectCommandOutput,
ConfigListCommandInput,
ConfigListCommandOutput,
ConfigListCommandQuery,
ConfigUpdateCommandInput,
ConfigUpdateCommandQuery,
ContainerArchiveCommandInput,
ContainerArchiveCommandQuery,
ContainerArchiveInfoCommandInput,
ContainerArchiveInfoCommandQuery,
ContainerAttachCommandInput,
ContainerAttachCommandQuery,
ContainerAttachWebsocketCommandInput,
ContainerAttachWebsocketCommandQuery,
ContainerChangesCommandInput,
ContainerChangesCommandOutput,
ContainerCreateCommandInput,
ContainerCreateCommandOutput,
ContainerCreateCommandQuery,
ContainerDeleteCommandInput,
ContainerDeleteCommandQuery,
ContainerExecCommandInput,
ContainerExecCommandOutput,
ContainerExportCommandInput,
ContainerInspectCommandInput,
ContainerInspectCommandOutput,
ContainerInspectCommandQuery,
ContainerKillCommandInput,
ContainerKillCommandQuery,
ContainerListCommandInput,
ContainerListCommandOutput,
ContainerListCommandQuery,
ContainerLogsCommandInput,
ContainerLogsCommandQuery,
ContainerPauseCommandInput,
ContainerPruneCommandInput,
ContainerPruneCommandOutput,
ContainerPruneCommandQuery,
ContainerRenameCommandInput,
ContainerRenameCommandQuery,
ContainerResizeCommandInput,
ContainerResizeCommandQuery,
ContainerRestartCommandInput,
ContainerRestartCommandQuery,
ContainerStartCommandInput,
ContainerStartCommandQuery,
ContainerStatsCommandInput,
ContainerStatsCommandOutput,
ContainerStatsCommandQuery,
ContainerStopCommandInput,
ContainerStopCommandQuery,
ContainerTopCommandInput,
ContainerTopCommandOutput,
ContainerTopCommandQuery,
ContainerUnpauseCommandInput,
ContainerUpdateCommandInput,
ContainerUpdateCommandOutput,
ContainerWaitCommandInput,
ContainerWaitCommandOutput,
ContainerWaitCommandQuery,
DistributionInspectCommandInput,
DistributionInspectCommandOutput,
ExecInspectCommandInput,
ExecInspectCommandOutput,
ExecResizeCommandInput,
ExecResizeCommandQuery,
ExecStartCommandInput,
GetPluginPrivilegesCommandInput,
GetPluginPrivilegesCommandOutput,
GetPluginPrivilegesCommandQuery,
ImageBuildCommandInput,
ImageBuildCommandQuery,
ImageCommitCommandInput,
ImageCommitCommandOutput,
ImageCommitCommandQuery,
ImageCreateCommandInput,
ImageCreateCommandQuery,
ImageDeleteCommandInput,
ImageDeleteCommandOutput,
ImageDeleteCommandQuery,
ImageGetAllCommandInput,
ImageGetAllCommandQuery,
ImageGetCommandInput,
ImageHistoryCommandInput,
ImageHistoryCommandOutput,
ImageInspectCommandInput,
ImageInspectCommandOutput,
ImageListCommandInput,
ImageListCommandOutput,
ImageListCommandQuery,
ImageLoadCommandInput,
ImageLoadCommandQuery,
ImagePruneCommandInput,
ImagePruneCommandOutput,
ImagePruneCommandQuery,
ImagePushCommandInput,
ImagePushCommandQuery,
ImageSearchCommandInput,
ImageSearchCommandOutput,
ImageSearchCommandQuery,
ImageTagCommandInput,
ImageTagCommandQuery,
NetworkConnectCommandInput,
NetworkCreateCommandInput,
NetworkCreateCommandOutput,
NetworkDeleteCommandInput,
NetworkDisconnectCommandInput,
NetworkInspectCommandInput,
NetworkInspectCommandOutput,
NetworkInspectCommandQuery,
NetworkListCommandInput,
NetworkListCommandOutput,
NetworkListCommandQuery,
NetworkPruneCommandInput,
NetworkPruneCommandOutput,
NetworkPruneCommandQuery,
NodeDeleteCommandInput,
NodeDeleteCommandQuery,
NodeInspectCommandInput,
NodeInspectCommandOutput,
NodeListCommandInput,
NodeListCommandOutput,
NodeListCommandQuery,
NodeUpdateCommandInput,
NodeUpdateCommandQuery,
PluginCreateCommandInput,
PluginCreateCommandQuery,
PluginDeleteCommandInput,
PluginDeleteCommandOutput,
PluginDeleteCommandQuery,
PluginDisableCommandInput,
PluginDisableCommandQuery,
PluginEnableCommandInput,
PluginEnableCommandQuery,
PluginInspectCommandInput,
PluginInspectCommandOutput,
PluginListCommandInput,
PluginListCommandOutput,
PluginListCommandQuery,
PluginPullCommandInput,
PluginPullCommandQuery,
PluginPushCommandInput,
PluginSetCommandInput,
PluginUpgradeCommandInput,
PluginUpgradeCommandQuery,
PutContainerArchiveCommandInput,
PutContainerArchiveCommandQuery,
SecretCreateCommandInput,
SecretCreateCommandOutput,
SecretDeleteCommandInput,
SecretInspectCommandInput,
SecretInspectCommandOutput,
SecretListCommandInput,
SecretListCommandOutput,
SecretListCommandQuery,
SecretUpdateCommandInput,
SecretUpdateCommandQuery,
ServiceCreateCommandInput,
ServiceCreateCommandOutput,
ServiceDeleteCommandInput,
ServiceInspectCommandInput,
ServiceInspectCommandOutput,
ServiceInspectCommandQuery,
ServiceListCommandInput,
ServiceListCommandOutput,
ServiceListCommandQuery,
ServiceLogsCommandInput,
ServiceLogsCommandQuery,
ServiceUpdateCommandInput,
ServiceUpdateCommandOutput,
ServiceUpdateCommandQuery,
SessionCommandInput,
SwarmInitCommandInput,
SwarmInitCommandOutput,
SwarmInspectCommandInput,
SwarmInspectCommandOutput,
SwarmJoinCommandInput,
SwarmLeaveCommandInput,
SwarmLeaveCommandQuery,
SwarmUnlockCommandInput,
SwarmUnlockkeyCommandInput,
SwarmUnlockkeyCommandOutput,
SwarmUpdateCommandInput,
SwarmUpdateCommandQuery,
SystemAuthCommandInput,
SystemAuthCommandOutput,
SystemDataUsageCommandInput,
SystemDataUsageCommandOutput,
SystemDataUsageCommandQuery,
SystemEventsCommandInput,
SystemEventsCommandOutput,
SystemEventsCommandQuery,
SystemInfoCommandInput,
SystemInfoCommandOutput,
SystemPingCommandInput,
SystemPingHeadCommandInput,
SystemVersionCommandInput,
SystemVersionCommandOutput,
TaskInspectCommandInput,
TaskInspectCommandOutput,
TaskListCommandInput,
TaskListCommandOutput,
TaskListCommandQuery,
TaskLogsCommandInput,
TaskLogsCommandQuery,
VolumeCreateCommandInput,
VolumeCreateCommandOutput,
VolumeDeleteCommandInput,
VolumeDeleteCommandQuery,
VolumeInspectCommandInput,
VolumeInspectCommandOutput,
VolumeListCommandInput,
VolumeListCommandOutput,
VolumeListCommandQuery,
VolumePruneCommandInput,
VolumePruneCommandOutput,
VolumePruneCommandQuery,
VolumeUpdateCommandInput,
VolumeUpdateCommandQuery,
} from "./types.js";
/**
* Tagged template literal that applies encodeURIComponent to all interpolated
* values, protecting path integrity from characters like `/` and `#`.
* @example encodePath`/users/${userId}` // "/users/foo%2Fbar"
*/
function encodePath(
strings: TemplateStringsArray,
...values: string[]
): string {
return String.raw({ raw: strings }, ...values.map(encodeURIComponent));
}
/**
* Returns a list of containers. For details on the format, see the
* [inspect endpoint](#operation/ContainerInspect).
*
* Note that it uses a different, smaller representation of a container
* than inspecting a single container. For example, the list of linked
* containers is not propagated .
*
* @summary List containers
*/
export class ContainerListCommand extends Command<
ContainerListCommandInput,
ContainerListCommandOutput,
ContainerListCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerListCommandInput) {
const { all, limit, size, filters } = input;
super(
"/containers/json",
undefined,
stripUndefined({ all, limit, size, filters }),
);
}
}
/**
* ContainerCreateCommand
*
* @summary Create a container
*/
export class ContainerCreateCommand extends Command<
ContainerCreateCommandInput,
ContainerCreateCommandOutput,
ContainerCreateCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerCreateCommandInput) {
const { name, platform, ...body } = input;
super(
"/containers/create",
jsonStringify(body),
stripUndefined({ name, platform }),
);
}
}
/**
* Return low-level information about a container.
*
* @summary Inspect a container
*/
export class ContainerInspectCommand extends Command<
ContainerInspectCommandInput,
ContainerInspectCommandOutput,
ContainerInspectCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerInspectCommandInput) {
const { id, size } = input;
super(
encodePath`/containers/${id}/json`,
undefined,
stripUndefined({ size }),
);
}
}
/**
* On Unix systems, this is done by running the `ps` command. This endpoint
* is not supported on Windows.
*
* @summary List processes running inside a container
*/
export class ContainerTopCommand extends Command<
ContainerTopCommandInput,
ContainerTopCommandOutput,
ContainerTopCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerTopCommandInput) {
const { id, ps_args } = input;
super(
encodePath`/containers/${id}/top`,
undefined,
stripUndefined({ ps_args }),
);
}
}
/**
* Get `stdout` and `stderr` logs from a container.
*
* Note: This endpoint works only for containers with the `json-file` or
* `journald` logging driver.
*
* @summary Get container logs
*/
export class ContainerLogsCommand extends Command<
ContainerLogsCommandInput,
unknown,
ContainerLogsCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerLogsCommandInput) {
const { id, follow, stdout, stderr, since, until, timestamps, tail } =
input;
super(
encodePath`/containers/${id}/logs`,
undefined,
stripUndefined({
follow,
stdout,
stderr,
since,
until,
timestamps,
tail,
}),
);
}
}
/**
* Returns which files in a container's filesystem have been added, deleted,
* or modified. The `Kind` of modification can be one of:
*
* - `0`: Modified ("C")
* - `1`: Added ("A")
* - `2`: Deleted ("D")
*
* @summary Get changes on a container’s filesystem
*/
export class ContainerChangesCommand extends Command<
ContainerChangesCommandInput,
ContainerChangesCommandOutput
> {
public override method = "get" as const;
constructor(input: ContainerChangesCommandInput) {
const { id } = input;
super(encodePath`/containers/${id}/changes`);
}
}
/**
* Export the contents of a container as a tarball.
*
* @summary Export a container
*/
export class ContainerExportCommand extends Command<
ContainerExportCommandInput,
unknown
> {
public override method = "get" as const;
constructor(input: ContainerExportCommandInput) {
const { id } = input;
super(encodePath`/containers/${id}/export`);
}
}
/**
* This endpoint returns a live stream of a container’s resource usage
* statistics.
*
* The `precpu_stats` is the CPU statistic of the *previous* read, and is
* used to calculate the CPU usage percentage. It is not an exact copy
* of the `cpu_stats` field.
*
* If either `precpu_stats.online_cpus` or `cpu_stats.online_cpus` is
* nil then for compatibility with older daemons the length of the
* corresponding `cpu_usage.percpu_usage` array should be used.
*
* On a cgroup v2 host, the following fields are not set
* * `blkio_stats`: all fields other than `io_service_bytes_recursive`
* * `cpu_stats`: `cpu_usage.percpu_usage`
* * `memory_stats`: `max_usage` and `failcnt`
* Also, `memory_stats.stats` fields are incompatible with cgroup v1.
*
* To calculate the values shown by the `stats` command of the docker cli tool
* the following formulas can be used:
* * used_memory = `memory_stats.usage - memory_stats.stats.cache`
* * available_memory = `memory_stats.limit`
* * Memory usage % = `(used_memory / available_memory) * 100.0`
* * cpu_delta = `cpu_stats.cpu_usage.total_usage -
* precpu_stats.cpu_usage.total_usage`
* * system_cpu_delta = `cpu_stats.system_cpu_usage -
* precpu_stats.system_cpu_usage`
* * number_cpus = `length(cpu_stats.cpu_usage.percpu_usage)` or
* `cpu_stats.online_cpus`
* * CPU usage % = `(cpu_delta / system_cpu_delta) * number_cpus * 100.0`
*
* @summary Get container stats based on resource usage
*/
export class ContainerStatsCommand extends Command<
ContainerStatsCommandInput,
ContainerStatsCommandOutput,
ContainerStatsCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerStatsCommandInput) {
const { id, stream, oneshot } = input;
super(
encodePath`/containers/${id}/stats`,
undefined,
stripUndefined({ stream, oneshot }),
);
}
}
/**
* Resize the TTY for a container.
*
* @summary Resize a container TTY
*/
export class ContainerResizeCommand extends Command<
ContainerResizeCommandInput,
unknown,
ContainerResizeCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerResizeCommandInput) {
const { id, h, w } = input;
super(
encodePath`/containers/${id}/resize`,
undefined,
stripUndefined({ h, w }),
);
}
}
/**
* ContainerStartCommand
*
* @summary Start a container
*/
export class ContainerStartCommand extends Command<
ContainerStartCommandInput,
undefined,
ContainerStartCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerStartCommandInput) {
const { id, detachKeys } = input;
super(
encodePath`/containers/${id}/start`,
undefined,
stripUndefined({ detachKeys }),
);
}
}
/**
* ContainerStopCommand
*
* @summary Stop a container
*/
export class ContainerStopCommand extends Command<
ContainerStopCommandInput,
undefined,
ContainerStopCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerStopCommandInput) {
const { id, signal, t } = input;
super(
encodePath`/containers/${id}/stop`,
undefined,
stripUndefined({ signal, t }),
);
}
}
/**
* ContainerRestartCommand
*
* @summary Restart a container
*/
export class ContainerRestartCommand extends Command<
ContainerRestartCommandInput,
undefined,
ContainerRestartCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerRestartCommandInput) {
const { id, signal, t } = input;
super(
encodePath`/containers/${id}/restart`,
undefined,
stripUndefined({ signal, t }),
);
}
}
/**
* Send a POSIX signal to a container, defaulting to killing to the
* container.
*
* @summary Kill a container
*/
export class ContainerKillCommand extends Command<
ContainerKillCommandInput,
undefined,
ContainerKillCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerKillCommandInput) {
const { id, signal } = input;
super(
encodePath`/containers/${id}/kill`,
undefined,
stripUndefined({ signal }),
);
}
}
/**
* Change various configuration options of a container without having to
* recreate it.
*
* @summary Update a container
*/
export class ContainerUpdateCommand extends Command<
ContainerUpdateCommandInput,
ContainerUpdateCommandOutput
> {
public override method = "post" as const;
constructor(input: ContainerUpdateCommandInput) {
const { id, ...body } = input;
super(encodePath`/containers/${id}/update`, jsonStringify(body));
}
}
/**
* ContainerRenameCommand
*
* @summary Rename a container
*/
export class ContainerRenameCommand extends Command<
ContainerRenameCommandInput,
undefined,
ContainerRenameCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerRenameCommandInput) {
const { id, name } = input;
super(
encodePath`/containers/${id}/rename`,
undefined,
stripUndefined({ name }),
);
}
}
/**
* Use the freezer cgroup to suspend all processes in a container.
*
* Traditionally, when suspending a process the `SIGSTOP` signal is used,
* which is observable by the process being suspended. With the freezer
* cgroup the process is unaware, and unable to capture, that it is being
* suspended, and subsequently resumed.
*
* @summary Pause a container
*/
export class ContainerPauseCommand extends Command<
ContainerPauseCommandInput,
undefined
> {
public override method = "post" as const;
constructor(input: ContainerPauseCommandInput) {
const { id } = input;
super(encodePath`/containers/${id}/pause`);
}
}
/**
* Resume a container which has been paused.
*
* @summary Unpause a container
*/
export class ContainerUnpauseCommand extends Command<
ContainerUnpauseCommandInput,
undefined
> {
public override method = "post" as const;
constructor(input: ContainerUnpauseCommandInput) {
const { id } = input;
super(encodePath`/containers/${id}/unpause`);
}
}
/**
* Attach to a container to read its output or send it input. You can attach
* to the same container multiple times and you can reattach to containers
* that have been detached.
*
* Either the `stream` or `logs` parameter must be `true` for this endpoint
* to do anything.
*
* See the [documentation for the `docker attach`
* command](https://docs.docker.com/engine/reference/commandline/attach/)
* for more details.
*
* ### Hijacking
*
* This endpoint hijacks the HTTP connection to transport `stdin`, `stdout`,
* and `stderr` on the same socket.
*
* This is the response from the daemon for an attach request:
*
* ```
* HTTP/1.1 200 OK
* Content-Type: application/vnd.docker.raw-stream
*
* [STREAM]
* ```
*
* After the headers and two new lines, the TCP connection can now be used
* for raw, bidirectional communication between the client and server.
*
* To hint potential proxies about connection hijacking, the Docker client
* can also optionally send connection upgrade headers.
*
* For example, the client sends this request to upgrade the connection:
*
* ```
* POST /containers/16253994b7c4/attach?stream=1&stdout=1 HTTP/1.1
* Upgrade: tcp
* Connection: Upgrade
* ```
*
* The Docker daemon will respond with a `101 UPGRADED` response, and will
* similarly follow with the raw stream:
*
* ```
* HTTP/1.1 101 UPGRADED
* Content-Type: application/vnd.docker.raw-stream
* Connection: Upgrade
* Upgrade: tcp
*
* [STREAM]
* ```
*
* ### Stream format
*
* When the TTY setting is disabled in [`POST
* /containers/create`](#operation/ContainerCreate),
* the HTTP Content-Type header is set to
* application/vnd.docker.multiplexed-stream
* and the stream over the hijacked connected is multiplexed to separate out
* `stdout` and `stderr`. The stream consists of a series of frames, each
* containing a header and a payload.
*
* The header contains the information which the stream writes (`stdout` or
* `stderr`). It also contains the size of the associated frame encoded in
* the last four bytes (`uint32`).
*
* It is encoded on the first eight bytes like this:
*
* ```go
* header := [8]byte{STREAM_TYPE, 0, 0, 0, SIZE1, SIZE2, SIZE3, SIZE4}
* ```
*
* `STREAM_TYPE` can be:
*
* - 0: `stdin` (is written on `stdout`)
* - 1: `stdout`
* - 2: `stderr`
*
* `SIZE1, SIZE2, SIZE3, SIZE4` are the four bytes of the `uint32` size
* encoded as big endian.
*
* Following the header is the payload, which is the specified number of
* bytes of `STREAM_TYPE`.
*
* The simplest way to implement this protocol is the following:
*
* 1. Read 8 bytes.
* 2. Choose `stdout` or `stderr` depending on the first byte.
* 3. Extract the frame size from the last four bytes.
* 4. Read the extracted size and output it on the correct output.
* 5. Goto 1.
*
* ### Stream format when using a TTY
*
* When the TTY setting is enabled in [`POST
* /containers/create`](#operation/ContainerCreate),
* the stream is not multiplexed. The data exchanged over the hijacked
* connection is simply the raw data from the process PTY and client's
* `stdin`.
*
* @summary Attach to a container
*/
export class ContainerAttachCommand extends Command<
ContainerAttachCommandInput,
unknown,
ContainerAttachCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerAttachCommandInput) {
const { id, detachKeys, logs, stream, stdin, stdout, stderr } = input;
super(
encodePath`/containers/${id}/attach`,
undefined,
stripUndefined({ detachKeys, logs, stream, stdin, stdout, stderr }),
);
}
}
/**
* ContainerAttachWebsocketCommand
*
* @summary Attach to a container via a websocket
*/
export class ContainerAttachWebsocketCommand extends Command<
ContainerAttachWebsocketCommandInput,
unknown,
ContainerAttachWebsocketCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerAttachWebsocketCommandInput) {
const { id, detachKeys, logs, stream, stdin, stdout, stderr } = input;
super(
encodePath`/containers/${id}/attach/ws`,
undefined,
stripUndefined({ detachKeys, logs, stream, stdin, stdout, stderr }),
);
}
}
/**
* Block until a container stops, then returns the exit code.
*
* @summary Wait for a container
*/
export class ContainerWaitCommand extends Command<
ContainerWaitCommandInput,
ContainerWaitCommandOutput,
ContainerWaitCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerWaitCommandInput) {
const { id, condition } = input;
super(
encodePath`/containers/${id}/wait`,
undefined,
stripUndefined({ condition }),
);
}
}
/**
* ContainerDeleteCommand
*
* @summary Remove a container
*/
export class ContainerDeleteCommand extends Command<
ContainerDeleteCommandInput,
undefined,
ContainerDeleteCommandQuery
> {
public override method = "delete" as const;
constructor(input: ContainerDeleteCommandInput) {
const { id, v, force, link } = input;
super(
encodePath`/containers/${id}`,
undefined,
stripUndefined({ v, force, link }),
);
}
}
/**
* Get a tar archive of a resource in the filesystem of container id.
*
* @summary Get an archive of a filesystem resource in a container
*/
export class ContainerArchiveCommand extends Command<
ContainerArchiveCommandInput,
unknown,
ContainerArchiveCommandQuery
> {
public override method = "get" as const;
constructor(input: ContainerArchiveCommandInput) {
const { id, path } = input;
super(
encodePath`/containers/${id}/archive`,
undefined,
stripUndefined({ path }),
);
}
}
/**
* Upload a tar archive to be extracted to a path in the filesystem of
* container id.
* `path` parameter is asserted to be a directory. If it exists as a file, 400
* error
* will be returned with message "not a directory".
*
* @summary Extract an archive of files or folders to a directory in a container
*/
export class PutContainerArchiveCommand extends Command<
PutContainerArchiveCommandInput,
unknown,
PutContainerArchiveCommandQuery
> {
public override method = "put" as const;
constructor(input: PutContainerArchiveCommandInput) {
const { id, path, noOverwriteDirNonDir, copyUIDGID, body } = input;
super(
encodePath`/containers/${id}/archive`,
body,
stripUndefined({ path, noOverwriteDirNonDir, copyUIDGID }),
);
}
}
/**
* A response header `X-Docker-Container-Path-Stat` is returned, containing
* a base64 - encoded JSON object with some filesystem header information
* about the path.
*
* @summary Get information about files in a container
*/
export class ContainerArchiveInfoCommand extends Command<
ContainerArchiveInfoCommandInput,
unknown,
ContainerArchiveInfoCommandQuery
> {
public override method = "head" as const;
constructor(input: ContainerArchiveInfoCommandInput) {
const { id, path } = input;
super(
encodePath`/containers/${id}/archive`,
undefined,
stripUndefined({ path }),
);
}
}
/**
* ContainerPruneCommand
*
* @summary Delete stopped containers
*/
export class ContainerPruneCommand extends Command<
ContainerPruneCommandInput,
ContainerPruneCommandOutput,
ContainerPruneCommandQuery
> {
public override method = "post" as const;
constructor(input: ContainerPruneCommandInput) {
const { filters } = input;
super("/containers/prune", undefined, stripUndefined({ filters }));
}
}
/**
* Returns a list of images on the server. Note that it uses a different,
* smaller representation of an image than inspecting a single image.
*
* @summary List Images
*/
export class ImageListCommand extends Command<
ImageListCommandInput,
ImageListCommandOutput,
ImageListCommandQuery
> {
public override method = "get" as const;
constructor(input: ImageListCommandInput) {
const { all, filters, sharedsize, digests } = input;
super(
"/images/json",
undefined,
stripUndefined({ all, filters, sharedsize, digests }),
);
}
}
/**
* Build an image from a tar archive with a `Dockerfile` in it.
*
* The `Dockerfile` specifies how the image is built from the tar archive. It
* is typically in the archive's root, but can be at a different path or have
* a different name by specifying the `dockerfile` parameter. [See the
* `Dockerfile` reference for more
* information](https://docs.docker.com/engine/reference/builder/).
*
* The Docker daemon performs a preliminary validation of the `Dockerfile`
* before starting the build, and returns an error if the syntax is incorrect.
* After that, each instruction is run one-by-one until the ID of the new
* image is output.
*
* The build is canceled if the client drops the connection by quitting or
* being killed.
*
* @summary Build an image
*/
export class ImageBuildCommand extends Command<
ImageBuildCommandInput,
unknown,
ImageBuildCommandQuery
> {
public override method = "post" as const;
constructor(input: ImageBuildCommandInput) {
const {
dockerfile,
t,
extrahosts,
remote,
q,
nocache,
cachefrom,
pull,
rm,
forcerm,
memory,
memswap,
cpushares,
cpusetcpus,
cpuperiod,
cpuquota,