Skip to content

Commit 532c9c8

Browse files
authored
feat: add new properties and descriptions to Traefik v3 JSON schema and example (SchemaStore#5302)
1 parent c508409 commit 532c9c8

2 files changed

Lines changed: 53 additions & 5 deletions

File tree

src/schemas/json/traefik-v3.json

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,31 @@
2727
"certificatesDuration": {
2828
"type": "integer"
2929
},
30+
"clientResponseHeaderTimeout": {
31+
"type": "string"
32+
},
33+
"clientTimeout": {
34+
"type": "string"
35+
},
36+
"disableCommonName": {
37+
"type": "boolean"
38+
},
3039
"dnsChallenge": {
3140
"$ref": "#/$defs/acmeDNSChallenge"
3241
},
3342
"eab": {
3443
"$ref": "#/$defs/acmeEAB"
3544
},
3645
"email": {
37-
"type": "string"
46+
"type": "string",
47+
"description": "Email address used for ACME account registration. This is the contact email for the certificate authority."
48+
},
49+
"emailAddresses": {
50+
"items": {
51+
"type": "string"
52+
},
53+
"type": ["array", "null"],
54+
"description": "Email addresses to include in the Certificate Signing Request (CSR). These are different from the ACME registration email and are embedded in the certificate itself."
3855
},
3956
"httpChallenge": {
4057
"$ref": "#/$defs/acmeHTTPChallenge"
@@ -45,6 +62,9 @@
4562
"preferredChain": {
4663
"type": "string"
4764
},
65+
"profile": {
66+
"type": "string"
67+
},
4868
"storage": {
4969
"type": "string"
5070
},
@@ -58,10 +78,12 @@
5878
"additionalProperties": false,
5979
"properties": {
6080
"delayBeforeCheck": {
61-
"type": "string"
81+
"type": "string",
82+
"description": "DEPRECATED. Delay before checking propagation. Use acme.dnsChallenge.propagation.delayBeforeChecks instead."
6283
},
6384
"disablePropagationCheck": {
64-
"type": "boolean"
85+
"type": "boolean",
86+
"description": "DEPRECATED. Disable propagation check. Use acme.dnsChallenge.propagation.disableChecks instead."
6587
},
6688
"propagation": {
6789
"$ref": "#/$defs/acmePropagation"
@@ -93,6 +115,10 @@
93115
"acmeHTTPChallenge": {
94116
"additionalProperties": false,
95117
"properties": {
118+
"delay": {
119+
"type": "string",
120+
"description": "Delay between the creation of the challenge and the validation (duration format, e.g., 30s, 1m)."
121+
},
96122
"entryPoint": {
97123
"type": "string"
98124
}
@@ -119,6 +145,12 @@
119145
},
120146
"acmeTLSChallenge": {
121147
"additionalProperties": false,
148+
"properties": {
149+
"delay": {
150+
"type": "string",
151+
"description": "Delay between the creation of the challenge and the validation (duration format, e.g., 30s, 1m)."
152+
}
153+
},
122154
"type": "object"
123155
},
124156
"consulProviderBuilder": {

src/test/traefik-v3/example.json

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,9 @@
7373
"caServerName": "foobar",
7474
"caSystemCertPool": true,
7575
"certificatesDuration": 42,
76+
"clientResponseHeaderTimeout": "42s",
77+
"clientTimeout": "42s",
78+
"disableCommonName": true,
7679
"dnsChallenge": {
7780
"delayBeforeCheck": "42s",
7881
"disablePropagationCheck": true,
@@ -90,13 +93,18 @@
9093
"kid": "foobar"
9194
},
9295
"email": "foobar",
96+
"emailAddresses": ["foobar", "foobar"],
9397
"httpChallenge": {
98+
"delay": "42s",
9499
"entryPoint": "foobar"
95100
},
96101
"keyType": "foobar",
97102
"preferredChain": "foobar",
103+
"profile": "foobar",
98104
"storage": "foobar",
99-
"tlsChallenge": {}
105+
"tlsChallenge": {
106+
"delay": "42s"
107+
}
100108
},
101109
"tailscale": {}
102110
},
@@ -107,6 +115,9 @@
107115
"caServerName": "foobar",
108116
"caSystemCertPool": true,
109117
"certificatesDuration": 42,
118+
"clientResponseHeaderTimeout": "42s",
119+
"clientTimeout": "42s",
120+
"disableCommonName": true,
110121
"dnsChallenge": {
111122
"delayBeforeCheck": "42s",
112123
"disablePropagationCheck": true,
@@ -124,13 +135,18 @@
124135
"kid": "foobar"
125136
},
126137
"email": "foobar",
138+
"emailAddresses": ["foobar", "foobar"],
127139
"httpChallenge": {
140+
"delay": "42s",
128141
"entryPoint": "foobar"
129142
},
130143
"keyType": "foobar",
131144
"preferredChain": "foobar",
145+
"profile": "foobar",
132146
"storage": "foobar",
133-
"tlsChallenge": {}
147+
"tlsChallenge": {
148+
"delay": "42s"
149+
}
134150
},
135151
"tailscale": {}
136152
}

0 commit comments

Comments
 (0)