@panneau/protocol 5.0.0-alpha.14 → 5.0.0-alpha.16
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/addresses.d.ts +23 -0
- package/dist/addresses.d.ts.map +1 -0
- package/dist/addresses.js +52 -0
- package/dist/addresses.js.map +1 -0
- package/dist/conformance/index.d.ts.map +1 -1
- package/dist/conformance/index.js +222 -2
- package/dist/conformance/index.js.map +1 -1
- package/dist/constants.d.ts +63 -2
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +94 -3
- package/dist/constants.js.map +1 -1
- package/dist/currencies.d.ts +22 -0
- package/dist/currencies.d.ts.map +1 -0
- package/dist/currencies.js +231 -0
- package/dist/currencies.js.map +1 -0
- package/dist/index.js +7 -4
- package/dist/links.d.ts +38 -0
- package/dist/links.d.ts.map +1 -0
- package/dist/links.js +65 -0
- package/dist/links.js.map +1 -0
- package/dist/lint.js +6 -2
- package/dist/lint.js.map +1 -1
- package/dist/mock/auth.d.ts +71 -0
- package/dist/mock/auth.d.ts.map +1 -0
- package/dist/mock/auth.js +346 -0
- package/dist/mock/auth.js.map +1 -0
- package/dist/mock/index.d.ts +8 -0
- package/dist/mock/index.d.ts.map +1 -1
- package/dist/mock/index.js +27 -3
- package/dist/mock/index.js.map +1 -1
- package/dist/openapi.d.ts.map +1 -1
- package/dist/openapi.js +227 -30
- package/dist/openapi.js.map +1 -1
- package/dist/query.d.ts +4 -0
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +23 -7
- package/dist/query.js.map +1 -1
- package/dist/rules.d.ts +4 -1
- package/dist/rules.d.ts.map +1 -1
- package/dist/rules.js +165 -7
- package/dist/rules.js.map +1 -1
- package/dist/runtime/index.d.ts +3 -0
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +5 -2
- package/dist/schemas/action.d.ts +46 -1
- package/dist/schemas/action.d.ts.map +1 -1
- package/dist/schemas/api.d.ts +78 -3
- package/dist/schemas/api.d.ts.map +1 -1
- package/dist/schemas/api.js +58 -1
- package/dist/schemas/api.js.map +1 -1
- package/dist/schemas/boot.d.ts +1 -0
- package/dist/schemas/boot.d.ts.map +1 -1
- package/dist/schemas/definition.d.ts +95 -3
- package/dist/schemas/definition.d.ts.map +1 -1
- package/dist/schemas/definition.js +6 -5
- package/dist/schemas/definition.js.map +1 -1
- package/dist/schemas/field.d.ts +193 -2
- package/dist/schemas/field.d.ts.map +1 -1
- package/dist/schemas/field.js +91 -7
- package/dist/schemas/field.js.map +1 -1
- package/dist/schemas/index.d.ts +476 -14
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +20 -4
- package/dist/schemas/index.js.map +1 -1
- package/dist/schemas/list.d.ts +2 -2
- package/dist/schemas/resource.d.ts +93 -3
- package/dist/schemas/resource.d.ts.map +1 -1
- package/dist/validate.d.ts +2 -1
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +18 -4
- package/dist/validate.js.map +1 -1
- package/package.json +1 -1
- package/schema/boot.schema.json +167 -2
- package/schema/definition.schema.json +167 -2
- package/schema/openapi.json +1842 -117
package/schema/openapi.json
CHANGED
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
}
|
|
33
33
|
},
|
|
34
34
|
"403": {
|
|
35
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
35
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
36
36
|
"content": {
|
|
37
37
|
"application/problem+json": {
|
|
38
38
|
"schema": {
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
}
|
|
101
101
|
},
|
|
102
102
|
"403": {
|
|
103
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
103
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
104
104
|
"content": {
|
|
105
105
|
"application/problem+json": {
|
|
106
106
|
"schema": {
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
}
|
|
232
232
|
},
|
|
233
233
|
"403": {
|
|
234
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
234
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
235
235
|
"content": {
|
|
236
236
|
"application/problem+json": {
|
|
237
237
|
"schema": {
|
|
@@ -305,7 +305,7 @@
|
|
|
305
305
|
}
|
|
306
306
|
},
|
|
307
307
|
"403": {
|
|
308
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
308
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
309
309
|
"content": {
|
|
310
310
|
"application/problem+json": {
|
|
311
311
|
"schema": {
|
|
@@ -403,7 +403,7 @@
|
|
|
403
403
|
}
|
|
404
404
|
},
|
|
405
405
|
"403": {
|
|
406
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
406
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
407
407
|
"content": {
|
|
408
408
|
"application/problem+json": {
|
|
409
409
|
"schema": {
|
|
@@ -479,7 +479,7 @@
|
|
|
479
479
|
}
|
|
480
480
|
},
|
|
481
481
|
"403": {
|
|
482
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
482
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
483
483
|
"content": {
|
|
484
484
|
"application/problem+json": {
|
|
485
485
|
"schema": {
|
|
@@ -547,7 +547,7 @@
|
|
|
547
547
|
}
|
|
548
548
|
},
|
|
549
549
|
"403": {
|
|
550
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
550
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
551
551
|
"content": {
|
|
552
552
|
"application/problem+json": {
|
|
553
553
|
"schema": {
|
|
@@ -636,7 +636,7 @@
|
|
|
636
636
|
}
|
|
637
637
|
},
|
|
638
638
|
"403": {
|
|
639
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
639
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
640
640
|
"content": {
|
|
641
641
|
"application/problem+json": {
|
|
642
642
|
"schema": {
|
|
@@ -727,7 +727,7 @@
|
|
|
727
727
|
}
|
|
728
728
|
},
|
|
729
729
|
"403": {
|
|
730
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
730
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
731
731
|
"content": {
|
|
732
732
|
"application/problem+json": {
|
|
733
733
|
"schema": {
|
|
@@ -842,7 +842,7 @@
|
|
|
842
842
|
}
|
|
843
843
|
},
|
|
844
844
|
"403": {
|
|
845
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
845
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
846
846
|
"content": {
|
|
847
847
|
"application/problem+json": {
|
|
848
848
|
"schema": {
|
|
@@ -943,7 +943,7 @@
|
|
|
943
943
|
}
|
|
944
944
|
},
|
|
945
945
|
"403": {
|
|
946
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
946
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
947
947
|
"content": {
|
|
948
948
|
"application/problem+json": {
|
|
949
949
|
"schema": {
|
|
@@ -1012,7 +1012,7 @@
|
|
|
1012
1012
|
}
|
|
1013
1013
|
},
|
|
1014
1014
|
"403": {
|
|
1015
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1015
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1016
1016
|
"content": {
|
|
1017
1017
|
"application/problem+json": {
|
|
1018
1018
|
"schema": {
|
|
@@ -1068,7 +1068,7 @@
|
|
|
1068
1068
|
}
|
|
1069
1069
|
},
|
|
1070
1070
|
"403": {
|
|
1071
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1071
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1072
1072
|
"content": {
|
|
1073
1073
|
"application/problem+json": {
|
|
1074
1074
|
"schema": {
|
|
@@ -1106,7 +1106,7 @@
|
|
|
1106
1106
|
}
|
|
1107
1107
|
},
|
|
1108
1108
|
"403": {
|
|
1109
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1109
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1110
1110
|
"content": {
|
|
1111
1111
|
"application/problem+json": {
|
|
1112
1112
|
"schema": {
|
|
@@ -1174,7 +1174,7 @@
|
|
|
1174
1174
|
}
|
|
1175
1175
|
},
|
|
1176
1176
|
"403": {
|
|
1177
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1177
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1178
1178
|
"content": {
|
|
1179
1179
|
"application/problem+json": {
|
|
1180
1180
|
"schema": {
|
|
@@ -1267,7 +1267,7 @@
|
|
|
1267
1267
|
}
|
|
1268
1268
|
},
|
|
1269
1269
|
"403": {
|
|
1270
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1270
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1271
1271
|
"content": {
|
|
1272
1272
|
"application/problem+json": {
|
|
1273
1273
|
"schema": {
|
|
@@ -1324,7 +1324,7 @@
|
|
|
1324
1324
|
}
|
|
1325
1325
|
},
|
|
1326
1326
|
"403": {
|
|
1327
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1327
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1328
1328
|
"content": {
|
|
1329
1329
|
"application/problem+json": {
|
|
1330
1330
|
"schema": {
|
|
@@ -1404,19 +1404,13 @@
|
|
|
1404
1404
|
"content": {
|
|
1405
1405
|
"application/json": {
|
|
1406
1406
|
"schema": {
|
|
1407
|
-
"
|
|
1408
|
-
"properties": {
|
|
1409
|
-
"twoFactor": {
|
|
1410
|
-
"type": "boolean",
|
|
1411
|
-
"const": true
|
|
1412
|
-
}
|
|
1413
|
-
}
|
|
1407
|
+
"$ref": "#/components/schemas/TwoFactorChallenge"
|
|
1414
1408
|
}
|
|
1415
1409
|
}
|
|
1416
1410
|
}
|
|
1417
1411
|
},
|
|
1418
1412
|
"403": {
|
|
1419
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1413
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1420
1414
|
"content": {
|
|
1421
1415
|
"application/problem+json": {
|
|
1422
1416
|
"schema": {
|
|
@@ -1434,6 +1428,16 @@
|
|
|
1434
1428
|
}
|
|
1435
1429
|
}
|
|
1436
1430
|
}
|
|
1431
|
+
},
|
|
1432
|
+
"429": {
|
|
1433
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1434
|
+
"content": {
|
|
1435
|
+
"application/problem+json": {
|
|
1436
|
+
"schema": {
|
|
1437
|
+
"$ref": "#/components/schemas/Problem"
|
|
1438
|
+
}
|
|
1439
|
+
}
|
|
1440
|
+
}
|
|
1437
1441
|
}
|
|
1438
1442
|
}
|
|
1439
1443
|
},
|
|
@@ -1452,7 +1456,7 @@
|
|
|
1452
1456
|
"description": "Logged out."
|
|
1453
1457
|
},
|
|
1454
1458
|
"403": {
|
|
1455
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1459
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1456
1460
|
"content": {
|
|
1457
1461
|
"application/problem+json": {
|
|
1458
1462
|
"schema": {
|
|
@@ -1486,12 +1490,13 @@
|
|
|
1486
1490
|
],
|
|
1487
1491
|
"get": {
|
|
1488
1492
|
"operationId": "redirectToProvider",
|
|
1493
|
+
"summary": "Starts the login with an OAuth provider of `auth.providers`. The callback is the backend's: it goes to `next`, or to the base path of the app with `authError` when it fails.",
|
|
1489
1494
|
"parameters": [
|
|
1490
1495
|
{
|
|
1491
1496
|
"name": "next",
|
|
1492
1497
|
"in": "query",
|
|
1493
1498
|
"required": false,
|
|
1494
|
-
"description": "
|
|
1499
|
+
"description": "Where to go after the login: a local path under the base path of the app. Another one is ignored.",
|
|
1495
1500
|
"schema": {
|
|
1496
1501
|
"type": "string"
|
|
1497
1502
|
}
|
|
@@ -1502,7 +1507,52 @@
|
|
|
1502
1507
|
"description": "Redirect to the provider."
|
|
1503
1508
|
},
|
|
1504
1509
|
"403": {
|
|
1505
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1510
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1511
|
+
"content": {
|
|
1512
|
+
"application/problem+json": {
|
|
1513
|
+
"schema": {
|
|
1514
|
+
"$ref": "#/components/schemas/Problem"
|
|
1515
|
+
}
|
|
1516
|
+
}
|
|
1517
|
+
}
|
|
1518
|
+
},
|
|
1519
|
+
"404": {
|
|
1520
|
+
"description": "Not found.",
|
|
1521
|
+
"content": {
|
|
1522
|
+
"application/problem+json": {
|
|
1523
|
+
"schema": {
|
|
1524
|
+
"$ref": "#/components/schemas/Problem"
|
|
1525
|
+
}
|
|
1526
|
+
}
|
|
1527
|
+
}
|
|
1528
|
+
}
|
|
1529
|
+
}
|
|
1530
|
+
}
|
|
1531
|
+
},
|
|
1532
|
+
"/auth/providers/{provider}/callback": {
|
|
1533
|
+
"parameters": [
|
|
1534
|
+
{
|
|
1535
|
+
"name": "provider",
|
|
1536
|
+
"in": "path",
|
|
1537
|
+
"required": true,
|
|
1538
|
+
"description": "Provider id.",
|
|
1539
|
+
"schema": {
|
|
1540
|
+
"type": "string"
|
|
1541
|
+
}
|
|
1542
|
+
},
|
|
1543
|
+
{
|
|
1544
|
+
"$ref": "#/components/parameters/Context"
|
|
1545
|
+
}
|
|
1546
|
+
],
|
|
1547
|
+
"get": {
|
|
1548
|
+
"operationId": "providerCallback",
|
|
1549
|
+
"summary": "Optional: the callback of the provider, when the backend has it here. Its URL is the backend's, registered with the provider; the app never calls it.",
|
|
1550
|
+
"responses": {
|
|
1551
|
+
"302": {
|
|
1552
|
+
"description": "To `next`, or to the base path of the app with `authError` when the login failed."
|
|
1553
|
+
},
|
|
1554
|
+
"403": {
|
|
1555
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1506
1556
|
"content": {
|
|
1507
1557
|
"application/problem+json": {
|
|
1508
1558
|
"schema": {
|
|
@@ -1527,6 +1577,7 @@
|
|
|
1527
1577
|
"/auth/password/forgot": {
|
|
1528
1578
|
"post": {
|
|
1529
1579
|
"operationId": "forgotPassword",
|
|
1580
|
+
"summary": "With `auth.passwordReset`: emails a link to the page of the app at `{basePath}/auth/reset-password?token=…&email=…`.",
|
|
1530
1581
|
"requestBody": {
|
|
1531
1582
|
"required": true,
|
|
1532
1583
|
"content": {
|
|
@@ -1547,10 +1598,10 @@
|
|
|
1547
1598
|
},
|
|
1548
1599
|
"responses": {
|
|
1549
1600
|
"204": {
|
|
1550
|
-
"description": "A reset link was sent, if the account
|
|
1601
|
+
"description": "A reset link was sent, if the address has an account. The answer is the same when it hasn't, or when a link was sent recently."
|
|
1551
1602
|
},
|
|
1552
1603
|
"403": {
|
|
1553
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1604
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1554
1605
|
"content": {
|
|
1555
1606
|
"application/problem+json": {
|
|
1556
1607
|
"schema": {
|
|
@@ -1568,6 +1619,16 @@
|
|
|
1568
1619
|
}
|
|
1569
1620
|
}
|
|
1570
1621
|
}
|
|
1622
|
+
},
|
|
1623
|
+
"429": {
|
|
1624
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1625
|
+
"content": {
|
|
1626
|
+
"application/problem+json": {
|
|
1627
|
+
"schema": {
|
|
1628
|
+
"$ref": "#/components/schemas/Problem"
|
|
1629
|
+
}
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1571
1632
|
}
|
|
1572
1633
|
}
|
|
1573
1634
|
},
|
|
@@ -1580,6 +1641,7 @@
|
|
|
1580
1641
|
"/auth/password/reset": {
|
|
1581
1642
|
"post": {
|
|
1582
1643
|
"operationId": "resetPassword",
|
|
1644
|
+
"summary": "With `auth.passwordReset`: sets a new password, with the token and the email of the link. It does not log in.",
|
|
1583
1645
|
"requestBody": {
|
|
1584
1646
|
"required": true,
|
|
1585
1647
|
"content": {
|
|
@@ -1611,7 +1673,7 @@
|
|
|
1611
1673
|
"description": "The password was reset."
|
|
1612
1674
|
},
|
|
1613
1675
|
"403": {
|
|
1614
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1676
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1615
1677
|
"content": {
|
|
1616
1678
|
"application/problem+json": {
|
|
1617
1679
|
"schema": {
|
|
@@ -1629,6 +1691,16 @@
|
|
|
1629
1691
|
}
|
|
1630
1692
|
}
|
|
1631
1693
|
}
|
|
1694
|
+
},
|
|
1695
|
+
"429": {
|
|
1696
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1697
|
+
"content": {
|
|
1698
|
+
"application/problem+json": {
|
|
1699
|
+
"schema": {
|
|
1700
|
+
"$ref": "#/components/schemas/Problem"
|
|
1701
|
+
}
|
|
1702
|
+
}
|
|
1703
|
+
}
|
|
1632
1704
|
}
|
|
1633
1705
|
}
|
|
1634
1706
|
},
|
|
@@ -1638,20 +1710,67 @@
|
|
|
1638
1710
|
}
|
|
1639
1711
|
]
|
|
1640
1712
|
},
|
|
1641
|
-
"/auth/
|
|
1713
|
+
"/auth/email/verification": {
|
|
1642
1714
|
"post": {
|
|
1643
|
-
"operationId": "
|
|
1715
|
+
"operationId": "sendEmailVerification",
|
|
1716
|
+
"summary": "With `auth.emailVerification`: emails the current user a link to the page of the app at `{basePath}/auth/verify-email?token=…`.",
|
|
1717
|
+
"responses": {
|
|
1718
|
+
"204": {
|
|
1719
|
+
"description": "A link was sent, or the address is already verified."
|
|
1720
|
+
},
|
|
1721
|
+
"401": {
|
|
1722
|
+
"description": "Not authenticated.",
|
|
1723
|
+
"content": {
|
|
1724
|
+
"application/problem+json": {
|
|
1725
|
+
"schema": {
|
|
1726
|
+
"$ref": "#/components/schemas/Problem"
|
|
1727
|
+
}
|
|
1728
|
+
}
|
|
1729
|
+
}
|
|
1730
|
+
},
|
|
1731
|
+
"403": {
|
|
1732
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1733
|
+
"content": {
|
|
1734
|
+
"application/problem+json": {
|
|
1735
|
+
"schema": {
|
|
1736
|
+
"$ref": "#/components/schemas/Problem"
|
|
1737
|
+
}
|
|
1738
|
+
}
|
|
1739
|
+
}
|
|
1740
|
+
},
|
|
1741
|
+
"429": {
|
|
1742
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1743
|
+
"content": {
|
|
1744
|
+
"application/problem+json": {
|
|
1745
|
+
"schema": {
|
|
1746
|
+
"$ref": "#/components/schemas/Problem"
|
|
1747
|
+
}
|
|
1748
|
+
}
|
|
1749
|
+
}
|
|
1750
|
+
}
|
|
1751
|
+
}
|
|
1752
|
+
},
|
|
1753
|
+
"parameters": [
|
|
1754
|
+
{
|
|
1755
|
+
"$ref": "#/components/parameters/Context"
|
|
1756
|
+
}
|
|
1757
|
+
]
|
|
1758
|
+
},
|
|
1759
|
+
"/auth/email/verify": {
|
|
1760
|
+
"post": {
|
|
1761
|
+
"operationId": "verifyEmail",
|
|
1762
|
+
"summary": "With `auth.emailVerification`: verifies the address of the token of a link. The user does not need to be logged in.",
|
|
1644
1763
|
"requestBody": {
|
|
1645
1764
|
"required": true,
|
|
1646
1765
|
"content": {
|
|
1647
1766
|
"application/json": {
|
|
1648
1767
|
"schema": {
|
|
1649
1768
|
"type": "object",
|
|
1769
|
+
"required": [
|
|
1770
|
+
"token"
|
|
1771
|
+
],
|
|
1650
1772
|
"properties": {
|
|
1651
|
-
"
|
|
1652
|
-
"type": "string"
|
|
1653
|
-
},
|
|
1654
|
-
"recoveryCode": {
|
|
1773
|
+
"token": {
|
|
1655
1774
|
"type": "string"
|
|
1656
1775
|
}
|
|
1657
1776
|
}
|
|
@@ -1659,6 +1778,85 @@
|
|
|
1659
1778
|
}
|
|
1660
1779
|
}
|
|
1661
1780
|
},
|
|
1781
|
+
"responses": {
|
|
1782
|
+
"204": {
|
|
1783
|
+
"description": "The address is verified."
|
|
1784
|
+
},
|
|
1785
|
+
"403": {
|
|
1786
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1787
|
+
"content": {
|
|
1788
|
+
"application/problem+json": {
|
|
1789
|
+
"schema": {
|
|
1790
|
+
"$ref": "#/components/schemas/Problem"
|
|
1791
|
+
}
|
|
1792
|
+
}
|
|
1793
|
+
}
|
|
1794
|
+
},
|
|
1795
|
+
"422": {
|
|
1796
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
1797
|
+
"content": {
|
|
1798
|
+
"application/problem+json": {
|
|
1799
|
+
"schema": {
|
|
1800
|
+
"$ref": "#/components/schemas/Problem"
|
|
1801
|
+
}
|
|
1802
|
+
}
|
|
1803
|
+
}
|
|
1804
|
+
},
|
|
1805
|
+
"429": {
|
|
1806
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1807
|
+
"content": {
|
|
1808
|
+
"application/problem+json": {
|
|
1809
|
+
"schema": {
|
|
1810
|
+
"$ref": "#/components/schemas/Problem"
|
|
1811
|
+
}
|
|
1812
|
+
}
|
|
1813
|
+
}
|
|
1814
|
+
}
|
|
1815
|
+
}
|
|
1816
|
+
},
|
|
1817
|
+
"parameters": [
|
|
1818
|
+
{
|
|
1819
|
+
"$ref": "#/components/parameters/Context"
|
|
1820
|
+
}
|
|
1821
|
+
]
|
|
1822
|
+
},
|
|
1823
|
+
"/auth/two-factor/challenge": {
|
|
1824
|
+
"post": {
|
|
1825
|
+
"operationId": "twoFactorChallenge",
|
|
1826
|
+
"summary": "Ends a login that answered `202`, with a code of the authenticator app or a recovery code. A login that is no longer pending is a `422`.",
|
|
1827
|
+
"requestBody": {
|
|
1828
|
+
"required": true,
|
|
1829
|
+
"content": {
|
|
1830
|
+
"application/json": {
|
|
1831
|
+
"schema": {
|
|
1832
|
+
"oneOf": [
|
|
1833
|
+
{
|
|
1834
|
+
"type": "object",
|
|
1835
|
+
"required": [
|
|
1836
|
+
"code"
|
|
1837
|
+
],
|
|
1838
|
+
"properties": {
|
|
1839
|
+
"code": {
|
|
1840
|
+
"type": "string"
|
|
1841
|
+
}
|
|
1842
|
+
}
|
|
1843
|
+
},
|
|
1844
|
+
{
|
|
1845
|
+
"type": "object",
|
|
1846
|
+
"required": [
|
|
1847
|
+
"recoveryCode"
|
|
1848
|
+
],
|
|
1849
|
+
"properties": {
|
|
1850
|
+
"recoveryCode": {
|
|
1851
|
+
"type": "string"
|
|
1852
|
+
}
|
|
1853
|
+
}
|
|
1854
|
+
}
|
|
1855
|
+
]
|
|
1856
|
+
}
|
|
1857
|
+
}
|
|
1858
|
+
}
|
|
1859
|
+
},
|
|
1662
1860
|
"responses": {
|
|
1663
1861
|
"200": {
|
|
1664
1862
|
"description": "Logged in.",
|
|
@@ -1670,8 +1868,651 @@
|
|
|
1670
1868
|
}
|
|
1671
1869
|
}
|
|
1672
1870
|
},
|
|
1673
|
-
"403": {
|
|
1674
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
1871
|
+
"403": {
|
|
1872
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1873
|
+
"content": {
|
|
1874
|
+
"application/problem+json": {
|
|
1875
|
+
"schema": {
|
|
1876
|
+
"$ref": "#/components/schemas/Problem"
|
|
1877
|
+
}
|
|
1878
|
+
}
|
|
1879
|
+
}
|
|
1880
|
+
},
|
|
1881
|
+
"422": {
|
|
1882
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
1883
|
+
"content": {
|
|
1884
|
+
"application/problem+json": {
|
|
1885
|
+
"schema": {
|
|
1886
|
+
"$ref": "#/components/schemas/Problem"
|
|
1887
|
+
}
|
|
1888
|
+
}
|
|
1889
|
+
}
|
|
1890
|
+
},
|
|
1891
|
+
"429": {
|
|
1892
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1893
|
+
"content": {
|
|
1894
|
+
"application/problem+json": {
|
|
1895
|
+
"schema": {
|
|
1896
|
+
"$ref": "#/components/schemas/Problem"
|
|
1897
|
+
}
|
|
1898
|
+
}
|
|
1899
|
+
}
|
|
1900
|
+
}
|
|
1901
|
+
}
|
|
1902
|
+
},
|
|
1903
|
+
"parameters": [
|
|
1904
|
+
{
|
|
1905
|
+
"$ref": "#/components/parameters/Context"
|
|
1906
|
+
}
|
|
1907
|
+
]
|
|
1908
|
+
},
|
|
1909
|
+
"/auth/password/confirm": {
|
|
1910
|
+
"post": {
|
|
1911
|
+
"operationId": "confirmPassword",
|
|
1912
|
+
"summary": "Confirms the password of the current user, for the operations that answer `423`.",
|
|
1913
|
+
"requestBody": {
|
|
1914
|
+
"required": true,
|
|
1915
|
+
"content": {
|
|
1916
|
+
"application/json": {
|
|
1917
|
+
"schema": {
|
|
1918
|
+
"type": "object",
|
|
1919
|
+
"required": [
|
|
1920
|
+
"password"
|
|
1921
|
+
],
|
|
1922
|
+
"properties": {
|
|
1923
|
+
"password": {
|
|
1924
|
+
"type": "string"
|
|
1925
|
+
}
|
|
1926
|
+
}
|
|
1927
|
+
}
|
|
1928
|
+
}
|
|
1929
|
+
}
|
|
1930
|
+
},
|
|
1931
|
+
"responses": {
|
|
1932
|
+
"204": {
|
|
1933
|
+
"description": "The password is confirmed."
|
|
1934
|
+
},
|
|
1935
|
+
"401": {
|
|
1936
|
+
"description": "Not authenticated.",
|
|
1937
|
+
"content": {
|
|
1938
|
+
"application/problem+json": {
|
|
1939
|
+
"schema": {
|
|
1940
|
+
"$ref": "#/components/schemas/Problem"
|
|
1941
|
+
}
|
|
1942
|
+
}
|
|
1943
|
+
}
|
|
1944
|
+
},
|
|
1945
|
+
"403": {
|
|
1946
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1947
|
+
"content": {
|
|
1948
|
+
"application/problem+json": {
|
|
1949
|
+
"schema": {
|
|
1950
|
+
"$ref": "#/components/schemas/Problem"
|
|
1951
|
+
}
|
|
1952
|
+
}
|
|
1953
|
+
}
|
|
1954
|
+
},
|
|
1955
|
+
"422": {
|
|
1956
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
1957
|
+
"content": {
|
|
1958
|
+
"application/problem+json": {
|
|
1959
|
+
"schema": {
|
|
1960
|
+
"$ref": "#/components/schemas/Problem"
|
|
1961
|
+
}
|
|
1962
|
+
}
|
|
1963
|
+
}
|
|
1964
|
+
},
|
|
1965
|
+
"429": {
|
|
1966
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1967
|
+
"content": {
|
|
1968
|
+
"application/problem+json": {
|
|
1969
|
+
"schema": {
|
|
1970
|
+
"$ref": "#/components/schemas/Problem"
|
|
1971
|
+
}
|
|
1972
|
+
}
|
|
1973
|
+
}
|
|
1974
|
+
}
|
|
1975
|
+
}
|
|
1976
|
+
},
|
|
1977
|
+
"parameters": [
|
|
1978
|
+
{
|
|
1979
|
+
"$ref": "#/components/parameters/Context"
|
|
1980
|
+
}
|
|
1981
|
+
]
|
|
1982
|
+
},
|
|
1983
|
+
"/account/two-factor": {
|
|
1984
|
+
"get": {
|
|
1985
|
+
"operationId": "getTwoFactor",
|
|
1986
|
+
"summary": "With `auth.twoFactor`: the two-factor authentication of the user.",
|
|
1987
|
+
"responses": {
|
|
1988
|
+
"200": {
|
|
1989
|
+
"description": "Its status.",
|
|
1990
|
+
"content": {
|
|
1991
|
+
"application/json": {
|
|
1992
|
+
"schema": {
|
|
1993
|
+
"$ref": "#/components/schemas/TwoFactorStatus"
|
|
1994
|
+
}
|
|
1995
|
+
}
|
|
1996
|
+
}
|
|
1997
|
+
},
|
|
1998
|
+
"401": {
|
|
1999
|
+
"description": "Not authenticated.",
|
|
2000
|
+
"content": {
|
|
2001
|
+
"application/problem+json": {
|
|
2002
|
+
"schema": {
|
|
2003
|
+
"$ref": "#/components/schemas/Problem"
|
|
2004
|
+
}
|
|
2005
|
+
}
|
|
2006
|
+
}
|
|
2007
|
+
},
|
|
2008
|
+
"403": {
|
|
2009
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2010
|
+
"content": {
|
|
2011
|
+
"application/problem+json": {
|
|
2012
|
+
"schema": {
|
|
2013
|
+
"$ref": "#/components/schemas/Problem"
|
|
2014
|
+
}
|
|
2015
|
+
}
|
|
2016
|
+
}
|
|
2017
|
+
}
|
|
2018
|
+
}
|
|
2019
|
+
},
|
|
2020
|
+
"post": {
|
|
2021
|
+
"operationId": "enableTwoFactor",
|
|
2022
|
+
"summary": "Starts setting it up: a new secret, `pending` until `POST /account/two-factor/confirm`.",
|
|
2023
|
+
"responses": {
|
|
2024
|
+
"200": {
|
|
2025
|
+
"description": "The secret to add to an authenticator app.",
|
|
2026
|
+
"content": {
|
|
2027
|
+
"application/json": {
|
|
2028
|
+
"schema": {
|
|
2029
|
+
"$ref": "#/components/schemas/TwoFactorSetup"
|
|
2030
|
+
}
|
|
2031
|
+
}
|
|
2032
|
+
}
|
|
2033
|
+
},
|
|
2034
|
+
"401": {
|
|
2035
|
+
"description": "Not authenticated.",
|
|
2036
|
+
"content": {
|
|
2037
|
+
"application/problem+json": {
|
|
2038
|
+
"schema": {
|
|
2039
|
+
"$ref": "#/components/schemas/Problem"
|
|
2040
|
+
}
|
|
2041
|
+
}
|
|
2042
|
+
}
|
|
2043
|
+
},
|
|
2044
|
+
"403": {
|
|
2045
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2046
|
+
"content": {
|
|
2047
|
+
"application/problem+json": {
|
|
2048
|
+
"schema": {
|
|
2049
|
+
"$ref": "#/components/schemas/Problem"
|
|
2050
|
+
}
|
|
2051
|
+
}
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
"409": {
|
|
2055
|
+
"description": "Conflict with a business rule.",
|
|
2056
|
+
"content": {
|
|
2057
|
+
"application/problem+json": {
|
|
2058
|
+
"schema": {
|
|
2059
|
+
"$ref": "#/components/schemas/Problem"
|
|
2060
|
+
}
|
|
2061
|
+
}
|
|
2062
|
+
}
|
|
2063
|
+
},
|
|
2064
|
+
"423": {
|
|
2065
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
2066
|
+
"content": {
|
|
2067
|
+
"application/problem+json": {
|
|
2068
|
+
"schema": {
|
|
2069
|
+
"$ref": "#/components/schemas/Problem"
|
|
2070
|
+
}
|
|
2071
|
+
}
|
|
2072
|
+
}
|
|
2073
|
+
}
|
|
2074
|
+
}
|
|
2075
|
+
},
|
|
2076
|
+
"delete": {
|
|
2077
|
+
"operationId": "disableTwoFactor",
|
|
2078
|
+
"summary": "Turns it off. A `409` when the backend requires it for the user.",
|
|
2079
|
+
"responses": {
|
|
2080
|
+
"204": {
|
|
2081
|
+
"description": "Turned off."
|
|
2082
|
+
},
|
|
2083
|
+
"401": {
|
|
2084
|
+
"description": "Not authenticated.",
|
|
2085
|
+
"content": {
|
|
2086
|
+
"application/problem+json": {
|
|
2087
|
+
"schema": {
|
|
2088
|
+
"$ref": "#/components/schemas/Problem"
|
|
2089
|
+
}
|
|
2090
|
+
}
|
|
2091
|
+
}
|
|
2092
|
+
},
|
|
2093
|
+
"403": {
|
|
2094
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2095
|
+
"content": {
|
|
2096
|
+
"application/problem+json": {
|
|
2097
|
+
"schema": {
|
|
2098
|
+
"$ref": "#/components/schemas/Problem"
|
|
2099
|
+
}
|
|
2100
|
+
}
|
|
2101
|
+
}
|
|
2102
|
+
},
|
|
2103
|
+
"409": {
|
|
2104
|
+
"description": "Conflict with a business rule.",
|
|
2105
|
+
"content": {
|
|
2106
|
+
"application/problem+json": {
|
|
2107
|
+
"schema": {
|
|
2108
|
+
"$ref": "#/components/schemas/Problem"
|
|
2109
|
+
}
|
|
2110
|
+
}
|
|
2111
|
+
}
|
|
2112
|
+
},
|
|
2113
|
+
"423": {
|
|
2114
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
2115
|
+
"content": {
|
|
2116
|
+
"application/problem+json": {
|
|
2117
|
+
"schema": {
|
|
2118
|
+
"$ref": "#/components/schemas/Problem"
|
|
2119
|
+
}
|
|
2120
|
+
}
|
|
2121
|
+
}
|
|
2122
|
+
}
|
|
2123
|
+
}
|
|
2124
|
+
},
|
|
2125
|
+
"parameters": [
|
|
2126
|
+
{
|
|
2127
|
+
"$ref": "#/components/parameters/Context"
|
|
2128
|
+
}
|
|
2129
|
+
]
|
|
2130
|
+
},
|
|
2131
|
+
"/account/two-factor/confirm": {
|
|
2132
|
+
"post": {
|
|
2133
|
+
"operationId": "confirmTwoFactor",
|
|
2134
|
+
"requestBody": {
|
|
2135
|
+
"required": true,
|
|
2136
|
+
"content": {
|
|
2137
|
+
"application/json": {
|
|
2138
|
+
"schema": {
|
|
2139
|
+
"type": "object",
|
|
2140
|
+
"required": [
|
|
2141
|
+
"code"
|
|
2142
|
+
],
|
|
2143
|
+
"properties": {
|
|
2144
|
+
"code": {
|
|
2145
|
+
"type": "string"
|
|
2146
|
+
}
|
|
2147
|
+
}
|
|
2148
|
+
}
|
|
2149
|
+
}
|
|
2150
|
+
}
|
|
2151
|
+
},
|
|
2152
|
+
"responses": {
|
|
2153
|
+
"200": {
|
|
2154
|
+
"description": "Turned on, with its recovery codes.",
|
|
2155
|
+
"content": {
|
|
2156
|
+
"application/json": {
|
|
2157
|
+
"schema": {
|
|
2158
|
+
"$ref": "#/components/schemas/RecoveryCodes"
|
|
2159
|
+
}
|
|
2160
|
+
}
|
|
2161
|
+
}
|
|
2162
|
+
},
|
|
2163
|
+
"401": {
|
|
2164
|
+
"description": "Not authenticated.",
|
|
2165
|
+
"content": {
|
|
2166
|
+
"application/problem+json": {
|
|
2167
|
+
"schema": {
|
|
2168
|
+
"$ref": "#/components/schemas/Problem"
|
|
2169
|
+
}
|
|
2170
|
+
}
|
|
2171
|
+
}
|
|
2172
|
+
},
|
|
2173
|
+
"403": {
|
|
2174
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2175
|
+
"content": {
|
|
2176
|
+
"application/problem+json": {
|
|
2177
|
+
"schema": {
|
|
2178
|
+
"$ref": "#/components/schemas/Problem"
|
|
2179
|
+
}
|
|
2180
|
+
}
|
|
2181
|
+
}
|
|
2182
|
+
},
|
|
2183
|
+
"409": {
|
|
2184
|
+
"description": "Conflict with a business rule.",
|
|
2185
|
+
"content": {
|
|
2186
|
+
"application/problem+json": {
|
|
2187
|
+
"schema": {
|
|
2188
|
+
"$ref": "#/components/schemas/Problem"
|
|
2189
|
+
}
|
|
2190
|
+
}
|
|
2191
|
+
}
|
|
2192
|
+
},
|
|
2193
|
+
"422": {
|
|
2194
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
2195
|
+
"content": {
|
|
2196
|
+
"application/problem+json": {
|
|
2197
|
+
"schema": {
|
|
2198
|
+
"$ref": "#/components/schemas/Problem"
|
|
2199
|
+
}
|
|
2200
|
+
}
|
|
2201
|
+
}
|
|
2202
|
+
},
|
|
2203
|
+
"423": {
|
|
2204
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
2205
|
+
"content": {
|
|
2206
|
+
"application/problem+json": {
|
|
2207
|
+
"schema": {
|
|
2208
|
+
"$ref": "#/components/schemas/Problem"
|
|
2209
|
+
}
|
|
2210
|
+
}
|
|
2211
|
+
}
|
|
2212
|
+
}
|
|
2213
|
+
}
|
|
2214
|
+
},
|
|
2215
|
+
"parameters": [
|
|
2216
|
+
{
|
|
2217
|
+
"$ref": "#/components/parameters/Context"
|
|
2218
|
+
}
|
|
2219
|
+
]
|
|
2220
|
+
},
|
|
2221
|
+
"/account/two-factor/recovery-codes": {
|
|
2222
|
+
"post": {
|
|
2223
|
+
"operationId": "regenerateRecoveryCodes",
|
|
2224
|
+
"summary": "New recovery codes, in place of the old ones.",
|
|
2225
|
+
"responses": {
|
|
2226
|
+
"200": {
|
|
2227
|
+
"description": "The new codes.",
|
|
2228
|
+
"content": {
|
|
2229
|
+
"application/json": {
|
|
2230
|
+
"schema": {
|
|
2231
|
+
"$ref": "#/components/schemas/RecoveryCodes"
|
|
2232
|
+
}
|
|
2233
|
+
}
|
|
2234
|
+
}
|
|
2235
|
+
},
|
|
2236
|
+
"401": {
|
|
2237
|
+
"description": "Not authenticated.",
|
|
2238
|
+
"content": {
|
|
2239
|
+
"application/problem+json": {
|
|
2240
|
+
"schema": {
|
|
2241
|
+
"$ref": "#/components/schemas/Problem"
|
|
2242
|
+
}
|
|
2243
|
+
}
|
|
2244
|
+
}
|
|
2245
|
+
},
|
|
2246
|
+
"403": {
|
|
2247
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2248
|
+
"content": {
|
|
2249
|
+
"application/problem+json": {
|
|
2250
|
+
"schema": {
|
|
2251
|
+
"$ref": "#/components/schemas/Problem"
|
|
2252
|
+
}
|
|
2253
|
+
}
|
|
2254
|
+
}
|
|
2255
|
+
},
|
|
2256
|
+
"409": {
|
|
2257
|
+
"description": "Conflict with a business rule.",
|
|
2258
|
+
"content": {
|
|
2259
|
+
"application/problem+json": {
|
|
2260
|
+
"schema": {
|
|
2261
|
+
"$ref": "#/components/schemas/Problem"
|
|
2262
|
+
}
|
|
2263
|
+
}
|
|
2264
|
+
}
|
|
2265
|
+
},
|
|
2266
|
+
"423": {
|
|
2267
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
2268
|
+
"content": {
|
|
2269
|
+
"application/problem+json": {
|
|
2270
|
+
"schema": {
|
|
2271
|
+
"$ref": "#/components/schemas/Problem"
|
|
2272
|
+
}
|
|
2273
|
+
}
|
|
2274
|
+
}
|
|
2275
|
+
}
|
|
2276
|
+
}
|
|
2277
|
+
},
|
|
2278
|
+
"parameters": [
|
|
2279
|
+
{
|
|
2280
|
+
"$ref": "#/components/parameters/Context"
|
|
2281
|
+
}
|
|
2282
|
+
]
|
|
2283
|
+
},
|
|
2284
|
+
"/auth/passkeys/options": {
|
|
2285
|
+
"post": {
|
|
2286
|
+
"operationId": "passkeyLoginOptions",
|
|
2287
|
+
"summary": "With `auth.passkeys`: the options of `navigator.credentials.get()`, for any passkey of the site.",
|
|
2288
|
+
"responses": {
|
|
2289
|
+
"200": {
|
|
2290
|
+
"description": "The options.",
|
|
2291
|
+
"content": {
|
|
2292
|
+
"application/json": {
|
|
2293
|
+
"schema": {
|
|
2294
|
+
"$ref": "#/components/schemas/WebAuthnOptions"
|
|
2295
|
+
}
|
|
2296
|
+
}
|
|
2297
|
+
}
|
|
2298
|
+
},
|
|
2299
|
+
"403": {
|
|
2300
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2301
|
+
"content": {
|
|
2302
|
+
"application/problem+json": {
|
|
2303
|
+
"schema": {
|
|
2304
|
+
"$ref": "#/components/schemas/Problem"
|
|
2305
|
+
}
|
|
2306
|
+
}
|
|
2307
|
+
}
|
|
2308
|
+
},
|
|
2309
|
+
"429": {
|
|
2310
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
2311
|
+
"content": {
|
|
2312
|
+
"application/problem+json": {
|
|
2313
|
+
"schema": {
|
|
2314
|
+
"$ref": "#/components/schemas/Problem"
|
|
2315
|
+
}
|
|
2316
|
+
}
|
|
2317
|
+
}
|
|
2318
|
+
}
|
|
2319
|
+
}
|
|
2320
|
+
},
|
|
2321
|
+
"parameters": [
|
|
2322
|
+
{
|
|
2323
|
+
"$ref": "#/components/parameters/Context"
|
|
2324
|
+
}
|
|
2325
|
+
]
|
|
2326
|
+
},
|
|
2327
|
+
"/auth/passkeys/login": {
|
|
2328
|
+
"post": {
|
|
2329
|
+
"operationId": "passkeyLogin",
|
|
2330
|
+
"summary": "Logs in with the credential of a passkey, in the JSON form of the WebAuthn spec. It does not ask for a second factor.",
|
|
2331
|
+
"requestBody": {
|
|
2332
|
+
"required": true,
|
|
2333
|
+
"content": {
|
|
2334
|
+
"application/json": {
|
|
2335
|
+
"schema": {
|
|
2336
|
+
"type": "object",
|
|
2337
|
+
"required": [
|
|
2338
|
+
"credential"
|
|
2339
|
+
],
|
|
2340
|
+
"properties": {
|
|
2341
|
+
"credential": {
|
|
2342
|
+
"type": "object",
|
|
2343
|
+
"additionalProperties": true
|
|
2344
|
+
},
|
|
2345
|
+
"remember": {
|
|
2346
|
+
"type": "boolean"
|
|
2347
|
+
}
|
|
2348
|
+
}
|
|
2349
|
+
}
|
|
2350
|
+
}
|
|
2351
|
+
}
|
|
2352
|
+
},
|
|
2353
|
+
"responses": {
|
|
2354
|
+
"200": {
|
|
2355
|
+
"description": "Logged in.",
|
|
2356
|
+
"content": {
|
|
2357
|
+
"application/json": {
|
|
2358
|
+
"schema": {
|
|
2359
|
+
"$ref": "#/components/schemas/Session"
|
|
2360
|
+
}
|
|
2361
|
+
}
|
|
2362
|
+
}
|
|
2363
|
+
},
|
|
2364
|
+
"403": {
|
|
2365
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2366
|
+
"content": {
|
|
2367
|
+
"application/problem+json": {
|
|
2368
|
+
"schema": {
|
|
2369
|
+
"$ref": "#/components/schemas/Problem"
|
|
2370
|
+
}
|
|
2371
|
+
}
|
|
2372
|
+
}
|
|
2373
|
+
},
|
|
2374
|
+
"422": {
|
|
2375
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
2376
|
+
"content": {
|
|
2377
|
+
"application/problem+json": {
|
|
2378
|
+
"schema": {
|
|
2379
|
+
"$ref": "#/components/schemas/Problem"
|
|
2380
|
+
}
|
|
2381
|
+
}
|
|
2382
|
+
}
|
|
2383
|
+
},
|
|
2384
|
+
"429": {
|
|
2385
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
2386
|
+
"content": {
|
|
2387
|
+
"application/problem+json": {
|
|
2388
|
+
"schema": {
|
|
2389
|
+
"$ref": "#/components/schemas/Problem"
|
|
2390
|
+
}
|
|
2391
|
+
}
|
|
2392
|
+
}
|
|
2393
|
+
}
|
|
2394
|
+
}
|
|
2395
|
+
},
|
|
2396
|
+
"parameters": [
|
|
2397
|
+
{
|
|
2398
|
+
"$ref": "#/components/parameters/Context"
|
|
2399
|
+
}
|
|
2400
|
+
]
|
|
2401
|
+
},
|
|
2402
|
+
"/account/passkeys": {
|
|
2403
|
+
"get": {
|
|
2404
|
+
"operationId": "listPasskeys",
|
|
2405
|
+
"responses": {
|
|
2406
|
+
"200": {
|
|
2407
|
+
"description": "The passkeys of the current user.",
|
|
2408
|
+
"content": {
|
|
2409
|
+
"application/json": {
|
|
2410
|
+
"schema": {
|
|
2411
|
+
"type": "object",
|
|
2412
|
+
"required": [
|
|
2413
|
+
"data"
|
|
2414
|
+
],
|
|
2415
|
+
"properties": {
|
|
2416
|
+
"data": {
|
|
2417
|
+
"type": "array",
|
|
2418
|
+
"items": {
|
|
2419
|
+
"$ref": "#/components/schemas/Passkey"
|
|
2420
|
+
}
|
|
2421
|
+
}
|
|
2422
|
+
}
|
|
2423
|
+
}
|
|
2424
|
+
}
|
|
2425
|
+
}
|
|
2426
|
+
},
|
|
2427
|
+
"401": {
|
|
2428
|
+
"description": "Not authenticated.",
|
|
2429
|
+
"content": {
|
|
2430
|
+
"application/problem+json": {
|
|
2431
|
+
"schema": {
|
|
2432
|
+
"$ref": "#/components/schemas/Problem"
|
|
2433
|
+
}
|
|
2434
|
+
}
|
|
2435
|
+
}
|
|
2436
|
+
},
|
|
2437
|
+
"403": {
|
|
2438
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2439
|
+
"content": {
|
|
2440
|
+
"application/problem+json": {
|
|
2441
|
+
"schema": {
|
|
2442
|
+
"$ref": "#/components/schemas/Problem"
|
|
2443
|
+
}
|
|
2444
|
+
}
|
|
2445
|
+
}
|
|
2446
|
+
}
|
|
2447
|
+
}
|
|
2448
|
+
},
|
|
2449
|
+
"post": {
|
|
2450
|
+
"operationId": "addPasskey",
|
|
2451
|
+
"summary": "Adds a passkey, with the credential of `navigator.credentials.create()` for the options of `POST /account/passkeys/options`.",
|
|
2452
|
+
"requestBody": {
|
|
2453
|
+
"required": true,
|
|
2454
|
+
"content": {
|
|
2455
|
+
"application/json": {
|
|
2456
|
+
"schema": {
|
|
2457
|
+
"type": "object",
|
|
2458
|
+
"required": [
|
|
2459
|
+
"name",
|
|
2460
|
+
"credential"
|
|
2461
|
+
],
|
|
2462
|
+
"properties": {
|
|
2463
|
+
"name": {
|
|
2464
|
+
"type": "string"
|
|
2465
|
+
},
|
|
2466
|
+
"credential": {
|
|
2467
|
+
"type": "object",
|
|
2468
|
+
"additionalProperties": true
|
|
2469
|
+
}
|
|
2470
|
+
}
|
|
2471
|
+
}
|
|
2472
|
+
}
|
|
2473
|
+
}
|
|
2474
|
+
},
|
|
2475
|
+
"responses": {
|
|
2476
|
+
"201": {
|
|
2477
|
+
"description": "The passkey.",
|
|
2478
|
+
"content": {
|
|
2479
|
+
"application/json": {
|
|
2480
|
+
"schema": {
|
|
2481
|
+
"type": "object",
|
|
2482
|
+
"required": [
|
|
2483
|
+
"data"
|
|
2484
|
+
],
|
|
2485
|
+
"properties": {
|
|
2486
|
+
"data": {
|
|
2487
|
+
"$ref": "#/components/schemas/Passkey"
|
|
2488
|
+
}
|
|
2489
|
+
}
|
|
2490
|
+
}
|
|
2491
|
+
}
|
|
2492
|
+
}
|
|
2493
|
+
},
|
|
2494
|
+
"401": {
|
|
2495
|
+
"description": "Not authenticated.",
|
|
2496
|
+
"content": {
|
|
2497
|
+
"application/problem+json": {
|
|
2498
|
+
"schema": {
|
|
2499
|
+
"$ref": "#/components/schemas/Problem"
|
|
2500
|
+
}
|
|
2501
|
+
}
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"403": {
|
|
2505
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2506
|
+
"content": {
|
|
2507
|
+
"application/problem+json": {
|
|
2508
|
+
"schema": {
|
|
2509
|
+
"$ref": "#/components/schemas/Problem"
|
|
2510
|
+
}
|
|
2511
|
+
}
|
|
2512
|
+
}
|
|
2513
|
+
},
|
|
2514
|
+
"409": {
|
|
2515
|
+
"description": "Conflict with a business rule.",
|
|
1675
2516
|
"content": {
|
|
1676
2517
|
"application/problem+json": {
|
|
1677
2518
|
"schema": {
|
|
@@ -1689,6 +2530,16 @@
|
|
|
1689
2530
|
}
|
|
1690
2531
|
}
|
|
1691
2532
|
}
|
|
2533
|
+
},
|
|
2534
|
+
"423": {
|
|
2535
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
2536
|
+
"content": {
|
|
2537
|
+
"application/problem+json": {
|
|
2538
|
+
"schema": {
|
|
2539
|
+
"$ref": "#/components/schemas/Problem"
|
|
2540
|
+
}
|
|
2541
|
+
}
|
|
2542
|
+
}
|
|
1692
2543
|
}
|
|
1693
2544
|
}
|
|
1694
2545
|
},
|
|
@@ -1698,23 +2549,53 @@
|
|
|
1698
2549
|
}
|
|
1699
2550
|
]
|
|
1700
2551
|
},
|
|
1701
|
-
"/
|
|
2552
|
+
"/account/passkeys/options": {
|
|
1702
2553
|
"post": {
|
|
1703
|
-
"operationId": "
|
|
2554
|
+
"operationId": "passkeyRegistrationOptions",
|
|
2555
|
+
"summary": "The options of `navigator.credentials.create()`, for the current user. A `409` for a user who can't have passkeys.",
|
|
1704
2556
|
"responses": {
|
|
1705
2557
|
"200": {
|
|
1706
|
-
"description": "
|
|
2558
|
+
"description": "The options.",
|
|
1707
2559
|
"content": {
|
|
1708
2560
|
"application/json": {
|
|
1709
2561
|
"schema": {
|
|
1710
|
-
"
|
|
1711
|
-
|
|
2562
|
+
"$ref": "#/components/schemas/WebAuthnOptions"
|
|
2563
|
+
}
|
|
2564
|
+
}
|
|
2565
|
+
}
|
|
2566
|
+
},
|
|
2567
|
+
"401": {
|
|
2568
|
+
"description": "Not authenticated.",
|
|
2569
|
+
"content": {
|
|
2570
|
+
"application/problem+json": {
|
|
2571
|
+
"schema": {
|
|
2572
|
+
"$ref": "#/components/schemas/Problem"
|
|
1712
2573
|
}
|
|
1713
2574
|
}
|
|
1714
2575
|
}
|
|
1715
2576
|
},
|
|
1716
2577
|
"403": {
|
|
1717
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
2578
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2579
|
+
"content": {
|
|
2580
|
+
"application/problem+json": {
|
|
2581
|
+
"schema": {
|
|
2582
|
+
"$ref": "#/components/schemas/Problem"
|
|
2583
|
+
}
|
|
2584
|
+
}
|
|
2585
|
+
}
|
|
2586
|
+
},
|
|
2587
|
+
"409": {
|
|
2588
|
+
"description": "Conflict with a business rule.",
|
|
2589
|
+
"content": {
|
|
2590
|
+
"application/problem+json": {
|
|
2591
|
+
"schema": {
|
|
2592
|
+
"$ref": "#/components/schemas/Problem"
|
|
2593
|
+
}
|
|
2594
|
+
}
|
|
2595
|
+
}
|
|
2596
|
+
},
|
|
2597
|
+
"423": {
|
|
2598
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
1718
2599
|
"content": {
|
|
1719
2600
|
"application/problem+json": {
|
|
1720
2601
|
"schema": {
|
|
@@ -1731,33 +2612,39 @@
|
|
|
1731
2612
|
}
|
|
1732
2613
|
]
|
|
1733
2614
|
},
|
|
1734
|
-
"/
|
|
1735
|
-
"
|
|
1736
|
-
|
|
1737
|
-
|
|
2615
|
+
"/account/passkeys/{passkey}": {
|
|
2616
|
+
"parameters": [
|
|
2617
|
+
{
|
|
2618
|
+
"name": "passkey",
|
|
2619
|
+
"in": "path",
|
|
1738
2620
|
"required": true,
|
|
1739
|
-
"
|
|
1740
|
-
|
|
1741
|
-
|
|
1742
|
-
"type": "object",
|
|
1743
|
-
"additionalProperties": true
|
|
1744
|
-
}
|
|
1745
|
-
}
|
|
2621
|
+
"description": "The id of the passkey.",
|
|
2622
|
+
"schema": {
|
|
2623
|
+
"type": "string"
|
|
1746
2624
|
}
|
|
1747
2625
|
},
|
|
2626
|
+
{
|
|
2627
|
+
"$ref": "#/components/parameters/Context"
|
|
2628
|
+
}
|
|
2629
|
+
],
|
|
2630
|
+
"delete": {
|
|
2631
|
+
"operationId": "deletePasskey",
|
|
1748
2632
|
"responses": {
|
|
1749
|
-
"
|
|
1750
|
-
"description": "
|
|
2633
|
+
"204": {
|
|
2634
|
+
"description": "Removed."
|
|
2635
|
+
},
|
|
2636
|
+
"401": {
|
|
2637
|
+
"description": "Not authenticated.",
|
|
1751
2638
|
"content": {
|
|
1752
|
-
"application/json": {
|
|
2639
|
+
"application/problem+json": {
|
|
1753
2640
|
"schema": {
|
|
1754
|
-
"$ref": "#/components/schemas/
|
|
2641
|
+
"$ref": "#/components/schemas/Problem"
|
|
1755
2642
|
}
|
|
1756
2643
|
}
|
|
1757
2644
|
}
|
|
1758
2645
|
},
|
|
1759
2646
|
"403": {
|
|
1760
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
2647
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1761
2648
|
"content": {
|
|
1762
2649
|
"application/problem+json": {
|
|
1763
2650
|
"schema": {
|
|
@@ -1766,8 +2653,18 @@
|
|
|
1766
2653
|
}
|
|
1767
2654
|
}
|
|
1768
2655
|
},
|
|
1769
|
-
"
|
|
1770
|
-
"description": "
|
|
2656
|
+
"404": {
|
|
2657
|
+
"description": "Not found.",
|
|
2658
|
+
"content": {
|
|
2659
|
+
"application/problem+json": {
|
|
2660
|
+
"schema": {
|
|
2661
|
+
"$ref": "#/components/schemas/Problem"
|
|
2662
|
+
}
|
|
2663
|
+
}
|
|
2664
|
+
}
|
|
2665
|
+
},
|
|
2666
|
+
"423": {
|
|
2667
|
+
"description": "The password must be confirmed first (`POST /auth/password/confirm`): a problem of type `urn:panneau:problem:password-confirmation`.",
|
|
1771
2668
|
"content": {
|
|
1772
2669
|
"application/problem+json": {
|
|
1773
2670
|
"schema": {
|
|
@@ -1777,16 +2674,12 @@
|
|
|
1777
2674
|
}
|
|
1778
2675
|
}
|
|
1779
2676
|
}
|
|
1780
|
-
}
|
|
1781
|
-
"parameters": [
|
|
1782
|
-
{
|
|
1783
|
-
"$ref": "#/components/parameters/Context"
|
|
1784
|
-
}
|
|
1785
|
-
]
|
|
2677
|
+
}
|
|
1786
2678
|
},
|
|
1787
2679
|
"/account": {
|
|
1788
2680
|
"get": {
|
|
1789
2681
|
"operationId": "getAccount",
|
|
2682
|
+
"summary": "With `auth.account`: the current user.",
|
|
1790
2683
|
"responses": {
|
|
1791
2684
|
"200": {
|
|
1792
2685
|
"description": "The current user.",
|
|
@@ -1817,7 +2710,7 @@
|
|
|
1817
2710
|
}
|
|
1818
2711
|
},
|
|
1819
2712
|
"403": {
|
|
1820
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
2713
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1821
2714
|
"content": {
|
|
1822
2715
|
"application/problem+json": {
|
|
1823
2716
|
"schema": {
|
|
@@ -1830,13 +2723,21 @@
|
|
|
1830
2723
|
},
|
|
1831
2724
|
"patch": {
|
|
1832
2725
|
"operationId": "updateAccount",
|
|
2726
|
+
"summary": "Saves the name and the email of the current user. With `auth.emailVerification`, a new email is unverified, and gets a link.",
|
|
1833
2727
|
"requestBody": {
|
|
1834
2728
|
"required": true,
|
|
1835
2729
|
"content": {
|
|
1836
2730
|
"application/json": {
|
|
1837
2731
|
"schema": {
|
|
1838
2732
|
"type": "object",
|
|
1839
|
-
"
|
|
2733
|
+
"properties": {
|
|
2734
|
+
"name": {
|
|
2735
|
+
"type": "string"
|
|
2736
|
+
},
|
|
2737
|
+
"email": {
|
|
2738
|
+
"type": "string"
|
|
2739
|
+
}
|
|
2740
|
+
}
|
|
1840
2741
|
}
|
|
1841
2742
|
}
|
|
1842
2743
|
}
|
|
@@ -1871,7 +2772,75 @@
|
|
|
1871
2772
|
}
|
|
1872
2773
|
},
|
|
1873
2774
|
"403": {
|
|
1874
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
2775
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2776
|
+
"content": {
|
|
2777
|
+
"application/problem+json": {
|
|
2778
|
+
"schema": {
|
|
2779
|
+
"$ref": "#/components/schemas/Problem"
|
|
2780
|
+
}
|
|
2781
|
+
}
|
|
2782
|
+
}
|
|
2783
|
+
},
|
|
2784
|
+
"422": {
|
|
2785
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
2786
|
+
"content": {
|
|
2787
|
+
"application/problem+json": {
|
|
2788
|
+
"schema": {
|
|
2789
|
+
"$ref": "#/components/schemas/Problem"
|
|
2790
|
+
}
|
|
2791
|
+
}
|
|
2792
|
+
}
|
|
2793
|
+
}
|
|
2794
|
+
}
|
|
2795
|
+
},
|
|
2796
|
+
"parameters": [
|
|
2797
|
+
{
|
|
2798
|
+
"$ref": "#/components/parameters/Context"
|
|
2799
|
+
}
|
|
2800
|
+
]
|
|
2801
|
+
},
|
|
2802
|
+
"/account/password": {
|
|
2803
|
+
"put": {
|
|
2804
|
+
"operationId": "updatePassword",
|
|
2805
|
+
"summary": "Changes the password of the current user, with the current one.",
|
|
2806
|
+
"requestBody": {
|
|
2807
|
+
"required": true,
|
|
2808
|
+
"content": {
|
|
2809
|
+
"application/json": {
|
|
2810
|
+
"schema": {
|
|
2811
|
+
"type": "object",
|
|
2812
|
+
"required": [
|
|
2813
|
+
"currentPassword",
|
|
2814
|
+
"password"
|
|
2815
|
+
],
|
|
2816
|
+
"properties": {
|
|
2817
|
+
"currentPassword": {
|
|
2818
|
+
"type": "string"
|
|
2819
|
+
},
|
|
2820
|
+
"password": {
|
|
2821
|
+
"type": "string"
|
|
2822
|
+
}
|
|
2823
|
+
}
|
|
2824
|
+
}
|
|
2825
|
+
}
|
|
2826
|
+
}
|
|
2827
|
+
},
|
|
2828
|
+
"responses": {
|
|
2829
|
+
"204": {
|
|
2830
|
+
"description": "The password was changed."
|
|
2831
|
+
},
|
|
2832
|
+
"401": {
|
|
2833
|
+
"description": "Not authenticated.",
|
|
2834
|
+
"content": {
|
|
2835
|
+
"application/problem+json": {
|
|
2836
|
+
"schema": {
|
|
2837
|
+
"$ref": "#/components/schemas/Problem"
|
|
2838
|
+
}
|
|
2839
|
+
}
|
|
2840
|
+
}
|
|
2841
|
+
},
|
|
2842
|
+
"403": {
|
|
2843
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1875
2844
|
"content": {
|
|
1876
2845
|
"application/problem+json": {
|
|
1877
2846
|
"schema": {
|
|
@@ -1889,6 +2858,16 @@
|
|
|
1889
2858
|
}
|
|
1890
2859
|
}
|
|
1891
2860
|
}
|
|
2861
|
+
},
|
|
2862
|
+
"429": {
|
|
2863
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
2864
|
+
"content": {
|
|
2865
|
+
"application/problem+json": {
|
|
2866
|
+
"schema": {
|
|
2867
|
+
"$ref": "#/components/schemas/Problem"
|
|
2868
|
+
}
|
|
2869
|
+
}
|
|
2870
|
+
}
|
|
1892
2871
|
}
|
|
1893
2872
|
}
|
|
1894
2873
|
},
|
|
@@ -1957,7 +2936,7 @@
|
|
|
1957
2936
|
}
|
|
1958
2937
|
},
|
|
1959
2938
|
"403": {
|
|
1960
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
2939
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
1961
2940
|
"content": {
|
|
1962
2941
|
"application/problem+json": {
|
|
1963
2942
|
"schema": {
|
|
@@ -2030,7 +3009,7 @@
|
|
|
2030
3009
|
}
|
|
2031
3010
|
},
|
|
2032
3011
|
"403": {
|
|
2033
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
3012
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2034
3013
|
"content": {
|
|
2035
3014
|
"application/problem+json": {
|
|
2036
3015
|
"schema": {
|
|
@@ -2107,7 +3086,7 @@
|
|
|
2107
3086
|
}
|
|
2108
3087
|
},
|
|
2109
3088
|
"403": {
|
|
2110
|
-
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`.",
|
|
3089
|
+
"description": "Not allowed. A value of `Panneau-Context` that the user can't use is a problem of type `urn:panneau:problem:context`, with its `param`. With `auth.emailVerification`, a user whose email address isn't verified gets a problem of type `urn:panneau:problem:email-unverified` on every operation but those of the auth. A user who must have two-factor authentication and hasn't set it up gets a problem of type `urn:panneau:problem:two-factor-required` on every operation but those of the auth and of `/account/two-factor`.",
|
|
2111
3090
|
"content": {
|
|
2112
3091
|
"application/problem+json": {
|
|
2113
3092
|
"schema": {
|
|
@@ -2247,7 +3226,100 @@
|
|
|
2247
3226
|
"properties": {
|
|
2248
3227
|
"rule": {
|
|
2249
3228
|
"type": "string",
|
|
2250
|
-
"const": "required"
|
|
3229
|
+
"const": "required"
|
|
3230
|
+
},
|
|
3231
|
+
"message": {
|
|
3232
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
3233
|
+
"type": "string"
|
|
3234
|
+
},
|
|
3235
|
+
"mode": {
|
|
3236
|
+
"description": "The rule only applies when the item is created (`create`) or updated (`update`): a password required to create a user, optional to edit one. Without it, the rule applies in both modes.",
|
|
3237
|
+
"type": "string",
|
|
3238
|
+
"enum": [
|
|
3239
|
+
"create",
|
|
3240
|
+
"update"
|
|
3241
|
+
]
|
|
3242
|
+
}
|
|
3243
|
+
},
|
|
3244
|
+
"required": [
|
|
3245
|
+
"rule"
|
|
3246
|
+
],
|
|
3247
|
+
"additionalProperties": {}
|
|
3248
|
+
},
|
|
3249
|
+
{
|
|
3250
|
+
"type": "object",
|
|
3251
|
+
"properties": {
|
|
3252
|
+
"rule": {
|
|
3253
|
+
"type": "string",
|
|
3254
|
+
"enum": [
|
|
3255
|
+
"min",
|
|
3256
|
+
"max"
|
|
3257
|
+
]
|
|
3258
|
+
},
|
|
3259
|
+
"value": {
|
|
3260
|
+
"type": "number"
|
|
3261
|
+
},
|
|
3262
|
+
"message": {
|
|
3263
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
3264
|
+
"type": "string"
|
|
3265
|
+
},
|
|
3266
|
+
"mode": {
|
|
3267
|
+
"description": "The rule only applies when the item is created (`create`) or updated (`update`): a password required to create a user, optional to edit one. Without it, the rule applies in both modes.",
|
|
3268
|
+
"type": "string",
|
|
3269
|
+
"enum": [
|
|
3270
|
+
"create",
|
|
3271
|
+
"update"
|
|
3272
|
+
]
|
|
3273
|
+
}
|
|
3274
|
+
},
|
|
3275
|
+
"required": [
|
|
3276
|
+
"rule",
|
|
3277
|
+
"value"
|
|
3278
|
+
],
|
|
3279
|
+
"additionalProperties": {}
|
|
3280
|
+
},
|
|
3281
|
+
{
|
|
3282
|
+
"type": "object",
|
|
3283
|
+
"properties": {
|
|
3284
|
+
"rule": {
|
|
3285
|
+
"type": "string",
|
|
3286
|
+
"const": "pattern"
|
|
3287
|
+
},
|
|
3288
|
+
"value": {
|
|
3289
|
+
"type": "string"
|
|
3290
|
+
},
|
|
3291
|
+
"flags": {
|
|
3292
|
+
"type": "string"
|
|
3293
|
+
},
|
|
3294
|
+
"message": {
|
|
3295
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
3296
|
+
"type": "string"
|
|
3297
|
+
},
|
|
3298
|
+
"mode": {
|
|
3299
|
+
"description": "The rule only applies when the item is created (`create`) or updated (`update`): a password required to create a user, optional to edit one. Without it, the rule applies in both modes.",
|
|
3300
|
+
"type": "string",
|
|
3301
|
+
"enum": [
|
|
3302
|
+
"create",
|
|
3303
|
+
"update"
|
|
3304
|
+
]
|
|
3305
|
+
}
|
|
3306
|
+
},
|
|
3307
|
+
"required": [
|
|
3308
|
+
"rule",
|
|
3309
|
+
"value"
|
|
3310
|
+
],
|
|
3311
|
+
"additionalProperties": {}
|
|
3312
|
+
},
|
|
3313
|
+
{
|
|
3314
|
+
"type": "object",
|
|
3315
|
+
"properties": {
|
|
3316
|
+
"rule": {
|
|
3317
|
+
"type": "string",
|
|
3318
|
+
"enum": [
|
|
3319
|
+
"email",
|
|
3320
|
+
"url",
|
|
3321
|
+
"json"
|
|
3322
|
+
]
|
|
2251
3323
|
},
|
|
2252
3324
|
"message": {
|
|
2253
3325
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
@@ -2272,13 +3344,11 @@
|
|
|
2272
3344
|
"properties": {
|
|
2273
3345
|
"rule": {
|
|
2274
3346
|
"type": "string",
|
|
2275
|
-
"
|
|
2276
|
-
"min",
|
|
2277
|
-
"max"
|
|
2278
|
-
]
|
|
3347
|
+
"const": "tel"
|
|
2279
3348
|
},
|
|
2280
|
-
"
|
|
2281
|
-
"
|
|
3349
|
+
"extension": {
|
|
3350
|
+
"description": "The number can have an extension, after `;ext=` as in a `tel:` URI (RFC 3966): `+15145550199;ext=123`, 1 to 10 digits. Without it, a value with an extension fails.",
|
|
3351
|
+
"type": "boolean"
|
|
2282
3352
|
},
|
|
2283
3353
|
"message": {
|
|
2284
3354
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
@@ -2294,8 +3364,7 @@
|
|
|
2294
3364
|
}
|
|
2295
3365
|
},
|
|
2296
3366
|
"required": [
|
|
2297
|
-
"rule"
|
|
2298
|
-
"value"
|
|
3367
|
+
"rule"
|
|
2299
3368
|
],
|
|
2300
3369
|
"additionalProperties": {}
|
|
2301
3370
|
},
|
|
@@ -2304,13 +3373,16 @@
|
|
|
2304
3373
|
"properties": {
|
|
2305
3374
|
"rule": {
|
|
2306
3375
|
"type": "string",
|
|
2307
|
-
"const": "
|
|
2308
|
-
},
|
|
2309
|
-
"value": {
|
|
2310
|
-
"type": "string"
|
|
3376
|
+
"const": "daterange"
|
|
2311
3377
|
},
|
|
2312
|
-
"
|
|
2313
|
-
"type": "string"
|
|
3378
|
+
"open": {
|
|
3379
|
+
"type": "string",
|
|
3380
|
+
"enum": [
|
|
3381
|
+
"start",
|
|
3382
|
+
"end",
|
|
3383
|
+
"both"
|
|
3384
|
+
],
|
|
3385
|
+
"description": "Which bounds of the range can be `null`: `start`, `end` or `both`."
|
|
2314
3386
|
},
|
|
2315
3387
|
"message": {
|
|
2316
3388
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
@@ -2326,8 +3398,7 @@
|
|
|
2326
3398
|
}
|
|
2327
3399
|
},
|
|
2328
3400
|
"required": [
|
|
2329
|
-
"rule"
|
|
2330
|
-
"value"
|
|
3401
|
+
"rule"
|
|
2331
3402
|
],
|
|
2332
3403
|
"additionalProperties": {}
|
|
2333
3404
|
},
|
|
@@ -2336,12 +3407,16 @@
|
|
|
2336
3407
|
"properties": {
|
|
2337
3408
|
"rule": {
|
|
2338
3409
|
"type": "string",
|
|
2339
|
-
"
|
|
2340
|
-
|
|
2341
|
-
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
|
|
3410
|
+
"const": "money"
|
|
3411
|
+
},
|
|
3412
|
+
"currencies": {
|
|
3413
|
+
"description": "The currencies allowed. Without them, any ISO 4217 currency.",
|
|
3414
|
+
"type": "array",
|
|
3415
|
+
"items": {
|
|
3416
|
+
"type": "string",
|
|
3417
|
+
"pattern": "^[A-Z]{3}$",
|
|
3418
|
+
"description": "An ISO 4217 currency code, in capitals: `CAD`."
|
|
3419
|
+
}
|
|
2345
3420
|
},
|
|
2346
3421
|
"message": {
|
|
2347
3422
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
@@ -2512,6 +3587,55 @@
|
|
|
2512
3587
|
],
|
|
2513
3588
|
"additionalProperties": {}
|
|
2514
3589
|
},
|
|
3590
|
+
{
|
|
3591
|
+
"type": "object",
|
|
3592
|
+
"properties": {
|
|
3593
|
+
"rule": {
|
|
3594
|
+
"type": "string",
|
|
3595
|
+
"const": "postalCode"
|
|
3596
|
+
},
|
|
3597
|
+
"value": {
|
|
3598
|
+
"description": "The country of the postal code. Without it, or without a country, any postal code passes. An `address` value has its own country.",
|
|
3599
|
+
"anyOf": [
|
|
3600
|
+
{
|
|
3601
|
+
"type": "string",
|
|
3602
|
+
"pattern": "^[A-Z]{2}$",
|
|
3603
|
+
"description": "An ISO 3166-1 alpha-2 code, in capitals: `CA`."
|
|
3604
|
+
},
|
|
3605
|
+
{
|
|
3606
|
+
"type": "object",
|
|
3607
|
+
"properties": {
|
|
3608
|
+
"field": {
|
|
3609
|
+
"type": "string",
|
|
3610
|
+
"minLength": 1
|
|
3611
|
+
}
|
|
3612
|
+
},
|
|
3613
|
+
"required": [
|
|
3614
|
+
"field"
|
|
3615
|
+
],
|
|
3616
|
+
"additionalProperties": {},
|
|
3617
|
+
"description": "Another field of the form, which holds the country."
|
|
3618
|
+
}
|
|
3619
|
+
]
|
|
3620
|
+
},
|
|
3621
|
+
"message": {
|
|
3622
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
3623
|
+
"type": "string"
|
|
3624
|
+
},
|
|
3625
|
+
"mode": {
|
|
3626
|
+
"description": "The rule only applies when the item is created (`create`) or updated (`update`): a password required to create a user, optional to edit one. Without it, the rule applies in both modes.",
|
|
3627
|
+
"type": "string",
|
|
3628
|
+
"enum": [
|
|
3629
|
+
"create",
|
|
3630
|
+
"update"
|
|
3631
|
+
]
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"required": [
|
|
3635
|
+
"rule"
|
|
3636
|
+
],
|
|
3637
|
+
"additionalProperties": {}
|
|
3638
|
+
},
|
|
2515
3639
|
{
|
|
2516
3640
|
"type": "object",
|
|
2517
3641
|
"properties": {
|
|
@@ -2557,6 +3681,41 @@
|
|
|
2557
3681
|
],
|
|
2558
3682
|
"additionalProperties": {}
|
|
2559
3683
|
},
|
|
3684
|
+
{
|
|
3685
|
+
"type": "object",
|
|
3686
|
+
"properties": {
|
|
3687
|
+
"rule": {
|
|
3688
|
+
"type": "string",
|
|
3689
|
+
"const": "providers"
|
|
3690
|
+
},
|
|
3691
|
+
"value": {
|
|
3692
|
+
"minItems": 1,
|
|
3693
|
+
"type": "array",
|
|
3694
|
+
"items": {
|
|
3695
|
+
"type": "string",
|
|
3696
|
+
"minLength": 1
|
|
3697
|
+
}
|
|
3698
|
+
},
|
|
3699
|
+
"message": {
|
|
3700
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
3701
|
+
"type": "string"
|
|
3702
|
+
},
|
|
3703
|
+
"mode": {
|
|
3704
|
+
"description": "The rule only applies when the item is created (`create`) or updated (`update`): a password required to create a user, optional to edit one. Without it, the rule applies in both modes.",
|
|
3705
|
+
"type": "string",
|
|
3706
|
+
"enum": [
|
|
3707
|
+
"create",
|
|
3708
|
+
"update"
|
|
3709
|
+
]
|
|
3710
|
+
}
|
|
3711
|
+
},
|
|
3712
|
+
"required": [
|
|
3713
|
+
"rule",
|
|
3714
|
+
"value"
|
|
3715
|
+
],
|
|
3716
|
+
"additionalProperties": {},
|
|
3717
|
+
"description": "The providers an `embed` value may come from: the `provider_name` of their oEmbed (`YouTube`), compared without case (decision 0058)."
|
|
3718
|
+
},
|
|
2560
3719
|
{
|
|
2561
3720
|
"type": "object",
|
|
2562
3721
|
"properties": {
|
|
@@ -2583,7 +3742,7 @@
|
|
|
2583
3742
|
"description": "A rule added in a later version of the protocol. Clients that don't know it ignore it; the server still enforces it."
|
|
2584
3743
|
}
|
|
2585
3744
|
],
|
|
2586
|
-
"description": "A portable validation rule. `min` and `max` apply to numbers, and to the length of text and arrays. `accept` lists MIME types (`image/*`). `maxSize` is in bytes. `crop` checks the transform of each image of an `image` or `media` value (decision 0031)."
|
|
3745
|
+
"description": "A portable validation rule. `min` and `max` apply to numbers, to the amount of `money` values (in minor units), and to the length of text and arrays. `daterange` and `money` are implied by their types, with the `open` bounds and the `currencies` of the field (decision 0053). `accept` lists MIME types (`image/*`). `maxSize` is in bytes. `tel` checks an E.164 number, with an extension when `extension` is `true`. `crop` checks the transform of each image of an `image` or `media` value (decision 0031). `postalCode` checks a postal code against the format of its country, for the countries whose format Panneau knows: Canada and the United States (decision 0054). `providers` lists the providers of an `embed` value (decision 0058)."
|
|
2587
3746
|
},
|
|
2588
3747
|
"BlockType": {
|
|
2589
3748
|
"type": "object",
|
|
@@ -2669,11 +3828,11 @@
|
|
|
2669
3828
|
}
|
|
2670
3829
|
},
|
|
2671
3830
|
"multiple": {
|
|
2672
|
-
"description": "`select`, `relation`, `media`, `image`, `file`: the value is an array.",
|
|
3831
|
+
"description": "`select`, `relation`, `media`, `image`, `file`, `country`: the value is an array.",
|
|
2673
3832
|
"type": "boolean"
|
|
2674
3833
|
},
|
|
2675
3834
|
"resource": {
|
|
2676
|
-
"description": "`relation`: id of the related resource. `media`, `image`: id of a resource of kind `media`, or a list of them; without it, every library of the definition (decision 0027).",
|
|
3835
|
+
"description": "`relation`: id of the related resource. `media`, `image`: id of a resource of kind `media`, or a list of them; without it, every library of the definition (decision 0027). `link`: the resources of its `page` links (decision 0055).",
|
|
2677
3836
|
"anyOf": [
|
|
2678
3837
|
{
|
|
2679
3838
|
"type": "string",
|
|
@@ -2827,24 +3986,247 @@
|
|
|
2827
3986
|
"$ref": "#/components/schemas/RichTextStyle"
|
|
2828
3987
|
}
|
|
2829
3988
|
},
|
|
2830
|
-
"links": {
|
|
2831
|
-
"type": "object",
|
|
2832
|
-
"properties": {
|
|
2833
|
-
"newTab": {
|
|
2834
|
-
"description": "Which links open in a new tab (`target=\"_blank\" rel=\"noopener noreferrer\"`): as the user chooses (the default), every link to another site, or none.",
|
|
2835
|
-
"type": "string",
|
|
2836
|
-
"enum": [
|
|
2837
|
-
"choose",
|
|
2838
|
-
"external",
|
|
2839
|
-
"never"
|
|
2840
|
-
]
|
|
2841
|
-
}
|
|
2842
|
-
},
|
|
2843
|
-
"additionalProperties": {}
|
|
3989
|
+
"links": {
|
|
3990
|
+
"type": "object",
|
|
3991
|
+
"properties": {
|
|
3992
|
+
"newTab": {
|
|
3993
|
+
"description": "Which links open in a new tab (`target=\"_blank\" rel=\"noopener noreferrer\"`): as the user chooses (the default), every link to another site, or none.",
|
|
3994
|
+
"type": "string",
|
|
3995
|
+
"enum": [
|
|
3996
|
+
"choose",
|
|
3997
|
+
"external",
|
|
3998
|
+
"never"
|
|
3999
|
+
]
|
|
4000
|
+
}
|
|
4001
|
+
},
|
|
4002
|
+
"additionalProperties": {}
|
|
4003
|
+
}
|
|
4004
|
+
},
|
|
4005
|
+
"additionalProperties": {},
|
|
4006
|
+
"description": "The `settings` of a `richtext` field. Its value is HTML. The toolbar only limits what users add: content that the field stores keeps its elements and attributes."
|
|
4007
|
+
},
|
|
4008
|
+
"LinkTypeSetting": {
|
|
4009
|
+
"type": "object",
|
|
4010
|
+
"properties": {
|
|
4011
|
+
"id": {
|
|
4012
|
+
"type": "string",
|
|
4013
|
+
"minLength": 1,
|
|
4014
|
+
"description": "The id of the type, in the `type` of values: `anchor`."
|
|
4015
|
+
},
|
|
4016
|
+
"label": {
|
|
4017
|
+
"type": "string",
|
|
4018
|
+
"description": "The name of the type, in the field."
|
|
4019
|
+
},
|
|
4020
|
+
"pattern": {
|
|
4021
|
+
"description": "The pattern that the `url` of its links matches: `^#[\\w-]+$`.",
|
|
4022
|
+
"type": "string"
|
|
4023
|
+
},
|
|
4024
|
+
"placeholder": {
|
|
4025
|
+
"type": "string"
|
|
4026
|
+
}
|
|
4027
|
+
},
|
|
4028
|
+
"required": [
|
|
4029
|
+
"id",
|
|
4030
|
+
"label"
|
|
4031
|
+
],
|
|
4032
|
+
"additionalProperties": {},
|
|
4033
|
+
"description": "A type of link that a site adds: its `url` is the text typed, checked against its `pattern`."
|
|
4034
|
+
},
|
|
4035
|
+
"LinkSettings": {
|
|
4036
|
+
"type": "object",
|
|
4037
|
+
"properties": {
|
|
4038
|
+
"types": {
|
|
4039
|
+
"description": "The types the field offers, in order: `url`, `page`, `email`, `tel`, `file`, and the types of the site. Defaults to `url`, `email` and `tel`, after `page` when the field has a `resource`.",
|
|
4040
|
+
"minItems": 1,
|
|
4041
|
+
"type": "array",
|
|
4042
|
+
"items": {
|
|
4043
|
+
"anyOf": [
|
|
4044
|
+
{
|
|
4045
|
+
"type": "string",
|
|
4046
|
+
"enum": [
|
|
4047
|
+
"url",
|
|
4048
|
+
"page",
|
|
4049
|
+
"email",
|
|
4050
|
+
"tel",
|
|
4051
|
+
"file"
|
|
4052
|
+
]
|
|
4053
|
+
},
|
|
4054
|
+
{
|
|
4055
|
+
"$ref": "#/components/schemas/LinkTypeSetting"
|
|
4056
|
+
}
|
|
4057
|
+
]
|
|
4058
|
+
}
|
|
4059
|
+
},
|
|
4060
|
+
"newTab": {
|
|
4061
|
+
"description": "Which links open in a new tab: as the user chooses (the default), by their type (`url` and `file` links), or none.",
|
|
4062
|
+
"type": "string",
|
|
4063
|
+
"enum": [
|
|
4064
|
+
"choose",
|
|
4065
|
+
"external",
|
|
4066
|
+
"never"
|
|
4067
|
+
]
|
|
4068
|
+
},
|
|
4069
|
+
"label": {
|
|
4070
|
+
"description": "Whether links have a label: optional (the default), required, or none.",
|
|
4071
|
+
"type": "string",
|
|
4072
|
+
"enum": [
|
|
4073
|
+
"optional",
|
|
4074
|
+
"required",
|
|
4075
|
+
"none"
|
|
4076
|
+
]
|
|
4077
|
+
},
|
|
4078
|
+
"libraries": {
|
|
4079
|
+
"description": "The media libraries of `file` links. Defaults to every library of the definition.",
|
|
4080
|
+
"type": "array",
|
|
4081
|
+
"items": {
|
|
4082
|
+
"type": "string",
|
|
4083
|
+
"minLength": 1
|
|
4084
|
+
}
|
|
4085
|
+
}
|
|
4086
|
+
},
|
|
4087
|
+
"additionalProperties": {},
|
|
4088
|
+
"description": "The `settings` of a `link` field. Its value is `{ \"type\", \"url\", \"page\", \"file\", \"label\", \"newTab\" }` (`LinkValue`)."
|
|
4089
|
+
},
|
|
4090
|
+
"AddressSettings": {
|
|
4091
|
+
"type": "object",
|
|
4092
|
+
"properties": {
|
|
4093
|
+
"country": {
|
|
4094
|
+
"description": "The country of a new address. The field sets it once a part is typed.",
|
|
4095
|
+
"type": "string",
|
|
4096
|
+
"pattern": "^[A-Z]{2}$"
|
|
4097
|
+
},
|
|
4098
|
+
"countries": {
|
|
4099
|
+
"description": "The countries the field allows. With one, the field doesn't show the country, and sets it.",
|
|
4100
|
+
"type": "array",
|
|
4101
|
+
"items": {
|
|
4102
|
+
"type": "string",
|
|
4103
|
+
"pattern": "^[A-Z]{2}$",
|
|
4104
|
+
"description": "An ISO 3166-1 alpha-2 code, in capitals: `CA`."
|
|
4105
|
+
}
|
|
4106
|
+
},
|
|
4107
|
+
"preferred": {
|
|
4108
|
+
"description": "The countries shown first.",
|
|
4109
|
+
"type": "array",
|
|
4110
|
+
"items": {
|
|
4111
|
+
"type": "string",
|
|
4112
|
+
"pattern": "^[A-Z]{2}$",
|
|
4113
|
+
"description": "An ISO 3166-1 alpha-2 code, in capitals: `CA`."
|
|
4114
|
+
}
|
|
4115
|
+
},
|
|
4116
|
+
"required": {
|
|
4117
|
+
"description": "The parts a filled address must have. Defaults to `street`, `city` and `country`.",
|
|
4118
|
+
"type": "array",
|
|
4119
|
+
"items": {
|
|
4120
|
+
"type": "string",
|
|
4121
|
+
"enum": [
|
|
4122
|
+
"country",
|
|
4123
|
+
"street",
|
|
4124
|
+
"unit",
|
|
4125
|
+
"city",
|
|
4126
|
+
"region",
|
|
4127
|
+
"postalCode"
|
|
4128
|
+
]
|
|
4129
|
+
}
|
|
4130
|
+
},
|
|
4131
|
+
"point": {
|
|
4132
|
+
"description": "Adds a map, and the point of the address to the value.",
|
|
4133
|
+
"type": "boolean"
|
|
4134
|
+
}
|
|
4135
|
+
},
|
|
4136
|
+
"additionalProperties": {},
|
|
4137
|
+
"description": "The `settings` of an `address` field. Its value is `{ \"street\", \"unit\", \"city\", \"region\", \"postalCode\", \"country\", \"point\" }` (`AddressValue`)."
|
|
4138
|
+
},
|
|
4139
|
+
"DateRangeSettings": {
|
|
4140
|
+
"type": "object",
|
|
4141
|
+
"properties": {
|
|
4142
|
+
"time": {
|
|
4143
|
+
"description": "The bounds are date-times, with an offset (`2026-11-04T23:30:00Z`). Without it, they are days (`2026-11-04`), both inclusive.",
|
|
4144
|
+
"type": "boolean"
|
|
4145
|
+
},
|
|
4146
|
+
"allDay": {
|
|
4147
|
+
"description": "With `time`: an \"All day\" switch. An all-day value has days as bounds, and `\"allDay\": true`.",
|
|
4148
|
+
"type": "boolean"
|
|
4149
|
+
},
|
|
4150
|
+
"open": {
|
|
4151
|
+
"type": "string",
|
|
4152
|
+
"enum": [
|
|
4153
|
+
"start",
|
|
4154
|
+
"end",
|
|
4155
|
+
"both"
|
|
4156
|
+
],
|
|
4157
|
+
"description": "Which bounds of the range can be `null`: `start`, `end` or `both`."
|
|
4158
|
+
},
|
|
4159
|
+
"timeZone": {
|
|
4160
|
+
"description": "The IANA time zone the date-times are shown and typed in (`America/Toronto`), when the value has none. Without it, the browser's.",
|
|
4161
|
+
"type": "string",
|
|
4162
|
+
"minLength": 1
|
|
4163
|
+
},
|
|
4164
|
+
"chooseTimeZone": {
|
|
4165
|
+
"description": "With `time`: the field has a menu of time zones, and keeps the choice in the value (`timeZone`).",
|
|
4166
|
+
"type": "boolean"
|
|
4167
|
+
}
|
|
4168
|
+
},
|
|
4169
|
+
"additionalProperties": {},
|
|
4170
|
+
"description": "The `settings` of a `daterange` field: days or date-times, an \"All day\" switch, open bounds and the time zone of its date-times."
|
|
4171
|
+
},
|
|
4172
|
+
"MoneySettings": {
|
|
4173
|
+
"type": "object",
|
|
4174
|
+
"properties": {
|
|
4175
|
+
"currency": {
|
|
4176
|
+
"description": "The currency of every amount: the field shows it and cannot change it.",
|
|
4177
|
+
"type": "string",
|
|
4178
|
+
"pattern": "^[A-Z]{3}$"
|
|
4179
|
+
},
|
|
4180
|
+
"currencies": {
|
|
4181
|
+
"description": "The currencies the user picks from, the first one for a new amount. Without `currency` or `currencies`, every currency.",
|
|
4182
|
+
"minItems": 1,
|
|
4183
|
+
"type": "array",
|
|
4184
|
+
"items": {
|
|
4185
|
+
"type": "string",
|
|
4186
|
+
"pattern": "^[A-Z]{3}$",
|
|
4187
|
+
"description": "An ISO 4217 currency code, in capitals: `CAD`."
|
|
4188
|
+
}
|
|
4189
|
+
}
|
|
4190
|
+
},
|
|
4191
|
+
"additionalProperties": {},
|
|
4192
|
+
"description": "The `settings` of a `money` field: its currency, or the currencies to pick from. `min` and `max` rules apply to the amount, in minor units."
|
|
4193
|
+
},
|
|
4194
|
+
"DurationSettings": {
|
|
4195
|
+
"type": "object",
|
|
4196
|
+
"properties": {
|
|
4197
|
+
"unit": {
|
|
4198
|
+
"description": "The unit of the value, a whole number: `seconds` (the default), `minutes`, `hours` or `days`. The `min` and `max` rules are in it too.",
|
|
4199
|
+
"type": "string",
|
|
4200
|
+
"enum": [
|
|
4201
|
+
"seconds",
|
|
4202
|
+
"minutes",
|
|
4203
|
+
"hours",
|
|
4204
|
+
"days"
|
|
4205
|
+
]
|
|
4206
|
+
},
|
|
4207
|
+
"precision": {
|
|
4208
|
+
"description": "The smallest part the input shows. Defaults to `unit`; a precision finer than `unit` is raised to it.",
|
|
4209
|
+
"type": "string",
|
|
4210
|
+
"enum": [
|
|
4211
|
+
"seconds",
|
|
4212
|
+
"minutes",
|
|
4213
|
+
"hours",
|
|
4214
|
+
"days"
|
|
4215
|
+
]
|
|
4216
|
+
},
|
|
4217
|
+
"largestUnit": {
|
|
4218
|
+
"description": "The largest part the input shows, which has no upper bound: `days` shows days, and hours from 0 to 23. Defaults to the larger of `hours` and `precision`; a largest unit smaller than `precision` is raised to it.",
|
|
4219
|
+
"type": "string",
|
|
4220
|
+
"enum": [
|
|
4221
|
+
"seconds",
|
|
4222
|
+
"minutes",
|
|
4223
|
+
"hours",
|
|
4224
|
+
"days"
|
|
4225
|
+
]
|
|
2844
4226
|
}
|
|
2845
4227
|
},
|
|
2846
4228
|
"additionalProperties": {},
|
|
2847
|
-
"description": "The `settings` of a `
|
|
4229
|
+
"description": "The `settings` of a `duration` field. Its value is a whole number of `unit`, zero or more. A day is 24 hours."
|
|
2848
4230
|
},
|
|
2849
4231
|
"LayoutNode": {
|
|
2850
4232
|
"type": "object",
|
|
@@ -3537,7 +4919,7 @@
|
|
|
3537
4919
|
"type": "string"
|
|
3538
4920
|
},
|
|
3539
4921
|
"url": {
|
|
3540
|
-
"description": "Where the login with this provider starts.",
|
|
4922
|
+
"description": "Where the login with this provider starts, with a full navigation. The app adds `next`, the path to come back to.",
|
|
3541
4923
|
"type": "string"
|
|
3542
4924
|
},
|
|
3543
4925
|
"icon": {
|
|
@@ -3603,16 +4985,24 @@
|
|
|
3603
4985
|
"$ref": "#/components/schemas/AuthProvider"
|
|
3604
4986
|
}
|
|
3605
4987
|
},
|
|
4988
|
+
"account": {
|
|
4989
|
+
"description": "`panneau`: the account page of the user, on `/account`: their name and email, their password, their two-factor authentication.",
|
|
4990
|
+
"type": "boolean"
|
|
4991
|
+
},
|
|
3606
4992
|
"passwordReset": {
|
|
4993
|
+
"description": "`panneau`: a \"Forgot your password?\" link on the login page, through `POST /auth/password/forgot` and `POST /auth/password/reset`.",
|
|
3607
4994
|
"type": "boolean"
|
|
3608
4995
|
},
|
|
3609
4996
|
"twoFactor": {
|
|
4997
|
+
"description": "`panneau`: two-factor authentication, which users set up through `/account/two-factor`, and which a password login asks for with a `202`.",
|
|
3610
4998
|
"type": "boolean"
|
|
3611
4999
|
},
|
|
3612
5000
|
"passkeys": {
|
|
5001
|
+
"description": "`panneau`: logins with a passkey (WebAuthn), which users add on the account page.",
|
|
3613
5002
|
"type": "boolean"
|
|
3614
5003
|
},
|
|
3615
5004
|
"emailVerification": {
|
|
5005
|
+
"description": "`panneau`: the backend refuses users whose email address isn't verified with a `403` problem of type `urn:panneau:problem:email-unverified`, and verifies it through `POST /auth/email/verification` and `POST /auth/email/verify`.",
|
|
3616
5006
|
"type": "boolean"
|
|
3617
5007
|
}
|
|
3618
5008
|
},
|
|
@@ -5438,6 +6828,138 @@
|
|
|
5438
6828
|
],
|
|
5439
6829
|
"additionalProperties": {}
|
|
5440
6830
|
},
|
|
6831
|
+
"TwoFactorChallenge": {
|
|
6832
|
+
"type": "object",
|
|
6833
|
+
"properties": {
|
|
6834
|
+
"twoFactor": {
|
|
6835
|
+
"type": "boolean",
|
|
6836
|
+
"const": true
|
|
6837
|
+
}
|
|
6838
|
+
},
|
|
6839
|
+
"required": [
|
|
6840
|
+
"twoFactor"
|
|
6841
|
+
],
|
|
6842
|
+
"additionalProperties": {},
|
|
6843
|
+
"description": "The answer of `POST /auth/login` when a second factor is needed: the login waits for `POST /auth/two-factor/challenge`."
|
|
6844
|
+
},
|
|
6845
|
+
"TwoFactorStatus": {
|
|
6846
|
+
"type": "object",
|
|
6847
|
+
"properties": {
|
|
6848
|
+
"status": {
|
|
6849
|
+
"type": "string",
|
|
6850
|
+
"enum": [
|
|
6851
|
+
"disabled",
|
|
6852
|
+
"pending",
|
|
6853
|
+
"enabled"
|
|
6854
|
+
],
|
|
6855
|
+
"description": "`pending`: set up, not confirmed with a code yet."
|
|
6856
|
+
},
|
|
6857
|
+
"required": {
|
|
6858
|
+
"type": "boolean",
|
|
6859
|
+
"description": "The backend requires it for this user: it can't be turned off."
|
|
6860
|
+
}
|
|
6861
|
+
},
|
|
6862
|
+
"required": [
|
|
6863
|
+
"status",
|
|
6864
|
+
"required"
|
|
6865
|
+
],
|
|
6866
|
+
"additionalProperties": {},
|
|
6867
|
+
"description": "The two-factor authentication of the current user."
|
|
6868
|
+
},
|
|
6869
|
+
"TwoFactorSetup": {
|
|
6870
|
+
"type": "object",
|
|
6871
|
+
"properties": {
|
|
6872
|
+
"secret": {
|
|
6873
|
+
"type": "string",
|
|
6874
|
+
"description": "The secret, to type in an authenticator app."
|
|
6875
|
+
},
|
|
6876
|
+
"otpauthUrl": {
|
|
6877
|
+
"type": "string",
|
|
6878
|
+
"description": "The `otpauth://totp/…` URL of the secret."
|
|
6879
|
+
},
|
|
6880
|
+
"qrCode": {
|
|
6881
|
+
"description": "An SVG document of the QR code of `otpauthUrl`. Clients show it as an image, never as markup.",
|
|
6882
|
+
"type": "string"
|
|
6883
|
+
}
|
|
6884
|
+
},
|
|
6885
|
+
"required": [
|
|
6886
|
+
"secret",
|
|
6887
|
+
"otpauthUrl"
|
|
6888
|
+
],
|
|
6889
|
+
"additionalProperties": {},
|
|
6890
|
+
"description": "A two-factor authentication to confirm with a code."
|
|
6891
|
+
},
|
|
6892
|
+
"RecoveryCodes": {
|
|
6893
|
+
"type": "object",
|
|
6894
|
+
"properties": {
|
|
6895
|
+
"recoveryCodes": {
|
|
6896
|
+
"type": "array",
|
|
6897
|
+
"items": {
|
|
6898
|
+
"type": "string"
|
|
6899
|
+
}
|
|
6900
|
+
}
|
|
6901
|
+
},
|
|
6902
|
+
"required": [
|
|
6903
|
+
"recoveryCodes"
|
|
6904
|
+
],
|
|
6905
|
+
"additionalProperties": {},
|
|
6906
|
+
"description": "Codes that each log in once in place of a code of the authenticator app."
|
|
6907
|
+
},
|
|
6908
|
+
"WebAuthnOptions": {
|
|
6909
|
+
"type": "object",
|
|
6910
|
+
"properties": {
|
|
6911
|
+
"options": {
|
|
6912
|
+
"type": "object",
|
|
6913
|
+
"propertyNames": {
|
|
6914
|
+
"type": "string"
|
|
6915
|
+
},
|
|
6916
|
+
"additionalProperties": {},
|
|
6917
|
+
"description": "The options of `navigator.credentials.get()` or `create()`, in the JSON form of the WebAuthn spec."
|
|
6918
|
+
}
|
|
6919
|
+
},
|
|
6920
|
+
"required": [
|
|
6921
|
+
"options"
|
|
6922
|
+
],
|
|
6923
|
+
"additionalProperties": {},
|
|
6924
|
+
"description": "The options of a WebAuthn ceremony."
|
|
6925
|
+
},
|
|
6926
|
+
"Passkey": {
|
|
6927
|
+
"type": "object",
|
|
6928
|
+
"properties": {
|
|
6929
|
+
"id": {
|
|
6930
|
+
"$ref": "#/components/schemas/Id"
|
|
6931
|
+
},
|
|
6932
|
+
"name": {
|
|
6933
|
+
"type": "string"
|
|
6934
|
+
},
|
|
6935
|
+
"authenticator": {
|
|
6936
|
+
"description": "What keeps it, when the backend knows: \"iCloud Keychain\", \"1Password\"…",
|
|
6937
|
+
"type": [
|
|
6938
|
+
"string",
|
|
6939
|
+
"null"
|
|
6940
|
+
]
|
|
6941
|
+
},
|
|
6942
|
+
"createdAt": {
|
|
6943
|
+
"type": "string",
|
|
6944
|
+
"description": "ISO 8601."
|
|
6945
|
+
},
|
|
6946
|
+
"lastUsedAt": {
|
|
6947
|
+
"description": "ISO 8601, or null before its first login.",
|
|
6948
|
+
"type": [
|
|
6949
|
+
"string",
|
|
6950
|
+
"null"
|
|
6951
|
+
]
|
|
6952
|
+
}
|
|
6953
|
+
},
|
|
6954
|
+
"required": [
|
|
6955
|
+
"id",
|
|
6956
|
+
"name",
|
|
6957
|
+
"createdAt",
|
|
6958
|
+
"lastUsedAt"
|
|
6959
|
+
],
|
|
6960
|
+
"additionalProperties": {},
|
|
6961
|
+
"description": "A passkey of the current user."
|
|
6962
|
+
},
|
|
5441
6963
|
"SearchResponse": {
|
|
5442
6964
|
"type": "object",
|
|
5443
6965
|
"properties": {
|
|
@@ -5587,6 +7109,209 @@
|
|
|
5587
7109
|
],
|
|
5588
7110
|
"additionalProperties": {},
|
|
5589
7111
|
"description": "The value of a `location` field: a point, and its address."
|
|
7112
|
+
},
|
|
7113
|
+
"AddressValue": {
|
|
7114
|
+
"type": "object",
|
|
7115
|
+
"properties": {
|
|
7116
|
+
"street": {
|
|
7117
|
+
"description": "The number and the street.",
|
|
7118
|
+
"type": "string"
|
|
7119
|
+
},
|
|
7120
|
+
"unit": {
|
|
7121
|
+
"description": "An apartment, a suite or a floor.",
|
|
7122
|
+
"type": "string"
|
|
7123
|
+
},
|
|
7124
|
+
"city": {
|
|
7125
|
+
"type": "string"
|
|
7126
|
+
},
|
|
7127
|
+
"region": {
|
|
7128
|
+
"description": "A value of the `region` type for the country: the code of the region without its country (`QC`) for the countries Panneau knows the regions of, the text as typed for the others.",
|
|
7129
|
+
"type": "string"
|
|
7130
|
+
},
|
|
7131
|
+
"postalCode": {
|
|
7132
|
+
"description": "Normalized for its country: `H2X 1Y4`, `12345-6789`.",
|
|
7133
|
+
"type": "string"
|
|
7134
|
+
},
|
|
7135
|
+
"country": {
|
|
7136
|
+
"description": "An ISO 3166-1 alpha-2 code: `CA`.",
|
|
7137
|
+
"type": "string",
|
|
7138
|
+
"pattern": "^[A-Z]{2}$"
|
|
7139
|
+
},
|
|
7140
|
+
"point": {
|
|
7141
|
+
"description": "The place of the address on a map, with `settings.point`.",
|
|
7142
|
+
"type": "object",
|
|
7143
|
+
"properties": {
|
|
7144
|
+
"lat": {
|
|
7145
|
+
"type": "number",
|
|
7146
|
+
"minimum": -90,
|
|
7147
|
+
"maximum": 90
|
|
7148
|
+
},
|
|
7149
|
+
"lng": {
|
|
7150
|
+
"type": "number",
|
|
7151
|
+
"minimum": -180,
|
|
7152
|
+
"maximum": 180
|
|
7153
|
+
}
|
|
7154
|
+
},
|
|
7155
|
+
"required": [
|
|
7156
|
+
"lat",
|
|
7157
|
+
"lng"
|
|
7158
|
+
],
|
|
7159
|
+
"additionalProperties": {}
|
|
7160
|
+
}
|
|
7161
|
+
},
|
|
7162
|
+
"additionalProperties": {},
|
|
7163
|
+
"description": "The value of an `address` field (decision 0054): the parts of a postal address, the empty ones left out."
|
|
7164
|
+
},
|
|
7165
|
+
"LinkValue": {
|
|
7166
|
+
"type": "object",
|
|
7167
|
+
"properties": {
|
|
7168
|
+
"type": {
|
|
7169
|
+
"type": "string",
|
|
7170
|
+
"minLength": 1,
|
|
7171
|
+
"description": "The type of the link: `url`, `page`, `email`, `tel`, `file`, or a type of the site."
|
|
7172
|
+
},
|
|
7173
|
+
"url": {
|
|
7174
|
+
"description": "The `href` of the link: `https://…`, `mailto:…`, `tel:+…`, or the text of a type of the site. For `page` and `file` links, the URL the backend resolved, in items only.",
|
|
7175
|
+
"type": "string"
|
|
7176
|
+
},
|
|
7177
|
+
"page": {
|
|
7178
|
+
"description": "`page` links: the item, `{ \"id\", \"resource\", \"label\" }` in items, its id or `{ \"id\", \"resource\" }` in requests.",
|
|
7179
|
+
"anyOf": [
|
|
7180
|
+
{
|
|
7181
|
+
"type": "string"
|
|
7182
|
+
},
|
|
7183
|
+
{
|
|
7184
|
+
"type": "object",
|
|
7185
|
+
"properties": {
|
|
7186
|
+
"id": {
|
|
7187
|
+
"type": "string"
|
|
7188
|
+
},
|
|
7189
|
+
"resource": {
|
|
7190
|
+
"type": "string"
|
|
7191
|
+
},
|
|
7192
|
+
"label": {
|
|
7193
|
+
"type": "string"
|
|
7194
|
+
}
|
|
7195
|
+
},
|
|
7196
|
+
"required": [
|
|
7197
|
+
"id"
|
|
7198
|
+
],
|
|
7199
|
+
"additionalProperties": {}
|
|
7200
|
+
}
|
|
7201
|
+
]
|
|
7202
|
+
},
|
|
7203
|
+
"file": {
|
|
7204
|
+
"description": "`file` links: the media, as a `media` value.",
|
|
7205
|
+
"anyOf": [
|
|
7206
|
+
{
|
|
7207
|
+
"type": "string"
|
|
7208
|
+
},
|
|
7209
|
+
{
|
|
7210
|
+
"type": "object",
|
|
7211
|
+
"properties": {
|
|
7212
|
+
"id": {
|
|
7213
|
+
"type": "string"
|
|
7214
|
+
}
|
|
7215
|
+
},
|
|
7216
|
+
"required": [
|
|
7217
|
+
"id"
|
|
7218
|
+
],
|
|
7219
|
+
"additionalProperties": {}
|
|
7220
|
+
}
|
|
7221
|
+
]
|
|
7222
|
+
},
|
|
7223
|
+
"label": {
|
|
7224
|
+
"description": "The words of the link, per locale; a string in a `localized` link field.",
|
|
7225
|
+
"anyOf": [
|
|
7226
|
+
{
|
|
7227
|
+
"anyOf": [
|
|
7228
|
+
{
|
|
7229
|
+
"type": "string"
|
|
7230
|
+
},
|
|
7231
|
+
{
|
|
7232
|
+
"type": "object",
|
|
7233
|
+
"propertyNames": {
|
|
7234
|
+
"type": "string"
|
|
7235
|
+
},
|
|
7236
|
+
"additionalProperties": {
|
|
7237
|
+
"type": [
|
|
7238
|
+
"string",
|
|
7239
|
+
"null"
|
|
7240
|
+
]
|
|
7241
|
+
}
|
|
7242
|
+
}
|
|
7243
|
+
]
|
|
7244
|
+
},
|
|
7245
|
+
{
|
|
7246
|
+
"type": "null"
|
|
7247
|
+
}
|
|
7248
|
+
]
|
|
7249
|
+
},
|
|
7250
|
+
"newTab": {
|
|
7251
|
+
"description": "The link opens in a new tab.",
|
|
7252
|
+
"type": "boolean"
|
|
7253
|
+
}
|
|
7254
|
+
},
|
|
7255
|
+
"required": [
|
|
7256
|
+
"type"
|
|
7257
|
+
],
|
|
7258
|
+
"additionalProperties": {},
|
|
7259
|
+
"description": "The value of a `link` field (decision 0055)."
|
|
7260
|
+
},
|
|
7261
|
+
"DateRangeValue": {
|
|
7262
|
+
"type": "object",
|
|
7263
|
+
"properties": {
|
|
7264
|
+
"start": {
|
|
7265
|
+
"description": "The first day (`2026-11-04`) or the start (`2026-11-04T23:30:00Z`), or `null` when the range is open at its start.",
|
|
7266
|
+
"type": [
|
|
7267
|
+
"string",
|
|
7268
|
+
"null"
|
|
7269
|
+
]
|
|
7270
|
+
},
|
|
7271
|
+
"end": {
|
|
7272
|
+
"description": "The last day, included, or the end, or `null` when the range is open at its end. On or after the start.",
|
|
7273
|
+
"type": [
|
|
7274
|
+
"string",
|
|
7275
|
+
"null"
|
|
7276
|
+
]
|
|
7277
|
+
},
|
|
7278
|
+
"allDay": {
|
|
7279
|
+
"description": "The range takes whole days: its bounds are days.",
|
|
7280
|
+
"type": "boolean"
|
|
7281
|
+
},
|
|
7282
|
+
"timeZone": {
|
|
7283
|
+
"description": "The IANA time zone the date-times are shown and typed in (`America/Toronto`), when the field lets the user choose it.",
|
|
7284
|
+
"type": "string"
|
|
7285
|
+
}
|
|
7286
|
+
},
|
|
7287
|
+
"required": [
|
|
7288
|
+
"start",
|
|
7289
|
+
"end"
|
|
7290
|
+
],
|
|
7291
|
+
"additionalProperties": {},
|
|
7292
|
+
"description": "The value of a `daterange` field: a start and an end, days or date-times (decision 0053)."
|
|
7293
|
+
},
|
|
7294
|
+
"MoneyValue": {
|
|
7295
|
+
"type": "object",
|
|
7296
|
+
"properties": {
|
|
7297
|
+
"amount": {
|
|
7298
|
+
"type": "integer",
|
|
7299
|
+
"minimum": -9007199254740991,
|
|
7300
|
+
"maximum": 9007199254740991,
|
|
7301
|
+
"description": "The amount in the minor unit of the currency, its ISO 4217 exponent: `1250` is 12.50 CAD, `1250` is 1,250 JPY."
|
|
7302
|
+
},
|
|
7303
|
+
"currency": {
|
|
7304
|
+
"type": "string",
|
|
7305
|
+
"pattern": "^[A-Z]{3}$",
|
|
7306
|
+
"description": "An ISO 4217 currency code, in capitals: `CAD`."
|
|
7307
|
+
}
|
|
7308
|
+
},
|
|
7309
|
+
"required": [
|
|
7310
|
+
"amount",
|
|
7311
|
+
"currency"
|
|
7312
|
+
],
|
|
7313
|
+
"additionalProperties": {},
|
|
7314
|
+
"description": "The value of a `money` field: an amount and its currency (decision 0053)."
|
|
5590
7315
|
}
|
|
5591
7316
|
},
|
|
5592
7317
|
"parameters": {
|