Skip to content

Commit c86939a

Browse files
feat: update schema
1 parent 39f55f4 commit c86939a

File tree

9 files changed

+293
-168
lines changed

9 files changed

+293
-168
lines changed

.changeset/fluffy-rice-repair.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
"@json-types/tsconfig": minor
3+
"@json-types/compose": minor
4+
---
5+
6+
Update schema

packages/compose/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ import schema from "@json-types/compose/schema.json";
2222

2323
TypeScript types generated automatically every night and published when there are changes.
2424

25-
- Last change: 2024-05-16T01:19:02.181Z
25+
- Last change: 2024-07-10T01:24:53.840Z
2626
- Source URL: https://raw.githubusercontent.com/compose-spec/compose-spec/master/schema/compose-spec.json

packages/compose/index.d.ts

Lines changed: 59 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -37,29 +37,29 @@ export type Development = {
3737
export type DefinitionsDeployment = {
3838
mode?: string;
3939
endpoint_mode?: string;
40-
replicas?: number;
40+
replicas?: number | string;
4141
labels?: ListOrDict;
4242
rollback_config?: {
43-
parallelism?: number;
43+
parallelism?: number | string;
4444
delay?: string;
4545
failure_action?: string;
4646
monitor?: string;
47-
max_failure_ratio?: number;
47+
max_failure_ratio?: number | string;
4848
order?: "start-first" | "stop-first";
4949
};
5050
update_config?: {
51-
parallelism?: number;
51+
parallelism?: number | string;
5252
delay?: string;
5353
failure_action?: string;
5454
monitor?: string;
55-
max_failure_ratio?: number;
55+
max_failure_ratio?: number | string;
5656
order?: "start-first" | "stop-first";
5757
};
5858
resources?: {
5959
limits?: {
6060
cpus?: number | string;
6161
memory?: string;
62-
pids?: number;
62+
pids?: number | string;
6363
};
6464
reservations?: {
6565
cpus?: number | string;
@@ -71,15 +71,15 @@ export type DefinitionsDeployment = {
7171
restart_policy?: {
7272
condition?: string;
7373
delay?: string;
74-
max_attempts?: number;
74+
max_attempts?: number | string;
7575
window?: string;
7676
};
7777
placement?: {
7878
constraints?: string[];
7979
preferences?: {
8080
spread?: string;
8181
}[];
82-
max_replicas_per_node?: number;
82+
max_replicas_per_node?: number | string;
8383
};
8484
} & Deployment;
8585
export type ListOrDict =
@@ -94,7 +94,7 @@ export type ListOrDict =
9494
export type DefinitionsGenericResources = {
9595
discrete_resource_spec?: {
9696
kind?: string;
97-
value?: number;
97+
value?: number | string;
9898
};
9999
}[];
100100
export type DefinitionsDevices = {
@@ -107,29 +107,29 @@ export type DefinitionsDevices = {
107107
export type Deployment = {
108108
mode?: string;
109109
endpoint_mode?: string;
110-
replicas?: number;
110+
replicas?: number | string;
111111
labels?: ListOrDict;
112112
rollback_config?: {
113-
parallelism?: number;
113+
parallelism?: number | string;
114114
delay?: string;
115115
failure_action?: string;
116116
monitor?: string;
117-
max_failure_ratio?: number;
117+
max_failure_ratio?: number | string;
118118
order?: "start-first" | "stop-first";
119119
};
120120
update_config?: {
121-
parallelism?: number;
121+
parallelism?: number | string;
122122
delay?: string;
123123
failure_action?: string;
124124
monitor?: string;
125-
max_failure_ratio?: number;
125+
max_failure_ratio?: number | string;
126126
order?: "start-first" | "stop-first";
127127
};
128128
resources?: {
129129
limits?: {
130130
cpus?: number | string;
131131
memory?: string;
132-
pids?: number;
132+
pids?: number | string;
133133
};
134134
reservations?: {
135135
cpus?: number | string;
@@ -141,15 +141,15 @@ export type Deployment = {
141141
restart_policy?: {
142142
condition?: string;
143143
delay?: string;
144-
max_attempts?: number;
144+
max_attempts?: number | string;
145145
window?: string;
146146
};
147147
placement?: {
148148
constraints?: string[];
149149
preferences?: {
150150
spread?: string;
151151
}[];
152-
max_replicas_per_node?: number;
152+
max_replicas_per_node?: number | string;
153153
};
154154
} | null;
155155
export type ServiceConfigOrSecret = (
@@ -159,7 +159,7 @@ export type ServiceConfigOrSecret = (
159159
target?: string;
160160
uid?: string;
161161
gid?: string;
162-
mode?: number;
162+
mode?: number | string;
163163
}
164164
)[];
165165
export type Command = null | string | string[];
@@ -169,7 +169,7 @@ export type EnvFile =
169169
| string
170170
| {
171171
path: string;
172-
required?: boolean;
172+
required?: boolean | string;
173173
}
174174
)[];
175175
/**
@@ -210,15 +210,16 @@ export type DefinitionsNetwork = {
210210
};
211211
external?:
212212
| boolean
213+
| string
213214
| {
214215
/**
215216
* @deprecated
216217
*/
217218
name?: string;
218219
};
219-
internal?: boolean;
220-
enable_ipv6?: boolean;
221-
attachable?: boolean;
220+
internal?: boolean | string;
221+
enable_ipv6?: boolean | string;
222+
attachable?: boolean | string;
222223
labels?: ListOrDict;
223224
} & Network;
224225
export type Network = {
@@ -255,15 +256,16 @@ export type Network = {
255256
};
256257
external?:
257258
| boolean
259+
| string
258260
| {
259261
/**
260262
* @deprecated
261263
*/
262264
name?: string;
263265
};
264-
internal?: boolean;
265-
enable_ipv6?: boolean;
266-
attachable?: boolean;
266+
internal?: boolean | string;
267+
enable_ipv6?: boolean | string;
268+
attachable?: boolean | string;
267269
labels?: ListOrDict;
268270
} | null;
269271
/**
@@ -282,6 +284,7 @@ export type DefinitionsVolume = {
282284
};
283285
external?:
284286
| boolean
287+
| string
285288
| {
286289
/**
287290
* @deprecated
@@ -302,6 +305,7 @@ export type Volume = {
302305
};
303306
external?:
304307
| boolean
308+
| string
305309
| {
306310
/**
307311
* @deprecated
@@ -344,7 +348,7 @@ export interface DefinitionsService {
344348
develop?: DefinitionsDevelopment;
345349
deploy?: DefinitionsDeployment;
346350
annotations?: ListOrDict;
347-
attach?: boolean;
351+
attach?: boolean | string;
348352
build?:
349353
| string
350354
| {
@@ -357,15 +361,15 @@ export interface DefinitionsService {
357361
labels?: ListOrDict;
358362
cache_from?: string[];
359363
cache_to?: string[];
360-
no_cache?: boolean;
364+
no_cache?: boolean | string;
361365
additional_contexts?: ListOrDict;
362366
network?: string;
363-
pull?: boolean;
367+
pull?: boolean | string;
364368
target?: string;
365369
shm_size?: number | string;
366370
extra_hosts?: ListOrDict;
367371
isolation?: string;
368-
privileged?: boolean;
372+
privileged?: boolean | string;
369373
secrets?: ServiceConfigOrSecret;
370374
tags?: string[];
371375
ulimits?: Ulimits;
@@ -376,7 +380,7 @@ export interface DefinitionsService {
376380
device_read_iops?: BlkioLimit[];
377381
device_write_bps?: BlkioLimit[];
378382
device_write_iops?: BlkioLimit[];
379-
weight?: number;
383+
weight?: number | string;
380384
weight_device?: BlkioWeight[];
381385
};
382386
cap_add?: string[];
@@ -386,8 +390,8 @@ export interface DefinitionsService {
386390
command?: Command;
387391
configs?: ServiceConfigOrSecret;
388392
container_name?: string;
389-
cpu_count?: number;
390-
cpu_percent?: number;
393+
cpu_count?: string | number;
394+
cpu_percent?: string | number;
391395
cpu_shares?: number | string;
392396
cpu_quota?: number | string;
393397
cpu_period?: number | string;
@@ -408,7 +412,7 @@ export interface DefinitionsService {
408412
* via the `patternProperty` "^[a-zA-Z0-9._-]+$".
409413
*/
410414
[k: string]: {
411-
restart?: boolean;
415+
restart?: boolean | string;
412416
required?: boolean;
413417
condition: "service_started" | "service_healthy" | "service_completed_successfully";
414418
};
@@ -435,7 +439,7 @@ export interface DefinitionsService {
435439
healthcheck?: DefinitionsHealthcheck;
436440
hostname?: string;
437441
image?: string;
438-
init?: boolean;
442+
init?: boolean | string;
439443
ipc?: string;
440444
isolation?: string;
441445
labels?: ListOrDict;
@@ -453,7 +457,7 @@ export interface DefinitionsService {
453457
mac_address?: string;
454458
mem_limit?: number | string;
455459
mem_reservation?: string | number;
456-
mem_swappiness?: number;
460+
mem_swappiness?: number | string;
457461
memswap_limit?: number | string;
458462
network_mode?: string;
459463
networks?:
@@ -479,8 +483,8 @@ export interface DefinitionsService {
479483
priority?: number;
480484
} | null;
481485
};
482-
oom_kill_disable?: boolean;
483-
oom_score_adj?: number;
486+
oom_kill_disable?: boolean | string;
487+
oom_score_adj?: string | number;
484488
pid?: string | null;
485489
pids_limit?: number | string;
486490
platform?: string;
@@ -491,31 +495,31 @@ export interface DefinitionsService {
491495
name?: string;
492496
mode?: string;
493497
host_ip?: string;
494-
target?: number;
498+
target?: number | string;
495499
published?: string | number;
496500
protocol?: string;
497501
app_protocol?: string;
498502
}
499503
)[];
500-
privileged?: boolean;
504+
privileged?: boolean | string;
501505
profiles?: ListOfStrings;
502506
pull_policy?: "always" | "never" | "if_not_present" | "build" | "missing";
503-
read_only?: boolean;
507+
read_only?: boolean | string;
504508
restart?: string;
505509
runtime?: string;
506-
scale?: number;
510+
scale?: number | string;
507511
security_opt?: string[];
508512
shm_size?: number | string;
509513
secrets?: ServiceConfigOrSecret;
510514
sysctls?: ListOrDict;
511-
stdin_open?: boolean;
515+
stdin_open?: boolean | string;
512516
stop_grace_period?: string;
513517
stop_signal?: string;
514518
storage_opt?: {
515519
[k: string]: unknown;
516520
};
517521
tmpfs?: StringOrList;
518-
tty?: boolean;
522+
tty?: boolean | string;
519523
ulimits?: Ulimits;
520524
user?: string;
521525
uts?: string;
@@ -526,20 +530,20 @@ export interface DefinitionsService {
526530
type: string;
527531
source?: string;
528532
target?: string;
529-
read_only?: boolean;
533+
read_only?: boolean | string;
530534
consistency?: string;
531535
bind?: {
532536
propagation?: string;
533-
create_host_path?: boolean;
537+
create_host_path?: boolean | string;
534538
selinux?: "z" | "Z";
535539
};
536540
volume?: {
537-
nocopy?: boolean;
541+
nocopy?: boolean | string;
538542
subpath?: string;
539543
};
540544
tmpfs?: {
541545
size?: number | string;
542-
mode?: number;
546+
mode?: number | string;
543547
};
544548
}
545549
)[];
@@ -552,10 +556,10 @@ export interface Ulimits {
552556
* via the `patternProperty` "^[a-z]+$".
553557
*/
554558
[k: string]:
555-
| number
559+
| (number | string)
556560
| {
557-
hard: number;
558-
soft: number;
561+
hard: number | string;
562+
soft: number | string;
559563
};
560564
}
561565
export interface BlkioLimit {
@@ -564,12 +568,12 @@ export interface BlkioLimit {
564568
}
565569
export interface BlkioWeight {
566570
path?: string;
567-
weight?: number;
571+
weight?: number | string;
568572
}
569573
export interface DefinitionsHealthcheck {
570-
disable?: boolean;
574+
disable?: boolean | string;
571575
interval?: string;
572-
retries?: number;
576+
retries?: number | string;
573577
test?: string | string[];
574578
timeout?: string;
575579
start_period?: string;
@@ -594,6 +598,7 @@ export interface DefinitionsSecret {
594598
file?: string;
595599
external?:
596600
| boolean
601+
| string
597602
| {
598603
name?: string;
599604
[k: string]: unknown;
@@ -623,6 +628,7 @@ export interface DefinitionsConfig {
623628
file?: string;
624629
external?:
625630
| boolean
631+
| string
626632
| {
627633
/**
628634
* @deprecated

0 commit comments

Comments
 (0)