@panneau/protocol 5.0.0-alpha.1 → 5.0.0-alpha.11
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/README.md +10 -9
- package/dist/conditions.d.ts +1 -1
- package/dist/conformance/index.d.ts.map +1 -1
- package/dist/conformance/index.js +288 -9
- package/dist/conformance/index.js.map +1 -1
- package/dist/constants.d.ts +25 -2
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +58 -3
- package/dist/constants.js.map +1 -1
- package/dist/index.d.ts +4 -4
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +12 -7
- package/dist/libraries.d.ts +16 -0
- package/dist/libraries.d.ts.map +1 -0
- package/dist/libraries.js +15 -0
- package/dist/libraries.js.map +1 -0
- package/dist/lint.d.ts +4 -3
- package/dist/lint.d.ts.map +1 -1
- package/dist/lint.js +34 -2
- package/dist/lint.js.map +1 -1
- package/dist/mock/example.d.ts +3 -2
- package/dist/mock/example.d.ts.map +1 -1
- package/dist/mock/example.js +223 -142
- package/dist/mock/example.js.map +1 -1
- package/dist/mock/index.d.ts +19 -5
- package/dist/mock/index.d.ts.map +1 -1
- package/dist/mock/index.js +378 -18
- package/dist/mock/index.js.map +1 -1
- package/dist/openapi.d.ts +2 -0
- package/dist/openapi.d.ts.map +1 -1
- package/dist/openapi.js +112 -108
- package/dist/openapi.js.map +1 -1
- package/dist/problem.d.ts +1 -1
- package/dist/query.d.ts +14 -0
- package/dist/query.d.ts.map +1 -1
- package/dist/query.js +11 -1
- package/dist/query.js.map +1 -1
- package/dist/rules.d.ts +6 -3
- package/dist/rules.d.ts.map +1 -1
- package/dist/rules.js +50 -8
- package/dist/rules.js.map +1 -1
- package/dist/runtime/index.d.ts +13 -9
- package/dist/runtime/index.d.ts.map +1 -1
- package/dist/runtime/index.js +7 -3
- package/dist/schemas/action.d.ts +69 -10
- package/dist/schemas/action.d.ts.map +1 -1
- package/dist/schemas/action.js +20 -3
- package/dist/schemas/action.js.map +1 -1
- package/dist/schemas/api.d.ts +224 -39
- package/dist/schemas/api.d.ts.map +1 -1
- package/dist/schemas/api.js +124 -30
- package/dist/schemas/api.js.map +1 -1
- package/dist/schemas/boot.d.ts +24 -1
- package/dist/schemas/boot.d.ts.map +1 -1
- package/dist/schemas/boot.js +2 -1
- package/dist/schemas/boot.js.map +1 -1
- package/dist/schemas/common.d.ts +1 -0
- package/dist/schemas/common.d.ts.map +1 -1
- package/dist/schemas/common.js +2 -1
- package/dist/schemas/common.js.map +1 -1
- package/dist/schemas/definition.d.ts +222 -20
- package/dist/schemas/definition.d.ts.map +1 -1
- package/dist/schemas/definition.js +16 -11
- package/dist/schemas/definition.js.map +1 -1
- package/dist/schemas/field.d.ts +162 -2
- package/dist/schemas/field.d.ts.map +1 -1
- package/dist/schemas/field.js +69 -16
- package/dist/schemas/field.js.map +1 -1
- package/dist/schemas/index.d.ts +955 -63
- package/dist/schemas/index.d.ts.map +1 -1
- package/dist/schemas/index.js +37 -8
- package/dist/schemas/index.js.map +1 -1
- package/dist/schemas/jsonRules.d.ts +83 -0
- package/dist/schemas/jsonRules.d.ts.map +1 -0
- package/dist/schemas/jsonRules.js +46 -0
- package/dist/schemas/jsonRules.js.map +1 -0
- package/dist/schemas/layout.d.ts +1 -1
- package/dist/schemas/list.d.ts +6 -0
- package/dist/schemas/list.d.ts.map +1 -1
- package/dist/schemas/list.js +1 -0
- package/dist/schemas/list.js.map +1 -1
- package/dist/schemas/resource.d.ts +144 -14
- package/dist/schemas/resource.d.ts.map +1 -1
- package/dist/schemas/resource.js +6 -1
- package/dist/schemas/resource.js.map +1 -1
- package/dist/schemas/theme.d.ts +179 -0
- package/dist/schemas/theme.d.ts.map +1 -0
- package/dist/schemas/theme.js +66 -0
- package/dist/schemas/theme.js.map +1 -0
- package/dist/search.d.ts +51 -0
- package/dist/search.d.ts.map +1 -0
- package/dist/search.js +53 -0
- package/dist/search.js.map +1 -0
- package/dist/themes.d.ts +11 -0
- package/dist/themes.d.ts.map +1 -0
- package/dist/themes.js +80 -0
- package/dist/themes.js.map +1 -0
- package/dist/transforms.d.ts +17 -0
- package/dist/transforms.d.ts.map +1 -0
- package/dist/transforms.js +34 -0
- package/dist/transforms.js.map +1 -0
- package/dist/validate.d.ts +4 -3
- package/dist/validate.d.ts.map +1 -1
- package/dist/validate.js +22 -2
- package/dist/validate.js.map +1 -1
- package/dist/values.d.ts +5 -1
- package/dist/values.d.ts.map +1 -1
- package/dist/values.js +16 -2
- package/dist/values.js.map +1 -1
- package/package.json +7 -3
- package/schema/boot.schema.json +580 -16
- package/schema/definition.schema.json +577 -16
- package/schema/openapi.json +1815 -541
- package/schema/theme.schema.json +234 -0
package/schema/openapi.json
CHANGED
|
@@ -79,6 +79,15 @@
|
|
|
79
79
|
"minimum": 1
|
|
80
80
|
}
|
|
81
81
|
},
|
|
82
|
+
{
|
|
83
|
+
"name": "cursor",
|
|
84
|
+
"in": "query",
|
|
85
|
+
"required": false,
|
|
86
|
+
"description": "Lists whose `pagination` is `cursor`: the `nextCursor` (or `previousCursor`) of a page, instead of `page`.",
|
|
87
|
+
"schema": {
|
|
88
|
+
"type": "string"
|
|
89
|
+
}
|
|
90
|
+
},
|
|
82
91
|
{
|
|
83
92
|
"name": "sort",
|
|
84
93
|
"in": "query",
|
|
@@ -159,6 +168,16 @@
|
|
|
159
168
|
}
|
|
160
169
|
}
|
|
161
170
|
}
|
|
171
|
+
},
|
|
172
|
+
"422": {
|
|
173
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
174
|
+
"content": {
|
|
175
|
+
"application/problem+json": {
|
|
176
|
+
"schema": {
|
|
177
|
+
"$ref": "#/components/schemas/Problem"
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
}
|
|
162
181
|
}
|
|
163
182
|
}
|
|
164
183
|
},
|
|
@@ -476,6 +495,92 @@
|
|
|
476
495
|
}
|
|
477
496
|
}
|
|
478
497
|
},
|
|
498
|
+
"/resources/{resource}/{id}/duplicate": {
|
|
499
|
+
"parameters": [
|
|
500
|
+
{
|
|
501
|
+
"name": "resource",
|
|
502
|
+
"in": "path",
|
|
503
|
+
"required": true,
|
|
504
|
+
"description": "Resource id.",
|
|
505
|
+
"schema": {
|
|
506
|
+
"type": "string"
|
|
507
|
+
}
|
|
508
|
+
},
|
|
509
|
+
{
|
|
510
|
+
"name": "id",
|
|
511
|
+
"in": "path",
|
|
512
|
+
"required": true,
|
|
513
|
+
"description": "Item id.",
|
|
514
|
+
"schema": {
|
|
515
|
+
"type": "string"
|
|
516
|
+
}
|
|
517
|
+
}
|
|
518
|
+
],
|
|
519
|
+
"post": {
|
|
520
|
+
"operationId": "duplicateItem",
|
|
521
|
+
"description": "Copies an item, for the built-in `duplicate` (decision 0040). Allowed on the items whose `abilities.duplicate` is `true`.",
|
|
522
|
+
"responses": {
|
|
523
|
+
"201": {
|
|
524
|
+
"description": "The copy, a new item.",
|
|
525
|
+
"content": {
|
|
526
|
+
"application/json": {
|
|
527
|
+
"schema": {
|
|
528
|
+
"$ref": "#/components/schemas/ItemResponse"
|
|
529
|
+
}
|
|
530
|
+
}
|
|
531
|
+
},
|
|
532
|
+
"headers": {
|
|
533
|
+
"ETag": {
|
|
534
|
+
"description": "The version of the item.",
|
|
535
|
+
"schema": {
|
|
536
|
+
"type": "string"
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
}
|
|
540
|
+
},
|
|
541
|
+
"401": {
|
|
542
|
+
"description": "Not authenticated.",
|
|
543
|
+
"content": {
|
|
544
|
+
"application/problem+json": {
|
|
545
|
+
"schema": {
|
|
546
|
+
"$ref": "#/components/schemas/Problem"
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"403": {
|
|
552
|
+
"description": "Not allowed.",
|
|
553
|
+
"content": {
|
|
554
|
+
"application/problem+json": {
|
|
555
|
+
"schema": {
|
|
556
|
+
"$ref": "#/components/schemas/Problem"
|
|
557
|
+
}
|
|
558
|
+
}
|
|
559
|
+
}
|
|
560
|
+
},
|
|
561
|
+
"404": {
|
|
562
|
+
"description": "Not found.",
|
|
563
|
+
"content": {
|
|
564
|
+
"application/problem+json": {
|
|
565
|
+
"schema": {
|
|
566
|
+
"$ref": "#/components/schemas/Problem"
|
|
567
|
+
}
|
|
568
|
+
}
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
"409": {
|
|
572
|
+
"description": "The copy conflicts with another item, such as a unique value.",
|
|
573
|
+
"content": {
|
|
574
|
+
"application/problem+json": {
|
|
575
|
+
"schema": {
|
|
576
|
+
"$ref": "#/components/schemas/Problem"
|
|
577
|
+
}
|
|
578
|
+
}
|
|
579
|
+
}
|
|
580
|
+
}
|
|
581
|
+
}
|
|
582
|
+
}
|
|
583
|
+
},
|
|
479
584
|
"/resources/{resource}/{id}/preview": {
|
|
480
585
|
"parameters": [
|
|
481
586
|
{
|
|
@@ -623,6 +728,16 @@
|
|
|
623
728
|
}
|
|
624
729
|
}
|
|
625
730
|
},
|
|
731
|
+
"400": {
|
|
732
|
+
"description": "Bad request, such as a dry run of an action that does not declare `dryRun`.",
|
|
733
|
+
"content": {
|
|
734
|
+
"application/problem+json": {
|
|
735
|
+
"schema": {
|
|
736
|
+
"$ref": "#/components/schemas/Problem"
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
}
|
|
740
|
+
},
|
|
626
741
|
"401": {
|
|
627
742
|
"description": "Not authenticated.",
|
|
628
743
|
"content": {
|
|
@@ -676,6 +791,94 @@
|
|
|
676
791
|
}
|
|
677
792
|
}
|
|
678
793
|
},
|
|
794
|
+
"/resources/{resource}/fields/{field}/check": {
|
|
795
|
+
"parameters": [
|
|
796
|
+
{
|
|
797
|
+
"name": "resource",
|
|
798
|
+
"in": "path",
|
|
799
|
+
"required": true,
|
|
800
|
+
"description": "Resource id.",
|
|
801
|
+
"schema": {
|
|
802
|
+
"type": "string"
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"name": "field",
|
|
807
|
+
"in": "path",
|
|
808
|
+
"required": true,
|
|
809
|
+
"description": "Name of a field with `check`.",
|
|
810
|
+
"schema": {
|
|
811
|
+
"type": "string"
|
|
812
|
+
}
|
|
813
|
+
}
|
|
814
|
+
],
|
|
815
|
+
"post": {
|
|
816
|
+
"operationId": "checkField",
|
|
817
|
+
"summary": "Checks a value as it is typed: whether a slug is available, and its URL. With the permission to create, or to update the item `id`.",
|
|
818
|
+
"requestBody": {
|
|
819
|
+
"required": true,
|
|
820
|
+
"content": {
|
|
821
|
+
"application/json": {
|
|
822
|
+
"schema": {
|
|
823
|
+
"$ref": "#/components/schemas/FieldCheckRequest"
|
|
824
|
+
}
|
|
825
|
+
}
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
"responses": {
|
|
829
|
+
"200": {
|
|
830
|
+
"description": "What the backend says about the value.",
|
|
831
|
+
"content": {
|
|
832
|
+
"application/json": {
|
|
833
|
+
"schema": {
|
|
834
|
+
"$ref": "#/components/schemas/FieldCheckResponse"
|
|
835
|
+
}
|
|
836
|
+
}
|
|
837
|
+
}
|
|
838
|
+
},
|
|
839
|
+
"401": {
|
|
840
|
+
"description": "Not authenticated.",
|
|
841
|
+
"content": {
|
|
842
|
+
"application/problem+json": {
|
|
843
|
+
"schema": {
|
|
844
|
+
"$ref": "#/components/schemas/Problem"
|
|
845
|
+
}
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"403": {
|
|
850
|
+
"description": "Not allowed.",
|
|
851
|
+
"content": {
|
|
852
|
+
"application/problem+json": {
|
|
853
|
+
"schema": {
|
|
854
|
+
"$ref": "#/components/schemas/Problem"
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
"404": {
|
|
860
|
+
"description": "Not found.",
|
|
861
|
+
"content": {
|
|
862
|
+
"application/problem+json": {
|
|
863
|
+
"schema": {
|
|
864
|
+
"$ref": "#/components/schemas/Problem"
|
|
865
|
+
}
|
|
866
|
+
}
|
|
867
|
+
}
|
|
868
|
+
},
|
|
869
|
+
"422": {
|
|
870
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
871
|
+
"content": {
|
|
872
|
+
"application/problem+json": {
|
|
873
|
+
"schema": {
|
|
874
|
+
"$ref": "#/components/schemas/Problem"
|
|
875
|
+
}
|
|
876
|
+
}
|
|
877
|
+
}
|
|
878
|
+
}
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
},
|
|
679
882
|
"/actions/runs": {
|
|
680
883
|
"get": {
|
|
681
884
|
"operationId": "listActionRuns",
|
|
@@ -821,303 +1024,27 @@
|
|
|
821
1024
|
}
|
|
822
1025
|
}
|
|
823
1026
|
},
|
|
824
|
-
"/
|
|
825
|
-
"
|
|
826
|
-
"operationId": "
|
|
827
|
-
"
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
"
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
"minimum": 1
|
|
836
|
-
}
|
|
837
|
-
},
|
|
838
|
-
{
|
|
839
|
-
"name": "perPage",
|
|
840
|
-
"in": "query",
|
|
841
|
-
"required": false,
|
|
842
|
-
"description": "Items per page.",
|
|
843
|
-
"schema": {
|
|
844
|
-
"type": "integer",
|
|
845
|
-
"minimum": 1
|
|
846
|
-
}
|
|
847
|
-
},
|
|
848
|
-
{
|
|
849
|
-
"name": "sort",
|
|
850
|
-
"in": "query",
|
|
851
|
-
"required": false,
|
|
852
|
-
"description": "Comma-separated fields; a `-` prefix sorts descending.",
|
|
853
|
-
"schema": {
|
|
854
|
-
"type": "string"
|
|
855
|
-
}
|
|
856
|
-
},
|
|
857
|
-
{
|
|
858
|
-
"name": "filter",
|
|
859
|
-
"in": "query",
|
|
860
|
-
"required": false,
|
|
861
|
-
"style": "deepObject",
|
|
862
|
-
"explode": true,
|
|
863
|
-
"description": "`filter[status]=published`; `filter[tags][]=a&filter[tags][]=b` for any of several values; `filter[published_at][from]=2026-01-01&filter[published_at][to]=2026-01-31` for the inclusive bounds of a range filter (`date-range`), without the open end.",
|
|
864
|
-
"schema": {
|
|
865
|
-
"type": "object",
|
|
866
|
-
"additionalProperties": true
|
|
867
|
-
}
|
|
868
|
-
},
|
|
869
|
-
{
|
|
870
|
-
"name": "q",
|
|
871
|
-
"in": "query",
|
|
872
|
-
"required": false,
|
|
873
|
-
"description": "Search.",
|
|
874
|
-
"schema": {
|
|
875
|
-
"type": "string"
|
|
876
|
-
}
|
|
877
|
-
},
|
|
878
|
-
{
|
|
879
|
-
"name": "fields",
|
|
880
|
-
"in": "query",
|
|
881
|
-
"required": false,
|
|
882
|
-
"description": "Comma-separated fields to include in each item.",
|
|
883
|
-
"schema": {
|
|
884
|
-
"type": "string"
|
|
1027
|
+
"/uploads/sign": {
|
|
1028
|
+
"post": {
|
|
1029
|
+
"operationId": "signUpload",
|
|
1030
|
+
"summary": "Signs a request of the browser's S3 client. The first request of a file creates its upload.",
|
|
1031
|
+
"requestBody": {
|
|
1032
|
+
"required": true,
|
|
1033
|
+
"content": {
|
|
1034
|
+
"application/json": {
|
|
1035
|
+
"schema": {
|
|
1036
|
+
"$ref": "#/components/schemas/UploadSignRequest"
|
|
1037
|
+
}
|
|
885
1038
|
}
|
|
886
1039
|
}
|
|
887
|
-
|
|
1040
|
+
},
|
|
888
1041
|
"responses": {
|
|
889
1042
|
"200": {
|
|
890
|
-
"description": "
|
|
1043
|
+
"description": "The presigned request.",
|
|
891
1044
|
"content": {
|
|
892
1045
|
"application/json": {
|
|
893
1046
|
"schema": {
|
|
894
|
-
"$ref": "#/components/schemas/
|
|
895
|
-
}
|
|
896
|
-
}
|
|
897
|
-
}
|
|
898
|
-
},
|
|
899
|
-
"401": {
|
|
900
|
-
"description": "Not authenticated.",
|
|
901
|
-
"content": {
|
|
902
|
-
"application/problem+json": {
|
|
903
|
-
"schema": {
|
|
904
|
-
"$ref": "#/components/schemas/Problem"
|
|
905
|
-
}
|
|
906
|
-
}
|
|
907
|
-
}
|
|
908
|
-
},
|
|
909
|
-
"403": {
|
|
910
|
-
"description": "Not allowed.",
|
|
911
|
-
"content": {
|
|
912
|
-
"application/problem+json": {
|
|
913
|
-
"schema": {
|
|
914
|
-
"$ref": "#/components/schemas/Problem"
|
|
915
|
-
}
|
|
916
|
-
}
|
|
917
|
-
}
|
|
918
|
-
}
|
|
919
|
-
}
|
|
920
|
-
},
|
|
921
|
-
"post": {
|
|
922
|
-
"operationId": "uploadMedia",
|
|
923
|
-
"requestBody": {
|
|
924
|
-
"required": true,
|
|
925
|
-
"content": {
|
|
926
|
-
"multipart/form-data": {
|
|
927
|
-
"schema": {
|
|
928
|
-
"type": "object",
|
|
929
|
-
"required": [
|
|
930
|
-
"file"
|
|
931
|
-
],
|
|
932
|
-
"properties": {
|
|
933
|
-
"file": {
|
|
934
|
-
"type": "string",
|
|
935
|
-
"contentMediaType": "application/octet-stream"
|
|
936
|
-
},
|
|
937
|
-
"name": {
|
|
938
|
-
"type": "string"
|
|
939
|
-
},
|
|
940
|
-
"tags": {
|
|
941
|
-
"type": "array",
|
|
942
|
-
"items": {
|
|
943
|
-
"type": "string"
|
|
944
|
-
}
|
|
945
|
-
}
|
|
946
|
-
}
|
|
947
|
-
}
|
|
948
|
-
}
|
|
949
|
-
}
|
|
950
|
-
},
|
|
951
|
-
"responses": {
|
|
952
|
-
"201": {
|
|
953
|
-
"description": "The created media.",
|
|
954
|
-
"content": {
|
|
955
|
-
"application/json": {
|
|
956
|
-
"schema": {
|
|
957
|
-
"$ref": "#/components/schemas/MediaResponse"
|
|
958
|
-
}
|
|
959
|
-
}
|
|
960
|
-
}
|
|
961
|
-
},
|
|
962
|
-
"401": {
|
|
963
|
-
"description": "Not authenticated.",
|
|
964
|
-
"content": {
|
|
965
|
-
"application/problem+json": {
|
|
966
|
-
"schema": {
|
|
967
|
-
"$ref": "#/components/schemas/Problem"
|
|
968
|
-
}
|
|
969
|
-
}
|
|
970
|
-
}
|
|
971
|
-
},
|
|
972
|
-
"403": {
|
|
973
|
-
"description": "Not allowed.",
|
|
974
|
-
"content": {
|
|
975
|
-
"application/problem+json": {
|
|
976
|
-
"schema": {
|
|
977
|
-
"$ref": "#/components/schemas/Problem"
|
|
978
|
-
}
|
|
979
|
-
}
|
|
980
|
-
}
|
|
981
|
-
},
|
|
982
|
-
"422": {
|
|
983
|
-
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
984
|
-
"content": {
|
|
985
|
-
"application/problem+json": {
|
|
986
|
-
"schema": {
|
|
987
|
-
"$ref": "#/components/schemas/Problem"
|
|
988
|
-
}
|
|
989
|
-
}
|
|
990
|
-
}
|
|
991
|
-
}
|
|
992
|
-
}
|
|
993
|
-
}
|
|
994
|
-
},
|
|
995
|
-
"/media/tags": {
|
|
996
|
-
"get": {
|
|
997
|
-
"operationId": "listMediaTags",
|
|
998
|
-
"responses": {
|
|
999
|
-
"200": {
|
|
1000
|
-
"description": "Tags in use.",
|
|
1001
|
-
"content": {
|
|
1002
|
-
"application/json": {
|
|
1003
|
-
"schema": {
|
|
1004
|
-
"type": "object",
|
|
1005
|
-
"required": [
|
|
1006
|
-
"data"
|
|
1007
|
-
],
|
|
1008
|
-
"properties": {
|
|
1009
|
-
"data": {
|
|
1010
|
-
"type": "array",
|
|
1011
|
-
"items": {
|
|
1012
|
-
"type": "string"
|
|
1013
|
-
}
|
|
1014
|
-
}
|
|
1015
|
-
}
|
|
1016
|
-
}
|
|
1017
|
-
}
|
|
1018
|
-
}
|
|
1019
|
-
},
|
|
1020
|
-
"401": {
|
|
1021
|
-
"description": "Not authenticated.",
|
|
1022
|
-
"content": {
|
|
1023
|
-
"application/problem+json": {
|
|
1024
|
-
"schema": {
|
|
1025
|
-
"$ref": "#/components/schemas/Problem"
|
|
1026
|
-
}
|
|
1027
|
-
}
|
|
1028
|
-
}
|
|
1029
|
-
},
|
|
1030
|
-
"403": {
|
|
1031
|
-
"description": "Not allowed.",
|
|
1032
|
-
"content": {
|
|
1033
|
-
"application/problem+json": {
|
|
1034
|
-
"schema": {
|
|
1035
|
-
"$ref": "#/components/schemas/Problem"
|
|
1036
|
-
}
|
|
1037
|
-
}
|
|
1038
|
-
}
|
|
1039
|
-
}
|
|
1040
|
-
}
|
|
1041
|
-
}
|
|
1042
|
-
},
|
|
1043
|
-
"/media/{id}": {
|
|
1044
|
-
"parameters": [
|
|
1045
|
-
{
|
|
1046
|
-
"name": "id",
|
|
1047
|
-
"in": "path",
|
|
1048
|
-
"required": true,
|
|
1049
|
-
"description": "Media id.",
|
|
1050
|
-
"schema": {
|
|
1051
|
-
"type": "string"
|
|
1052
|
-
}
|
|
1053
|
-
}
|
|
1054
|
-
],
|
|
1055
|
-
"get": {
|
|
1056
|
-
"operationId": "getMedia",
|
|
1057
|
-
"responses": {
|
|
1058
|
-
"200": {
|
|
1059
|
-
"description": "The media.",
|
|
1060
|
-
"content": {
|
|
1061
|
-
"application/json": {
|
|
1062
|
-
"schema": {
|
|
1063
|
-
"$ref": "#/components/schemas/MediaResponse"
|
|
1064
|
-
}
|
|
1065
|
-
}
|
|
1066
|
-
}
|
|
1067
|
-
},
|
|
1068
|
-
"401": {
|
|
1069
|
-
"description": "Not authenticated.",
|
|
1070
|
-
"content": {
|
|
1071
|
-
"application/problem+json": {
|
|
1072
|
-
"schema": {
|
|
1073
|
-
"$ref": "#/components/schemas/Problem"
|
|
1074
|
-
}
|
|
1075
|
-
}
|
|
1076
|
-
}
|
|
1077
|
-
},
|
|
1078
|
-
"403": {
|
|
1079
|
-
"description": "Not allowed.",
|
|
1080
|
-
"content": {
|
|
1081
|
-
"application/problem+json": {
|
|
1082
|
-
"schema": {
|
|
1083
|
-
"$ref": "#/components/schemas/Problem"
|
|
1084
|
-
}
|
|
1085
|
-
}
|
|
1086
|
-
}
|
|
1087
|
-
},
|
|
1088
|
-
"404": {
|
|
1089
|
-
"description": "Not found.",
|
|
1090
|
-
"content": {
|
|
1091
|
-
"application/problem+json": {
|
|
1092
|
-
"schema": {
|
|
1093
|
-
"$ref": "#/components/schemas/Problem"
|
|
1094
|
-
}
|
|
1095
|
-
}
|
|
1096
|
-
}
|
|
1097
|
-
}
|
|
1098
|
-
}
|
|
1099
|
-
},
|
|
1100
|
-
"patch": {
|
|
1101
|
-
"operationId": "updateMedia",
|
|
1102
|
-
"description": "Updates metadata, tags or the image `transform`.",
|
|
1103
|
-
"requestBody": {
|
|
1104
|
-
"required": true,
|
|
1105
|
-
"content": {
|
|
1106
|
-
"application/json": {
|
|
1107
|
-
"schema": {
|
|
1108
|
-
"type": "object",
|
|
1109
|
-
"additionalProperties": true
|
|
1110
|
-
}
|
|
1111
|
-
}
|
|
1112
|
-
}
|
|
1113
|
-
},
|
|
1114
|
-
"responses": {
|
|
1115
|
-
"200": {
|
|
1116
|
-
"description": "The updated media.",
|
|
1117
|
-
"content": {
|
|
1118
|
-
"application/json": {
|
|
1119
|
-
"schema": {
|
|
1120
|
-
"$ref": "#/components/schemas/MediaResponse"
|
|
1047
|
+
"$ref": "#/components/schemas/UploadSignResponse"
|
|
1121
1048
|
}
|
|
1122
1049
|
}
|
|
1123
1050
|
}
|
|
@@ -1163,83 +1090,33 @@
|
|
|
1163
1090
|
}
|
|
1164
1091
|
}
|
|
1165
1092
|
}
|
|
1166
|
-
},
|
|
1167
|
-
"delete": {
|
|
1168
|
-
"operationId": "deleteMedia",
|
|
1169
|
-
"responses": {
|
|
1170
|
-
"204": {
|
|
1171
|
-
"description": "Moved to the trash."
|
|
1172
|
-
},
|
|
1173
|
-
"401": {
|
|
1174
|
-
"description": "Not authenticated.",
|
|
1175
|
-
"content": {
|
|
1176
|
-
"application/problem+json": {
|
|
1177
|
-
"schema": {
|
|
1178
|
-
"$ref": "#/components/schemas/Problem"
|
|
1179
|
-
}
|
|
1180
|
-
}
|
|
1181
|
-
}
|
|
1182
|
-
},
|
|
1183
|
-
"403": {
|
|
1184
|
-
"description": "Not allowed.",
|
|
1185
|
-
"content": {
|
|
1186
|
-
"application/problem+json": {
|
|
1187
|
-
"schema": {
|
|
1188
|
-
"$ref": "#/components/schemas/Problem"
|
|
1189
|
-
}
|
|
1190
|
-
}
|
|
1191
|
-
}
|
|
1192
|
-
},
|
|
1193
|
-
"404": {
|
|
1194
|
-
"description": "Not found.",
|
|
1195
|
-
"content": {
|
|
1196
|
-
"application/problem+json": {
|
|
1197
|
-
"schema": {
|
|
1198
|
-
"$ref": "#/components/schemas/Problem"
|
|
1199
|
-
}
|
|
1200
|
-
}
|
|
1201
|
-
}
|
|
1202
|
-
},
|
|
1203
|
-
"409": {
|
|
1204
|
-
"description": "Conflict with a business rule.",
|
|
1205
|
-
"content": {
|
|
1206
|
-
"application/problem+json": {
|
|
1207
|
-
"schema": {
|
|
1208
|
-
"$ref": "#/components/schemas/Problem"
|
|
1209
|
-
}
|
|
1210
|
-
}
|
|
1211
|
-
}
|
|
1212
|
-
}
|
|
1213
|
-
}
|
|
1214
1093
|
}
|
|
1215
1094
|
},
|
|
1216
|
-
"/
|
|
1095
|
+
"/uploads/{upload}/complete": {
|
|
1217
1096
|
"parameters": [
|
|
1218
1097
|
{
|
|
1219
|
-
"name": "
|
|
1098
|
+
"name": "upload",
|
|
1220
1099
|
"in": "path",
|
|
1221
1100
|
"required": true,
|
|
1222
|
-
"description": "
|
|
1101
|
+
"description": "Upload id: `upl_…`.",
|
|
1223
1102
|
"schema": {
|
|
1224
1103
|
"type": "string"
|
|
1225
1104
|
}
|
|
1226
1105
|
}
|
|
1227
1106
|
],
|
|
1228
1107
|
"post": {
|
|
1229
|
-
"operationId": "
|
|
1108
|
+
"operationId": "completeUpload",
|
|
1109
|
+
"summary": "Once the browser completed the upload in storage, checks the object and gives the upload, which values reference.",
|
|
1230
1110
|
"requestBody": {
|
|
1231
|
-
"required":
|
|
1111
|
+
"required": false,
|
|
1232
1112
|
"content": {
|
|
1233
|
-
"
|
|
1113
|
+
"application/json": {
|
|
1234
1114
|
"schema": {
|
|
1235
1115
|
"type": "object",
|
|
1236
|
-
"required": [
|
|
1237
|
-
"file"
|
|
1238
|
-
],
|
|
1239
1116
|
"properties": {
|
|
1240
|
-
"
|
|
1117
|
+
"name": {
|
|
1241
1118
|
"type": "string",
|
|
1242
|
-
"
|
|
1119
|
+
"description": "The file's name, which the key doesn't keep, since the backend chose it."
|
|
1243
1120
|
}
|
|
1244
1121
|
}
|
|
1245
1122
|
}
|
|
@@ -1248,11 +1125,11 @@
|
|
|
1248
1125
|
},
|
|
1249
1126
|
"responses": {
|
|
1250
1127
|
"200": {
|
|
1251
|
-
"description": "The
|
|
1128
|
+
"description": "The upload.",
|
|
1252
1129
|
"content": {
|
|
1253
1130
|
"application/json": {
|
|
1254
1131
|
"schema": {
|
|
1255
|
-
"$ref": "#/components/schemas/
|
|
1132
|
+
"$ref": "#/components/schemas/UploadResponse"
|
|
1256
1133
|
}
|
|
1257
1134
|
}
|
|
1258
1135
|
}
|
|
@@ -1300,64 +1177,6 @@
|
|
|
1300
1177
|
}
|
|
1301
1178
|
}
|
|
1302
1179
|
},
|
|
1303
|
-
"/media/{id}/restore": {
|
|
1304
|
-
"parameters": [
|
|
1305
|
-
{
|
|
1306
|
-
"name": "id",
|
|
1307
|
-
"in": "path",
|
|
1308
|
-
"required": true,
|
|
1309
|
-
"description": "Media id.",
|
|
1310
|
-
"schema": {
|
|
1311
|
-
"type": "string"
|
|
1312
|
-
}
|
|
1313
|
-
}
|
|
1314
|
-
],
|
|
1315
|
-
"post": {
|
|
1316
|
-
"operationId": "restoreMedia",
|
|
1317
|
-
"responses": {
|
|
1318
|
-
"200": {
|
|
1319
|
-
"description": "The restored media.",
|
|
1320
|
-
"content": {
|
|
1321
|
-
"application/json": {
|
|
1322
|
-
"schema": {
|
|
1323
|
-
"$ref": "#/components/schemas/MediaResponse"
|
|
1324
|
-
}
|
|
1325
|
-
}
|
|
1326
|
-
}
|
|
1327
|
-
},
|
|
1328
|
-
"401": {
|
|
1329
|
-
"description": "Not authenticated.",
|
|
1330
|
-
"content": {
|
|
1331
|
-
"application/problem+json": {
|
|
1332
|
-
"schema": {
|
|
1333
|
-
"$ref": "#/components/schemas/Problem"
|
|
1334
|
-
}
|
|
1335
|
-
}
|
|
1336
|
-
}
|
|
1337
|
-
},
|
|
1338
|
-
"403": {
|
|
1339
|
-
"description": "Not allowed.",
|
|
1340
|
-
"content": {
|
|
1341
|
-
"application/problem+json": {
|
|
1342
|
-
"schema": {
|
|
1343
|
-
"$ref": "#/components/schemas/Problem"
|
|
1344
|
-
}
|
|
1345
|
-
}
|
|
1346
|
-
}
|
|
1347
|
-
},
|
|
1348
|
-
"404": {
|
|
1349
|
-
"description": "Not found.",
|
|
1350
|
-
"content": {
|
|
1351
|
-
"application/problem+json": {
|
|
1352
|
-
"schema": {
|
|
1353
|
-
"$ref": "#/components/schemas/Problem"
|
|
1354
|
-
}
|
|
1355
|
-
}
|
|
1356
|
-
}
|
|
1357
|
-
}
|
|
1358
|
-
}
|
|
1359
|
-
}
|
|
1360
|
-
},
|
|
1361
1180
|
"/auth/session": {
|
|
1362
1181
|
"get": {
|
|
1363
1182
|
"operationId": "getSession",
|
|
@@ -1393,22 +1212,41 @@
|
|
|
1393
1212
|
"content": {
|
|
1394
1213
|
"application/json": {
|
|
1395
1214
|
"schema": {
|
|
1396
|
-
"
|
|
1397
|
-
"
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
|
|
1406
|
-
|
|
1215
|
+
"description": "An email and a password, or the single secret of `auth.token`.",
|
|
1216
|
+
"oneOf": [
|
|
1217
|
+
{
|
|
1218
|
+
"type": "object",
|
|
1219
|
+
"required": [
|
|
1220
|
+
"email",
|
|
1221
|
+
"password"
|
|
1222
|
+
],
|
|
1223
|
+
"properties": {
|
|
1224
|
+
"email": {
|
|
1225
|
+
"type": "string"
|
|
1226
|
+
},
|
|
1227
|
+
"password": {
|
|
1228
|
+
"type": "string"
|
|
1229
|
+
},
|
|
1230
|
+
"remember": {
|
|
1231
|
+
"type": "boolean"
|
|
1232
|
+
}
|
|
1233
|
+
}
|
|
1407
1234
|
},
|
|
1408
|
-
|
|
1409
|
-
"type": "
|
|
1235
|
+
{
|
|
1236
|
+
"type": "object",
|
|
1237
|
+
"required": [
|
|
1238
|
+
"token"
|
|
1239
|
+
],
|
|
1240
|
+
"properties": {
|
|
1241
|
+
"token": {
|
|
1242
|
+
"type": "string"
|
|
1243
|
+
},
|
|
1244
|
+
"remember": {
|
|
1245
|
+
"type": "boolean"
|
|
1246
|
+
}
|
|
1247
|
+
}
|
|
1410
1248
|
}
|
|
1411
|
-
|
|
1249
|
+
]
|
|
1412
1250
|
}
|
|
1413
1251
|
}
|
|
1414
1252
|
}
|
|
@@ -1456,6 +1294,7 @@
|
|
|
1456
1294
|
"/auth/logout": {
|
|
1457
1295
|
"post": {
|
|
1458
1296
|
"operationId": "logout",
|
|
1297
|
+
"description": "`panneau` auth mode. In `external` mode, the browser goes to `auth.logoutUrl` instead.",
|
|
1459
1298
|
"responses": {
|
|
1460
1299
|
"204": {
|
|
1461
1300
|
"description": "Logged out."
|
|
@@ -1787,7 +1626,30 @@
|
|
|
1787
1626
|
"name": "q",
|
|
1788
1627
|
"in": "query",
|
|
1789
1628
|
"required": true,
|
|
1790
|
-
"description": "Search terms.",
|
|
1629
|
+
"description": "Search terms, trimmed.",
|
|
1630
|
+
"schema": {
|
|
1631
|
+
"type": "string",
|
|
1632
|
+
"minLength": 2,
|
|
1633
|
+
"maxLength": 255
|
|
1634
|
+
}
|
|
1635
|
+
},
|
|
1636
|
+
{
|
|
1637
|
+
"name": "limit",
|
|
1638
|
+
"in": "query",
|
|
1639
|
+
"required": false,
|
|
1640
|
+
"description": "Items per resource.",
|
|
1641
|
+
"schema": {
|
|
1642
|
+
"type": "integer",
|
|
1643
|
+
"minimum": 1,
|
|
1644
|
+
"maximum": 20,
|
|
1645
|
+
"default": 5
|
|
1646
|
+
}
|
|
1647
|
+
},
|
|
1648
|
+
{
|
|
1649
|
+
"name": "resources",
|
|
1650
|
+
"in": "query",
|
|
1651
|
+
"required": false,
|
|
1652
|
+
"description": "Comma-separated ids of the searchable resources to search. Defaults to every one.",
|
|
1791
1653
|
"schema": {
|
|
1792
1654
|
"type": "string"
|
|
1793
1655
|
}
|
|
@@ -1795,7 +1657,7 @@
|
|
|
1795
1657
|
],
|
|
1796
1658
|
"responses": {
|
|
1797
1659
|
"200": {
|
|
1798
|
-
"description": "Results grouped by resource.",
|
|
1660
|
+
"description": "Results grouped by resource, in the order of the definition: at most `limit` items per resource, and 20 in all.",
|
|
1799
1661
|
"content": {
|
|
1800
1662
|
"application/json": {
|
|
1801
1663
|
"schema": {
|
|
@@ -1813,6 +1675,84 @@
|
|
|
1813
1675
|
}
|
|
1814
1676
|
}
|
|
1815
1677
|
}
|
|
1678
|
+
},
|
|
1679
|
+
"422": {
|
|
1680
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
1681
|
+
"content": {
|
|
1682
|
+
"application/problem+json": {
|
|
1683
|
+
"schema": {
|
|
1684
|
+
"$ref": "#/components/schemas/Problem"
|
|
1685
|
+
}
|
|
1686
|
+
}
|
|
1687
|
+
}
|
|
1688
|
+
},
|
|
1689
|
+
"429": {
|
|
1690
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1691
|
+
"content": {
|
|
1692
|
+
"application/problem+json": {
|
|
1693
|
+
"schema": {
|
|
1694
|
+
"$ref": "#/components/schemas/Problem"
|
|
1695
|
+
}
|
|
1696
|
+
}
|
|
1697
|
+
}
|
|
1698
|
+
}
|
|
1699
|
+
}
|
|
1700
|
+
}
|
|
1701
|
+
},
|
|
1702
|
+
"/embeds": {
|
|
1703
|
+
"get": {
|
|
1704
|
+
"operationId": "resolveEmbed",
|
|
1705
|
+
"parameters": [
|
|
1706
|
+
{
|
|
1707
|
+
"name": "url",
|
|
1708
|
+
"in": "query",
|
|
1709
|
+
"required": true,
|
|
1710
|
+
"description": "The URL to embed.",
|
|
1711
|
+
"schema": {
|
|
1712
|
+
"type": "string"
|
|
1713
|
+
}
|
|
1714
|
+
}
|
|
1715
|
+
],
|
|
1716
|
+
"responses": {
|
|
1717
|
+
"200": {
|
|
1718
|
+
"description": "The value of an `embed` field for the URL, from its provider's oEmbed.",
|
|
1719
|
+
"content": {
|
|
1720
|
+
"application/json": {
|
|
1721
|
+
"schema": {
|
|
1722
|
+
"$ref": "#/components/schemas/EmbedResponse"
|
|
1723
|
+
}
|
|
1724
|
+
}
|
|
1725
|
+
}
|
|
1726
|
+
},
|
|
1727
|
+
"401": {
|
|
1728
|
+
"description": "Not authenticated.",
|
|
1729
|
+
"content": {
|
|
1730
|
+
"application/problem+json": {
|
|
1731
|
+
"schema": {
|
|
1732
|
+
"$ref": "#/components/schemas/Problem"
|
|
1733
|
+
}
|
|
1734
|
+
}
|
|
1735
|
+
}
|
|
1736
|
+
},
|
|
1737
|
+
"422": {
|
|
1738
|
+
"description": "Invalid values: messages are in `errors`, keyed by dot path.",
|
|
1739
|
+
"content": {
|
|
1740
|
+
"application/problem+json": {
|
|
1741
|
+
"schema": {
|
|
1742
|
+
"$ref": "#/components/schemas/Problem"
|
|
1743
|
+
}
|
|
1744
|
+
}
|
|
1745
|
+
}
|
|
1746
|
+
},
|
|
1747
|
+
"429": {
|
|
1748
|
+
"description": "Too many requests: `Retry-After` gives the seconds to wait.",
|
|
1749
|
+
"content": {
|
|
1750
|
+
"application/problem+json": {
|
|
1751
|
+
"schema": {
|
|
1752
|
+
"$ref": "#/components/schemas/Problem"
|
|
1753
|
+
}
|
|
1754
|
+
}
|
|
1755
|
+
}
|
|
1816
1756
|
}
|
|
1817
1757
|
}
|
|
1818
1758
|
}
|
|
@@ -1974,6 +1914,11 @@
|
|
|
1974
1914
|
},
|
|
1975
1915
|
"disabled": {
|
|
1976
1916
|
"type": "boolean"
|
|
1917
|
+
},
|
|
1918
|
+
"tone": {
|
|
1919
|
+
"description": "The tone of the option where it shows as a badge, in lists and details: `neutral` (the default), `accent`, `success`, `warning`, `danger`, `info`, or a tone of the theme.",
|
|
1920
|
+
"type": "string",
|
|
1921
|
+
"pattern": "^[a-z0-9-]+$"
|
|
1977
1922
|
}
|
|
1978
1923
|
},
|
|
1979
1924
|
"required": [
|
|
@@ -1994,6 +1939,14 @@
|
|
|
1994
1939
|
"message": {
|
|
1995
1940
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
1996
1941
|
"type": "string"
|
|
1942
|
+
},
|
|
1943
|
+
"mode": {
|
|
1944
|
+
"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.",
|
|
1945
|
+
"type": "string",
|
|
1946
|
+
"enum": [
|
|
1947
|
+
"create",
|
|
1948
|
+
"update"
|
|
1949
|
+
]
|
|
1997
1950
|
}
|
|
1998
1951
|
},
|
|
1999
1952
|
"required": [
|
|
@@ -2017,6 +1970,14 @@
|
|
|
2017
1970
|
"message": {
|
|
2018
1971
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2019
1972
|
"type": "string"
|
|
1973
|
+
},
|
|
1974
|
+
"mode": {
|
|
1975
|
+
"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.",
|
|
1976
|
+
"type": "string",
|
|
1977
|
+
"enum": [
|
|
1978
|
+
"create",
|
|
1979
|
+
"update"
|
|
1980
|
+
]
|
|
2020
1981
|
}
|
|
2021
1982
|
},
|
|
2022
1983
|
"required": [
|
|
@@ -2041,6 +2002,14 @@
|
|
|
2041
2002
|
"message": {
|
|
2042
2003
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2043
2004
|
"type": "string"
|
|
2005
|
+
},
|
|
2006
|
+
"mode": {
|
|
2007
|
+
"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.",
|
|
2008
|
+
"type": "string",
|
|
2009
|
+
"enum": [
|
|
2010
|
+
"create",
|
|
2011
|
+
"update"
|
|
2012
|
+
]
|
|
2044
2013
|
}
|
|
2045
2014
|
},
|
|
2046
2015
|
"required": [
|
|
@@ -2056,12 +2025,21 @@
|
|
|
2056
2025
|
"type": "string",
|
|
2057
2026
|
"enum": [
|
|
2058
2027
|
"email",
|
|
2059
|
-
"url"
|
|
2028
|
+
"url",
|
|
2029
|
+
"json"
|
|
2060
2030
|
]
|
|
2061
2031
|
},
|
|
2062
2032
|
"message": {
|
|
2063
2033
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2064
2034
|
"type": "string"
|
|
2035
|
+
},
|
|
2036
|
+
"mode": {
|
|
2037
|
+
"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.",
|
|
2038
|
+
"type": "string",
|
|
2039
|
+
"enum": [
|
|
2040
|
+
"create",
|
|
2041
|
+
"update"
|
|
2042
|
+
]
|
|
2065
2043
|
}
|
|
2066
2044
|
},
|
|
2067
2045
|
"required": [
|
|
@@ -2089,6 +2067,14 @@
|
|
|
2089
2067
|
"message": {
|
|
2090
2068
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2091
2069
|
"type": "string"
|
|
2070
|
+
},
|
|
2071
|
+
"mode": {
|
|
2072
|
+
"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.",
|
|
2073
|
+
"type": "string",
|
|
2074
|
+
"enum": [
|
|
2075
|
+
"create",
|
|
2076
|
+
"update"
|
|
2077
|
+
]
|
|
2092
2078
|
}
|
|
2093
2079
|
},
|
|
2094
2080
|
"required": [
|
|
@@ -2114,6 +2100,14 @@
|
|
|
2114
2100
|
"message": {
|
|
2115
2101
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2116
2102
|
"type": "string"
|
|
2103
|
+
},
|
|
2104
|
+
"mode": {
|
|
2105
|
+
"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.",
|
|
2106
|
+
"type": "string",
|
|
2107
|
+
"enum": [
|
|
2108
|
+
"create",
|
|
2109
|
+
"update"
|
|
2110
|
+
]
|
|
2117
2111
|
}
|
|
2118
2112
|
},
|
|
2119
2113
|
"required": [
|
|
@@ -2137,6 +2131,14 @@
|
|
|
2137
2131
|
"message": {
|
|
2138
2132
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2139
2133
|
"type": "string"
|
|
2134
|
+
},
|
|
2135
|
+
"mode": {
|
|
2136
|
+
"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.",
|
|
2137
|
+
"type": "string",
|
|
2138
|
+
"enum": [
|
|
2139
|
+
"create",
|
|
2140
|
+
"update"
|
|
2141
|
+
]
|
|
2140
2142
|
}
|
|
2141
2143
|
},
|
|
2142
2144
|
"required": [
|
|
@@ -2180,6 +2182,59 @@
|
|
|
2180
2182
|
"message": {
|
|
2181
2183
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2182
2184
|
"type": "string"
|
|
2185
|
+
},
|
|
2186
|
+
"mode": {
|
|
2187
|
+
"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.",
|
|
2188
|
+
"type": "string",
|
|
2189
|
+
"enum": [
|
|
2190
|
+
"create",
|
|
2191
|
+
"update"
|
|
2192
|
+
]
|
|
2193
|
+
}
|
|
2194
|
+
},
|
|
2195
|
+
"required": [
|
|
2196
|
+
"rule",
|
|
2197
|
+
"value"
|
|
2198
|
+
],
|
|
2199
|
+
"additionalProperties": {}
|
|
2200
|
+
},
|
|
2201
|
+
{
|
|
2202
|
+
"type": "object",
|
|
2203
|
+
"properties": {
|
|
2204
|
+
"rule": {
|
|
2205
|
+
"type": "string",
|
|
2206
|
+
"const": "crop"
|
|
2207
|
+
},
|
|
2208
|
+
"value": {
|
|
2209
|
+
"type": "object",
|
|
2210
|
+
"properties": {
|
|
2211
|
+
"ratios": {
|
|
2212
|
+
"description": "A crop must have one of them: its height is within one pixel of its width divided by the ratio, after its rotation.",
|
|
2213
|
+
"type": "array",
|
|
2214
|
+
"items": {
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"pattern": "^[1-9][0-9]*:[1-9][0-9]*$",
|
|
2217
|
+
"description": "An aspect ratio, as `width:height`: `16:9`."
|
|
2218
|
+
}
|
|
2219
|
+
},
|
|
2220
|
+
"required": {
|
|
2221
|
+
"description": "Each image needs a crop for this use.",
|
|
2222
|
+
"type": "boolean"
|
|
2223
|
+
}
|
|
2224
|
+
},
|
|
2225
|
+
"additionalProperties": {}
|
|
2226
|
+
},
|
|
2227
|
+
"message": {
|
|
2228
|
+
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2229
|
+
"type": "string"
|
|
2230
|
+
},
|
|
2231
|
+
"mode": {
|
|
2232
|
+
"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.",
|
|
2233
|
+
"type": "string",
|
|
2234
|
+
"enum": [
|
|
2235
|
+
"create",
|
|
2236
|
+
"update"
|
|
2237
|
+
]
|
|
2183
2238
|
}
|
|
2184
2239
|
},
|
|
2185
2240
|
"required": [
|
|
@@ -2197,6 +2252,14 @@
|
|
|
2197
2252
|
"message": {
|
|
2198
2253
|
"description": "Message shown when the rule fails, instead of the default one.",
|
|
2199
2254
|
"type": "string"
|
|
2255
|
+
},
|
|
2256
|
+
"mode": {
|
|
2257
|
+
"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.",
|
|
2258
|
+
"type": "string",
|
|
2259
|
+
"enum": [
|
|
2260
|
+
"create",
|
|
2261
|
+
"update"
|
|
2262
|
+
]
|
|
2200
2263
|
}
|
|
2201
2264
|
},
|
|
2202
2265
|
"required": [
|
|
@@ -2206,7 +2269,7 @@
|
|
|
2206
2269
|
"description": "A rule added in a later version of the protocol. Clients that don't know it ignore it; the server still enforces it."
|
|
2207
2270
|
}
|
|
2208
2271
|
],
|
|
2209
|
-
"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."
|
|
2272
|
+
"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)."
|
|
2210
2273
|
},
|
|
2211
2274
|
"BlockType": {
|
|
2212
2275
|
"type": "object",
|
|
@@ -2287,24 +2350,67 @@
|
|
|
2287
2350
|
}
|
|
2288
2351
|
},
|
|
2289
2352
|
"multiple": {
|
|
2290
|
-
"description": "`select`, `relation`, `media`: the value is an array.",
|
|
2353
|
+
"description": "`select`, `relation`, `media`, `image`, `file`: the value is an array.",
|
|
2291
2354
|
"type": "boolean"
|
|
2292
2355
|
},
|
|
2293
2356
|
"resource": {
|
|
2294
|
-
"description": "`relation`: id of the related resource.",
|
|
2295
|
-
"
|
|
2357
|
+
"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).",
|
|
2358
|
+
"anyOf": [
|
|
2359
|
+
{
|
|
2360
|
+
"type": "string",
|
|
2361
|
+
"minLength": 1
|
|
2362
|
+
},
|
|
2363
|
+
{
|
|
2364
|
+
"minItems": 1,
|
|
2365
|
+
"type": "array",
|
|
2366
|
+
"items": {
|
|
2367
|
+
"type": "string",
|
|
2368
|
+
"minLength": 1
|
|
2369
|
+
}
|
|
2370
|
+
}
|
|
2371
|
+
]
|
|
2296
2372
|
},
|
|
2297
2373
|
"accept": {
|
|
2298
|
-
"description": "`media`: accepted MIME types.",
|
|
2374
|
+
"description": "`media`, `image`, `file`: accepted MIME types. `image` defaults to `image/*`.",
|
|
2299
2375
|
"type": "array",
|
|
2300
2376
|
"items": {
|
|
2301
2377
|
"type": "string"
|
|
2302
2378
|
}
|
|
2303
2379
|
},
|
|
2380
|
+
"ratios": {
|
|
2381
|
+
"description": "`image`: ratios the editor suggests. The `crop` rule enforces ratios (decision 0031).",
|
|
2382
|
+
"type": "array",
|
|
2383
|
+
"items": {
|
|
2384
|
+
"type": "string",
|
|
2385
|
+
"pattern": "^[1-9][0-9]*:[1-9][0-9]*$",
|
|
2386
|
+
"description": "An aspect ratio, as `width:height`: `16:9`."
|
|
2387
|
+
}
|
|
2388
|
+
},
|
|
2389
|
+
"rotate": {
|
|
2390
|
+
"description": "`image`: whether the editor offers rotation and flips. Defaults to true.",
|
|
2391
|
+
"type": "boolean"
|
|
2392
|
+
},
|
|
2393
|
+
"focalPoint": {
|
|
2394
|
+
"description": "`image`: whether the editor offers the focal point. Defaults to true.",
|
|
2395
|
+
"type": "boolean"
|
|
2396
|
+
},
|
|
2397
|
+
"transformBase": {
|
|
2398
|
+
"description": "`image`: what a transform for one use starts from: the media's own transform (`media`, the default), the original file, or the user's choice in the editor (decision 0031).",
|
|
2399
|
+
"type": "string",
|
|
2400
|
+
"enum": [
|
|
2401
|
+
"media",
|
|
2402
|
+
"original",
|
|
2403
|
+
"choose"
|
|
2404
|
+
]
|
|
2405
|
+
},
|
|
2304
2406
|
"from": {
|
|
2305
2407
|
"description": "`slug`: the field the slug is generated from.",
|
|
2306
2408
|
"type": "string"
|
|
2307
2409
|
},
|
|
2410
|
+
"check": {
|
|
2411
|
+
"description": "The client checks the value with the backend as it is typed, with `POST /resources/{resource}/fields/{field}/check`: whether a `slug` is available, and its URL. A field at the top of the resource only.",
|
|
2412
|
+
"type": "boolean"
|
|
2413
|
+
},
|
|
2308
2414
|
"display": {
|
|
2309
2415
|
"description": "Display used in lists, when it differs from the default one of the type.",
|
|
2310
2416
|
"type": "string"
|
|
@@ -2338,6 +2444,89 @@
|
|
|
2338
2444
|
"additionalProperties": {},
|
|
2339
2445
|
"description": "A field of a form."
|
|
2340
2446
|
},
|
|
2447
|
+
"RichTextStyle": {
|
|
2448
|
+
"type": "object",
|
|
2449
|
+
"properties": {
|
|
2450
|
+
"label": {
|
|
2451
|
+
"type": "string",
|
|
2452
|
+
"description": "The name of the style in the toolbar."
|
|
2453
|
+
},
|
|
2454
|
+
"class": {
|
|
2455
|
+
"type": "string",
|
|
2456
|
+
"minLength": 1,
|
|
2457
|
+
"description": "The class the style puts on the element: `big`. Several classes are separated by spaces."
|
|
2458
|
+
},
|
|
2459
|
+
"element": {
|
|
2460
|
+
"description": "The element the style applies to: `p` (the default), `h1` to `h6`, `blockquote`, `ul`, `ol` or `li`.",
|
|
2461
|
+
"type": "string",
|
|
2462
|
+
"enum": [
|
|
2463
|
+
"p",
|
|
2464
|
+
"h1",
|
|
2465
|
+
"h2",
|
|
2466
|
+
"h3",
|
|
2467
|
+
"h4",
|
|
2468
|
+
"h5",
|
|
2469
|
+
"h6",
|
|
2470
|
+
"blockquote",
|
|
2471
|
+
"ul",
|
|
2472
|
+
"ol",
|
|
2473
|
+
"li"
|
|
2474
|
+
]
|
|
2475
|
+
}
|
|
2476
|
+
},
|
|
2477
|
+
"required": [
|
|
2478
|
+
"label",
|
|
2479
|
+
"class"
|
|
2480
|
+
],
|
|
2481
|
+
"additionalProperties": {},
|
|
2482
|
+
"description": "A block style of a `richtext` field: a named class on a paragraph, a heading, a quote or a list (`<p class=\"big\">`)."
|
|
2483
|
+
},
|
|
2484
|
+
"RichTextSettings": {
|
|
2485
|
+
"type": "object",
|
|
2486
|
+
"properties": {
|
|
2487
|
+
"toolbar": {
|
|
2488
|
+
"description": "The toolbar, in order: `heading`, `style`, `bold`, `italic`, `underline`, `strike`, `superscript`, `subscript`, `code`, `link`, `bulletList`, `orderedList`, `blockquote`, `horizontalRule`, `clear`, `undo`, `redo`, `|` between groups, and the buttons of plugins. Clients skip the names they don't know.",
|
|
2489
|
+
"type": "array",
|
|
2490
|
+
"items": {
|
|
2491
|
+
"type": "string",
|
|
2492
|
+
"minLength": 1
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
"headings": {
|
|
2496
|
+
"description": "The heading levels the toolbar offers. Defaults to 2, 3 and 4.",
|
|
2497
|
+
"type": "array",
|
|
2498
|
+
"items": {
|
|
2499
|
+
"type": "integer",
|
|
2500
|
+
"minimum": 1,
|
|
2501
|
+
"maximum": 6
|
|
2502
|
+
}
|
|
2503
|
+
},
|
|
2504
|
+
"styles": {
|
|
2505
|
+
"description": "The block styles.",
|
|
2506
|
+
"type": "array",
|
|
2507
|
+
"items": {
|
|
2508
|
+
"$ref": "#/components/schemas/RichTextStyle"
|
|
2509
|
+
}
|
|
2510
|
+
},
|
|
2511
|
+
"links": {
|
|
2512
|
+
"type": "object",
|
|
2513
|
+
"properties": {
|
|
2514
|
+
"newTab": {
|
|
2515
|
+
"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.",
|
|
2516
|
+
"type": "string",
|
|
2517
|
+
"enum": [
|
|
2518
|
+
"choose",
|
|
2519
|
+
"external",
|
|
2520
|
+
"never"
|
|
2521
|
+
]
|
|
2522
|
+
}
|
|
2523
|
+
},
|
|
2524
|
+
"additionalProperties": {}
|
|
2525
|
+
}
|
|
2526
|
+
},
|
|
2527
|
+
"additionalProperties": {},
|
|
2528
|
+
"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."
|
|
2529
|
+
},
|
|
2341
2530
|
"LayoutNode": {
|
|
2342
2531
|
"type": "object",
|
|
2343
2532
|
"properties": {
|
|
@@ -2528,6 +2717,14 @@
|
|
|
2528
2717
|
"maximum": 9007199254740991
|
|
2529
2718
|
}
|
|
2530
2719
|
},
|
|
2720
|
+
"pagination": {
|
|
2721
|
+
"description": "`pages` (the default): numbered pages, with a total. `cursor`: the list follows `nextCursor` of each page with the `cursor` parameter, without page numbers, for large lists that the backend can't count (decision 0039).",
|
|
2722
|
+
"type": "string",
|
|
2723
|
+
"enum": [
|
|
2724
|
+
"pages",
|
|
2725
|
+
"cursor"
|
|
2726
|
+
]
|
|
2727
|
+
},
|
|
2531
2728
|
"inlineEdit": {
|
|
2532
2729
|
"description": "Fields editable in the list.",
|
|
2533
2730
|
"type": "array",
|
|
@@ -2593,6 +2790,7 @@
|
|
|
2593
2790
|
"minLength": 1
|
|
2594
2791
|
},
|
|
2595
2792
|
"label": {
|
|
2793
|
+
"description": "Required, except for the built-in item actions (`show`, `edit`, `duplicate`, `delete`), which the client labels in its locale.",
|
|
2596
2794
|
"type": "string"
|
|
2597
2795
|
},
|
|
2598
2796
|
"icon": {
|
|
@@ -2644,6 +2842,10 @@
|
|
|
2644
2842
|
"description": "The action always answers `202` with a run.",
|
|
2645
2843
|
"type": "boolean"
|
|
2646
2844
|
},
|
|
2845
|
+
"dryRun": {
|
|
2846
|
+
"description": "The backend answers dry runs of this action (`dryRun` in the request): lists ask it how many items of a query selection will be skipped. Without it, the UI never sends `dryRun`, since a backend that ignores it would run the action.",
|
|
2847
|
+
"type": "boolean"
|
|
2848
|
+
},
|
|
2647
2849
|
"url": {
|
|
2648
2850
|
"description": "`link`: URL template, with `{id}` for the item.",
|
|
2649
2851
|
"type": "string"
|
|
@@ -2663,11 +2865,111 @@
|
|
|
2663
2865
|
},
|
|
2664
2866
|
"required": [
|
|
2665
2867
|
"id",
|
|
2666
|
-
"label",
|
|
2667
2868
|
"scope"
|
|
2668
2869
|
],
|
|
2669
2870
|
"additionalProperties": {},
|
|
2670
|
-
"description": "An operation on one item, a selection, or the whole resource."
|
|
2871
|
+
"description": "An operation on one item, a selection, or the whole resource.",
|
|
2872
|
+
"allOf": [
|
|
2873
|
+
{
|
|
2874
|
+
"if": {
|
|
2875
|
+
"properties": {
|
|
2876
|
+
"id": {
|
|
2877
|
+
"enum": [
|
|
2878
|
+
"show",
|
|
2879
|
+
"edit",
|
|
2880
|
+
"duplicate",
|
|
2881
|
+
"delete"
|
|
2882
|
+
]
|
|
2883
|
+
}
|
|
2884
|
+
},
|
|
2885
|
+
"required": [
|
|
2886
|
+
"id"
|
|
2887
|
+
]
|
|
2888
|
+
},
|
|
2889
|
+
"else": {
|
|
2890
|
+
"required": [
|
|
2891
|
+
"label"
|
|
2892
|
+
]
|
|
2893
|
+
}
|
|
2894
|
+
},
|
|
2895
|
+
{
|
|
2896
|
+
"if": {
|
|
2897
|
+
"properties": {
|
|
2898
|
+
"id": {
|
|
2899
|
+
"enum": [
|
|
2900
|
+
"show",
|
|
2901
|
+
"edit"
|
|
2902
|
+
]
|
|
2903
|
+
}
|
|
2904
|
+
},
|
|
2905
|
+
"required": [
|
|
2906
|
+
"id"
|
|
2907
|
+
]
|
|
2908
|
+
},
|
|
2909
|
+
"then": {
|
|
2910
|
+
"properties": {
|
|
2911
|
+
"kind": {
|
|
2912
|
+
"const": "link"
|
|
2913
|
+
}
|
|
2914
|
+
},
|
|
2915
|
+
"required": [
|
|
2916
|
+
"kind"
|
|
2917
|
+
]
|
|
2918
|
+
}
|
|
2919
|
+
},
|
|
2920
|
+
{
|
|
2921
|
+
"if": {
|
|
2922
|
+
"properties": {
|
|
2923
|
+
"kind": {
|
|
2924
|
+
"const": "link"
|
|
2925
|
+
},
|
|
2926
|
+
"id": {
|
|
2927
|
+
"not": {
|
|
2928
|
+
"enum": [
|
|
2929
|
+
"show",
|
|
2930
|
+
"edit"
|
|
2931
|
+
]
|
|
2932
|
+
}
|
|
2933
|
+
}
|
|
2934
|
+
},
|
|
2935
|
+
"required": [
|
|
2936
|
+
"kind",
|
|
2937
|
+
"id"
|
|
2938
|
+
]
|
|
2939
|
+
},
|
|
2940
|
+
"then": {
|
|
2941
|
+
"anyOf": [
|
|
2942
|
+
{
|
|
2943
|
+
"required": [
|
|
2944
|
+
"url"
|
|
2945
|
+
]
|
|
2946
|
+
},
|
|
2947
|
+
{
|
|
2948
|
+
"required": [
|
|
2949
|
+
"route"
|
|
2950
|
+
]
|
|
2951
|
+
}
|
|
2952
|
+
]
|
|
2953
|
+
}
|
|
2954
|
+
},
|
|
2955
|
+
{
|
|
2956
|
+
"if": {
|
|
2957
|
+
"properties": {
|
|
2958
|
+
"kind": {
|
|
2959
|
+
"const": "client"
|
|
2960
|
+
}
|
|
2961
|
+
},
|
|
2962
|
+
"required": [
|
|
2963
|
+
"kind"
|
|
2964
|
+
]
|
|
2965
|
+
},
|
|
2966
|
+
"then": {
|
|
2967
|
+
"required": [
|
|
2968
|
+
"component"
|
|
2969
|
+
]
|
|
2970
|
+
}
|
|
2971
|
+
}
|
|
2972
|
+
]
|
|
2671
2973
|
},
|
|
2672
2974
|
"ResourceFeatures": {
|
|
2673
2975
|
"type": "object",
|
|
@@ -2706,7 +3008,7 @@
|
|
|
2706
3008
|
]
|
|
2707
3009
|
},
|
|
2708
3010
|
"search": {
|
|
2709
|
-
"description": "Whether the resource is in the global search.",
|
|
3011
|
+
"description": "Whether the resource is in the global search. Defaults to whether its list has a search (`list.search`).",
|
|
2710
3012
|
"type": "boolean"
|
|
2711
3013
|
}
|
|
2712
3014
|
},
|
|
@@ -2719,6 +3021,11 @@
|
|
|
2719
3021
|
"type": "string",
|
|
2720
3022
|
"minLength": 1
|
|
2721
3023
|
},
|
|
3024
|
+
"kind": {
|
|
3025
|
+
"description": "What the resource is. `media`: a library of media (decision 0026), with a `file` field and a `media` on each item. Without it, an ordinary resource. Clients treat a kind they don't know as an ordinary resource.",
|
|
3026
|
+
"type": "string",
|
|
3027
|
+
"minLength": 1
|
|
3028
|
+
},
|
|
2722
3029
|
"label": {
|
|
2723
3030
|
"type": "object",
|
|
2724
3031
|
"properties": {
|
|
@@ -2745,6 +3052,38 @@
|
|
|
2745
3052
|
"description": "The field used as the title of an item, in lists and pickers.",
|
|
2746
3053
|
"type": "string"
|
|
2747
3054
|
},
|
|
3055
|
+
"itemSubtitle": {
|
|
3056
|
+
"description": "The field shown under the title of an item, in search results, cards and pickers.",
|
|
3057
|
+
"type": "string"
|
|
3058
|
+
},
|
|
3059
|
+
"itemImage": {
|
|
3060
|
+
"description": "The field that holds the image of an item (a media or a URL), in search results, cards and pickers.",
|
|
3061
|
+
"type": "string"
|
|
3062
|
+
},
|
|
3063
|
+
"open": {
|
|
3064
|
+
"description": "Where an item's title goes, in its list and wherever the app links to the item (decision 0040). `panel`, the default: the show route, with the item's details in a panel next to the list. `edit`: its edit form, and the show route redirects there. Clients treat a value they don't know as `panel`.",
|
|
3065
|
+
"anyOf": [
|
|
3066
|
+
{
|
|
3067
|
+
"type": "string",
|
|
3068
|
+
"enum": [
|
|
3069
|
+
"panel",
|
|
3070
|
+
"edit"
|
|
3071
|
+
]
|
|
3072
|
+
},
|
|
3073
|
+
{
|
|
3074
|
+
"type": "string",
|
|
3075
|
+
"minLength": 1
|
|
3076
|
+
}
|
|
3077
|
+
]
|
|
3078
|
+
},
|
|
3079
|
+
"itemActions": {
|
|
3080
|
+
"description": "The built-in item actions the resource shows, in their order (decision 0040): some of `show`, `edit`, `duplicate` and `delete`. Defaults to all four. Each one is shown on the items whose abilities allow it (`view`, `update`, `duplicate`, `delete`). `[]` shows none. Clients ignore ids they don't know.",
|
|
3081
|
+
"type": "array",
|
|
3082
|
+
"items": {
|
|
3083
|
+
"type": "string",
|
|
3084
|
+
"minLength": 1
|
|
3085
|
+
}
|
|
3086
|
+
},
|
|
2748
3087
|
"fields": {
|
|
2749
3088
|
"type": "array",
|
|
2750
3089
|
"items": {
|
|
@@ -2818,6 +3157,10 @@
|
|
|
2818
3157
|
},
|
|
2819
3158
|
"abilities": {
|
|
2820
3159
|
"$ref": "#/components/schemas/Abilities"
|
|
3160
|
+
},
|
|
3161
|
+
"resource": {
|
|
3162
|
+
"description": "The resource of users: its item with this `id` is the profile of the user. Without it, clients look for a resource `users`.",
|
|
3163
|
+
"type": "string"
|
|
2821
3164
|
}
|
|
2822
3165
|
},
|
|
2823
3166
|
"required": [
|
|
@@ -2850,6 +3193,20 @@
|
|
|
2850
3193
|
],
|
|
2851
3194
|
"additionalProperties": {}
|
|
2852
3195
|
},
|
|
3196
|
+
"AuthToken": {
|
|
3197
|
+
"type": "object",
|
|
3198
|
+
"properties": {
|
|
3199
|
+
"label": {
|
|
3200
|
+
"description": "Label of the field. Defaults to \"Token\".",
|
|
3201
|
+
"type": "string"
|
|
3202
|
+
},
|
|
3203
|
+
"help": {
|
|
3204
|
+
"description": "Help under the field: where to find it.",
|
|
3205
|
+
"type": "string"
|
|
3206
|
+
}
|
|
3207
|
+
},
|
|
3208
|
+
"additionalProperties": {}
|
|
3209
|
+
},
|
|
2853
3210
|
"Auth": {
|
|
2854
3211
|
"type": "object",
|
|
2855
3212
|
"properties": {
|
|
@@ -2868,9 +3225,21 @@
|
|
|
2868
3225
|
"null"
|
|
2869
3226
|
]
|
|
2870
3227
|
},
|
|
3228
|
+
"logoutUrl": {
|
|
3229
|
+
"description": "`external`: where the browser goes to log out, the site's own logout. Without it, the app offers no logout.",
|
|
3230
|
+
"type": [
|
|
3231
|
+
"string",
|
|
3232
|
+
"null"
|
|
3233
|
+
]
|
|
3234
|
+
},
|
|
2871
3235
|
"password": {
|
|
3236
|
+
"description": "`panneau`: a login with an email and a password. Defaults to true without `token`.",
|
|
2872
3237
|
"type": "boolean"
|
|
2873
3238
|
},
|
|
3239
|
+
"token": {
|
|
3240
|
+
"description": "`panneau`: a login with a single secret, such as an access token, sent as `token` to `POST /auth/login`.",
|
|
3241
|
+
"$ref": "#/components/schemas/AuthToken"
|
|
3242
|
+
},
|
|
2874
3243
|
"providers": {
|
|
2875
3244
|
"type": "array",
|
|
2876
3245
|
"items": {
|
|
@@ -2955,6 +3324,14 @@
|
|
|
2955
3324
|
"type": "string"
|
|
2956
3325
|
},
|
|
2957
3326
|
"additionalProperties": {}
|
|
3327
|
+
},
|
|
3328
|
+
"params": {
|
|
3329
|
+
"description": "Names of the path segments after the page: `[\"id\"]` makes `{basePath}/pages/{page}/{id}`. The component gets them as `params`, and route references (`{ \"route\": \"<page>\", \"params\": { \"id\": … } }`) can link to the page. A page with `params` is not in menus.",
|
|
3330
|
+
"type": "array",
|
|
3331
|
+
"items": {
|
|
3332
|
+
"type": "string",
|
|
3333
|
+
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
|
|
3334
|
+
}
|
|
2958
3335
|
}
|
|
2959
3336
|
},
|
|
2960
3337
|
"required": [
|
|
@@ -3005,9 +3382,11 @@
|
|
|
3005
3382
|
"multipart",
|
|
3006
3383
|
"tus",
|
|
3007
3384
|
"presigned"
|
|
3008
|
-
]
|
|
3385
|
+
],
|
|
3386
|
+
"description": "`multipart`: files go through `POST /media` and the requests that take them. `presigned`: the browser also sends files to storage itself, with URLs that `POST /uploads/sign` signs, then `POST /uploads/{upload}/complete` gives an upload that values reference."
|
|
3009
3387
|
},
|
|
3010
3388
|
"endpoint": {
|
|
3389
|
+
"description": "`presigned`: the base URL of the upload routes, when they are not `{api.baseUrl}/uploads`.",
|
|
3011
3390
|
"type": "string"
|
|
3012
3391
|
},
|
|
3013
3392
|
"maxSize": {
|
|
@@ -3021,6 +3400,423 @@
|
|
|
3021
3400
|
],
|
|
3022
3401
|
"additionalProperties": {}
|
|
3023
3402
|
},
|
|
3403
|
+
"ThemeTokens": {
|
|
3404
|
+
"type": "object",
|
|
3405
|
+
"propertyNames": {
|
|
3406
|
+
"type": "string",
|
|
3407
|
+
"pattern": "^[a-zA-Z0-9_-]+$"
|
|
3408
|
+
},
|
|
3409
|
+
"additionalProperties": {
|
|
3410
|
+
"type": "string",
|
|
3411
|
+
"pattern": "^[^{};<]*$"
|
|
3412
|
+
},
|
|
3413
|
+
"description": "CSS variables without the leading `--`, and their values: `{ \"panneau-color-accent\": \"#05f\" }`. Values cannot contain `{`, `}`, `;` or `<`."
|
|
3414
|
+
},
|
|
3415
|
+
"ToneValues": {
|
|
3416
|
+
"type": "object",
|
|
3417
|
+
"properties": {
|
|
3418
|
+
"text": {
|
|
3419
|
+
"type": "string",
|
|
3420
|
+
"description": "Text and icons on surfaces."
|
|
3421
|
+
},
|
|
3422
|
+
"subtle": {
|
|
3423
|
+
"type": "string",
|
|
3424
|
+
"description": "Background of the subtle appearance."
|
|
3425
|
+
},
|
|
3426
|
+
"border": {
|
|
3427
|
+
"type": "string",
|
|
3428
|
+
"description": "Border of the subtle appearance."
|
|
3429
|
+
},
|
|
3430
|
+
"outline": {
|
|
3431
|
+
"type": "string",
|
|
3432
|
+
"description": "Border of the outline appearance."
|
|
3433
|
+
},
|
|
3434
|
+
"solid": {
|
|
3435
|
+
"type": "string",
|
|
3436
|
+
"description": "Background of the solid appearance."
|
|
3437
|
+
},
|
|
3438
|
+
"solidHover": {
|
|
3439
|
+
"type": "string",
|
|
3440
|
+
"description": "Background of the solid appearance on hover."
|
|
3441
|
+
},
|
|
3442
|
+
"solidText": {
|
|
3443
|
+
"type": "string",
|
|
3444
|
+
"description": "Text on the solid appearance."
|
|
3445
|
+
}
|
|
3446
|
+
},
|
|
3447
|
+
"required": [
|
|
3448
|
+
"text",
|
|
3449
|
+
"subtle",
|
|
3450
|
+
"border",
|
|
3451
|
+
"outline",
|
|
3452
|
+
"solid",
|
|
3453
|
+
"solidHover",
|
|
3454
|
+
"solidText"
|
|
3455
|
+
],
|
|
3456
|
+
"additionalProperties": {}
|
|
3457
|
+
},
|
|
3458
|
+
"ToneInput": {
|
|
3459
|
+
"anyOf": [
|
|
3460
|
+
{
|
|
3461
|
+
"type": "string",
|
|
3462
|
+
"description": "One color, from which Panneau derives the others."
|
|
3463
|
+
},
|
|
3464
|
+
{
|
|
3465
|
+
"type": "object",
|
|
3466
|
+
"properties": {
|
|
3467
|
+
"text": {
|
|
3468
|
+
"type": "string",
|
|
3469
|
+
"description": "Text and icons on surfaces."
|
|
3470
|
+
},
|
|
3471
|
+
"subtle": {
|
|
3472
|
+
"type": "string",
|
|
3473
|
+
"description": "Background of the subtle appearance."
|
|
3474
|
+
},
|
|
3475
|
+
"border": {
|
|
3476
|
+
"type": "string",
|
|
3477
|
+
"description": "Border of the subtle appearance."
|
|
3478
|
+
},
|
|
3479
|
+
"outline": {
|
|
3480
|
+
"type": "string",
|
|
3481
|
+
"description": "Border of the outline appearance."
|
|
3482
|
+
},
|
|
3483
|
+
"solid": {
|
|
3484
|
+
"type": "string",
|
|
3485
|
+
"description": "Background of the solid appearance."
|
|
3486
|
+
},
|
|
3487
|
+
"solidHover": {
|
|
3488
|
+
"type": "string",
|
|
3489
|
+
"description": "Background of the solid appearance on hover."
|
|
3490
|
+
},
|
|
3491
|
+
"solidText": {
|
|
3492
|
+
"type": "string",
|
|
3493
|
+
"description": "Text on the solid appearance."
|
|
3494
|
+
},
|
|
3495
|
+
"dark": {
|
|
3496
|
+
"type": "object",
|
|
3497
|
+
"properties": {
|
|
3498
|
+
"text": {
|
|
3499
|
+
"type": "string",
|
|
3500
|
+
"description": "Text and icons on surfaces."
|
|
3501
|
+
},
|
|
3502
|
+
"subtle": {
|
|
3503
|
+
"type": "string",
|
|
3504
|
+
"description": "Background of the subtle appearance."
|
|
3505
|
+
},
|
|
3506
|
+
"border": {
|
|
3507
|
+
"type": "string",
|
|
3508
|
+
"description": "Border of the subtle appearance."
|
|
3509
|
+
},
|
|
3510
|
+
"outline": {
|
|
3511
|
+
"type": "string",
|
|
3512
|
+
"description": "Border of the outline appearance."
|
|
3513
|
+
},
|
|
3514
|
+
"solid": {
|
|
3515
|
+
"type": "string",
|
|
3516
|
+
"description": "Background of the solid appearance."
|
|
3517
|
+
},
|
|
3518
|
+
"solidHover": {
|
|
3519
|
+
"type": "string",
|
|
3520
|
+
"description": "Background of the solid appearance on hover."
|
|
3521
|
+
},
|
|
3522
|
+
"solidText": {
|
|
3523
|
+
"type": "string",
|
|
3524
|
+
"description": "Text on the solid appearance."
|
|
3525
|
+
}
|
|
3526
|
+
},
|
|
3527
|
+
"additionalProperties": {}
|
|
3528
|
+
}
|
|
3529
|
+
},
|
|
3530
|
+
"required": [
|
|
3531
|
+
"text",
|
|
3532
|
+
"subtle",
|
|
3533
|
+
"border",
|
|
3534
|
+
"outline",
|
|
3535
|
+
"solid",
|
|
3536
|
+
"solidHover",
|
|
3537
|
+
"solidText"
|
|
3538
|
+
],
|
|
3539
|
+
"additionalProperties": {}
|
|
3540
|
+
}
|
|
3541
|
+
],
|
|
3542
|
+
"description": "A tone: one color, or every value with dark scheme overrides."
|
|
3543
|
+
},
|
|
3544
|
+
"ThemeFontFace": {
|
|
3545
|
+
"type": "object",
|
|
3546
|
+
"properties": {
|
|
3547
|
+
"family": {
|
|
3548
|
+
"type": "string",
|
|
3549
|
+
"pattern": "^[^{}<;\"\\\\]+$"
|
|
3550
|
+
},
|
|
3551
|
+
"src": {
|
|
3552
|
+
"type": "string",
|
|
3553
|
+
"pattern": "^[^{}<]+$",
|
|
3554
|
+
"description": "The `src` descriptor: `url(/fonts/geist.woff2) format('woff2')`."
|
|
3555
|
+
},
|
|
3556
|
+
"weight": {
|
|
3557
|
+
"type": "string",
|
|
3558
|
+
"pattern": "^[^{}<;]*$"
|
|
3559
|
+
},
|
|
3560
|
+
"style": {
|
|
3561
|
+
"type": "string",
|
|
3562
|
+
"pattern": "^[^{}<;]*$"
|
|
3563
|
+
},
|
|
3564
|
+
"display": {
|
|
3565
|
+
"type": "string",
|
|
3566
|
+
"enum": [
|
|
3567
|
+
"auto",
|
|
3568
|
+
"block",
|
|
3569
|
+
"swap",
|
|
3570
|
+
"fallback",
|
|
3571
|
+
"optional"
|
|
3572
|
+
]
|
|
3573
|
+
},
|
|
3574
|
+
"unicodeRange": {
|
|
3575
|
+
"type": "string",
|
|
3576
|
+
"pattern": "^[^{}<;]*$"
|
|
3577
|
+
}
|
|
3578
|
+
},
|
|
3579
|
+
"required": [
|
|
3580
|
+
"family",
|
|
3581
|
+
"src"
|
|
3582
|
+
],
|
|
3583
|
+
"additionalProperties": {},
|
|
3584
|
+
"description": "A font face, written as an `@font-face` rule."
|
|
3585
|
+
},
|
|
3586
|
+
"ThemeFontStylesheet": {
|
|
3587
|
+
"type": "object",
|
|
3588
|
+
"properties": {
|
|
3589
|
+
"stylesheet": {
|
|
3590
|
+
"type": "string",
|
|
3591
|
+
"minLength": 1
|
|
3592
|
+
}
|
|
3593
|
+
},
|
|
3594
|
+
"required": [
|
|
3595
|
+
"stylesheet"
|
|
3596
|
+
],
|
|
3597
|
+
"additionalProperties": {},
|
|
3598
|
+
"description": "A hosted stylesheet that declares font faces."
|
|
3599
|
+
},
|
|
3600
|
+
"ThemeFont": {
|
|
3601
|
+
"anyOf": [
|
|
3602
|
+
{
|
|
3603
|
+
"$ref": "#/components/schemas/ThemeFontFace"
|
|
3604
|
+
},
|
|
3605
|
+
{
|
|
3606
|
+
"$ref": "#/components/schemas/ThemeFontStylesheet"
|
|
3607
|
+
}
|
|
3608
|
+
]
|
|
3609
|
+
},
|
|
3610
|
+
"Theme": {
|
|
3611
|
+
"type": "object",
|
|
3612
|
+
"properties": {
|
|
3613
|
+
"label": {
|
|
3614
|
+
"type": "string"
|
|
3615
|
+
},
|
|
3616
|
+
"tokens": {
|
|
3617
|
+
"description": "Tokens of the light scheme, or of both schemes when `dark` does not set them.",
|
|
3618
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3619
|
+
},
|
|
3620
|
+
"dark": {
|
|
3621
|
+
"description": "Tokens that change in the dark scheme.",
|
|
3622
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3623
|
+
},
|
|
3624
|
+
"palette": {
|
|
3625
|
+
"description": "Raw colors, written as `--panneau-palette-<name>`: tokens and tones use them with `var(--panneau-palette-<name>)`.",
|
|
3626
|
+
"type": "object",
|
|
3627
|
+
"propertyNames": {
|
|
3628
|
+
"type": "string",
|
|
3629
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3630
|
+
},
|
|
3631
|
+
"additionalProperties": {
|
|
3632
|
+
"type": "string",
|
|
3633
|
+
"pattern": "^[^{};<]*$"
|
|
3634
|
+
}
|
|
3635
|
+
},
|
|
3636
|
+
"tones": {
|
|
3637
|
+
"description": "Tones added or redefined by the theme, applied by `panneau-tone-<name>`.",
|
|
3638
|
+
"type": "object",
|
|
3639
|
+
"propertyNames": {
|
|
3640
|
+
"type": "string",
|
|
3641
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3642
|
+
},
|
|
3643
|
+
"additionalProperties": {
|
|
3644
|
+
"$ref": "#/components/schemas/ToneInput"
|
|
3645
|
+
}
|
|
3646
|
+
},
|
|
3647
|
+
"components": {
|
|
3648
|
+
"description": "Named variants of components: tokens applied by `panneau-<component>-variant-<name>`.",
|
|
3649
|
+
"type": "object",
|
|
3650
|
+
"propertyNames": {
|
|
3651
|
+
"type": "string",
|
|
3652
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3653
|
+
},
|
|
3654
|
+
"additionalProperties": {
|
|
3655
|
+
"type": "object",
|
|
3656
|
+
"properties": {
|
|
3657
|
+
"variants": {
|
|
3658
|
+
"type": "object",
|
|
3659
|
+
"propertyNames": {
|
|
3660
|
+
"type": "string",
|
|
3661
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3662
|
+
},
|
|
3663
|
+
"additionalProperties": {
|
|
3664
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3665
|
+
}
|
|
3666
|
+
}
|
|
3667
|
+
},
|
|
3668
|
+
"additionalProperties": {}
|
|
3669
|
+
}
|
|
3670
|
+
},
|
|
3671
|
+
"densities": {
|
|
3672
|
+
"description": "Tokens of each density (`panneau-control-height`…), which change with the density of the root.",
|
|
3673
|
+
"type": "object",
|
|
3674
|
+
"properties": {
|
|
3675
|
+
"compact": {
|
|
3676
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3677
|
+
},
|
|
3678
|
+
"comfortable": {
|
|
3679
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3680
|
+
},
|
|
3681
|
+
"touch": {
|
|
3682
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3683
|
+
}
|
|
3684
|
+
},
|
|
3685
|
+
"additionalProperties": {}
|
|
3686
|
+
},
|
|
3687
|
+
"fonts": {
|
|
3688
|
+
"description": "Font faces and font stylesheets, added to the page once.",
|
|
3689
|
+
"type": "array",
|
|
3690
|
+
"items": {
|
|
3691
|
+
"$ref": "#/components/schemas/ThemeFont"
|
|
3692
|
+
}
|
|
3693
|
+
}
|
|
3694
|
+
},
|
|
3695
|
+
"required": [
|
|
3696
|
+
"tokens"
|
|
3697
|
+
],
|
|
3698
|
+
"additionalProperties": {},
|
|
3699
|
+
"description": "A theme of `@panneau/ui`, as plain data (decision 0024)."
|
|
3700
|
+
},
|
|
3701
|
+
"DefinitionTheme": {
|
|
3702
|
+
"type": "object",
|
|
3703
|
+
"properties": {
|
|
3704
|
+
"label": {
|
|
3705
|
+
"type": "string"
|
|
3706
|
+
},
|
|
3707
|
+
"tokens": {
|
|
3708
|
+
"description": "Tokens of the light scheme, or of both schemes when `dark` does not set them.",
|
|
3709
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3710
|
+
},
|
|
3711
|
+
"dark": {
|
|
3712
|
+
"description": "Tokens that change in the dark scheme.",
|
|
3713
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3714
|
+
},
|
|
3715
|
+
"palette": {
|
|
3716
|
+
"description": "Raw colors, written as `--panneau-palette-<name>`: tokens and tones use them with `var(--panneau-palette-<name>)`.",
|
|
3717
|
+
"type": "object",
|
|
3718
|
+
"propertyNames": {
|
|
3719
|
+
"type": "string",
|
|
3720
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3721
|
+
},
|
|
3722
|
+
"additionalProperties": {
|
|
3723
|
+
"type": "string",
|
|
3724
|
+
"pattern": "^[^{};<]*$"
|
|
3725
|
+
}
|
|
3726
|
+
},
|
|
3727
|
+
"tones": {
|
|
3728
|
+
"description": "Tones added or redefined by the theme, applied by `panneau-tone-<name>`.",
|
|
3729
|
+
"type": "object",
|
|
3730
|
+
"propertyNames": {
|
|
3731
|
+
"type": "string",
|
|
3732
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3733
|
+
},
|
|
3734
|
+
"additionalProperties": {
|
|
3735
|
+
"$ref": "#/components/schemas/ToneInput"
|
|
3736
|
+
}
|
|
3737
|
+
},
|
|
3738
|
+
"components": {
|
|
3739
|
+
"description": "Named variants of components: tokens applied by `panneau-<component>-variant-<name>`.",
|
|
3740
|
+
"type": "object",
|
|
3741
|
+
"propertyNames": {
|
|
3742
|
+
"type": "string",
|
|
3743
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3744
|
+
},
|
|
3745
|
+
"additionalProperties": {
|
|
3746
|
+
"type": "object",
|
|
3747
|
+
"properties": {
|
|
3748
|
+
"variants": {
|
|
3749
|
+
"type": "object",
|
|
3750
|
+
"propertyNames": {
|
|
3751
|
+
"type": "string",
|
|
3752
|
+
"pattern": "^[a-z0-9-]+$"
|
|
3753
|
+
},
|
|
3754
|
+
"additionalProperties": {
|
|
3755
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3756
|
+
}
|
|
3757
|
+
}
|
|
3758
|
+
},
|
|
3759
|
+
"additionalProperties": {}
|
|
3760
|
+
}
|
|
3761
|
+
},
|
|
3762
|
+
"densities": {
|
|
3763
|
+
"description": "Tokens of each density (`panneau-control-height`…), which change with the density of the root.",
|
|
3764
|
+
"type": "object",
|
|
3765
|
+
"properties": {
|
|
3766
|
+
"compact": {
|
|
3767
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3768
|
+
},
|
|
3769
|
+
"comfortable": {
|
|
3770
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3771
|
+
},
|
|
3772
|
+
"touch": {
|
|
3773
|
+
"$ref": "#/components/schemas/ThemeTokens"
|
|
3774
|
+
}
|
|
3775
|
+
},
|
|
3776
|
+
"additionalProperties": {}
|
|
3777
|
+
},
|
|
3778
|
+
"fonts": {
|
|
3779
|
+
"description": "Font faces and font stylesheets, added to the page once.",
|
|
3780
|
+
"type": "array",
|
|
3781
|
+
"items": {
|
|
3782
|
+
"$ref": "#/components/schemas/ThemeFont"
|
|
3783
|
+
}
|
|
3784
|
+
},
|
|
3785
|
+
"colorScheme": {
|
|
3786
|
+
"type": "string",
|
|
3787
|
+
"enum": [
|
|
3788
|
+
"light",
|
|
3789
|
+
"dark",
|
|
3790
|
+
"auto"
|
|
3791
|
+
]
|
|
3792
|
+
},
|
|
3793
|
+
"density": {
|
|
3794
|
+
"type": "string",
|
|
3795
|
+
"enum": [
|
|
3796
|
+
"compact",
|
|
3797
|
+
"comfortable",
|
|
3798
|
+
"touch",
|
|
3799
|
+
"auto"
|
|
3800
|
+
]
|
|
3801
|
+
},
|
|
3802
|
+
"extends": {
|
|
3803
|
+
"description": "Themes registered by plugins, by id, that this theme builds on, in order: its own values override theirs.",
|
|
3804
|
+
"anyOf": [
|
|
3805
|
+
{
|
|
3806
|
+
"type": "string"
|
|
3807
|
+
},
|
|
3808
|
+
{
|
|
3809
|
+
"type": "array",
|
|
3810
|
+
"items": {
|
|
3811
|
+
"type": "string"
|
|
3812
|
+
}
|
|
3813
|
+
}
|
|
3814
|
+
]
|
|
3815
|
+
}
|
|
3816
|
+
},
|
|
3817
|
+
"additionalProperties": {},
|
|
3818
|
+
"description": "The theme of the admin: a theme, built on themes of plugins."
|
|
3819
|
+
},
|
|
3024
3820
|
"Definition": {
|
|
3025
3821
|
"type": "object",
|
|
3026
3822
|
"properties": {
|
|
@@ -3127,20 +3923,9 @@
|
|
|
3127
3923
|
"uploads": {
|
|
3128
3924
|
"$ref": "#/components/schemas/Uploads"
|
|
3129
3925
|
},
|
|
3130
|
-
"theme": {
|
|
3131
|
-
"
|
|
3132
|
-
|
|
3133
|
-
"colorScheme": {
|
|
3134
|
-
"type": "string",
|
|
3135
|
-
"enum": [
|
|
3136
|
-
"light",
|
|
3137
|
-
"dark",
|
|
3138
|
-
"auto"
|
|
3139
|
-
]
|
|
3140
|
-
}
|
|
3141
|
-
},
|
|
3142
|
-
"additionalProperties": {}
|
|
3143
|
-
},
|
|
3926
|
+
"theme": {
|
|
3927
|
+
"$ref": "#/components/schemas/DefinitionTheme"
|
|
3928
|
+
},
|
|
3144
3929
|
"user": {
|
|
3145
3930
|
"anyOf": [
|
|
3146
3931
|
{
|
|
@@ -3220,6 +4005,59 @@
|
|
|
3220
4005
|
],
|
|
3221
4006
|
"additionalProperties": {}
|
|
3222
4007
|
},
|
|
4008
|
+
"CursorPagination": {
|
|
4009
|
+
"type": "object",
|
|
4010
|
+
"properties": {
|
|
4011
|
+
"perPage": {
|
|
4012
|
+
"type": "integer",
|
|
4013
|
+
"exclusiveMinimum": 0,
|
|
4014
|
+
"maximum": 9007199254740991
|
|
4015
|
+
},
|
|
4016
|
+
"nextCursor": {
|
|
4017
|
+
"anyOf": [
|
|
4018
|
+
{
|
|
4019
|
+
"type": "string",
|
|
4020
|
+
"minLength": 1
|
|
4021
|
+
},
|
|
4022
|
+
{
|
|
4023
|
+
"type": "null"
|
|
4024
|
+
}
|
|
4025
|
+
],
|
|
4026
|
+
"description": "The `cursor` of the next page, or `null` on the last page."
|
|
4027
|
+
},
|
|
4028
|
+
"previousCursor": {
|
|
4029
|
+
"description": "The `cursor` of the previous page, or `null` when it is the first page, which has none (and on the first page). Without it, clients go back through the cursors they followed.",
|
|
4030
|
+
"anyOf": [
|
|
4031
|
+
{
|
|
4032
|
+
"type": "string",
|
|
4033
|
+
"minLength": 1
|
|
4034
|
+
},
|
|
4035
|
+
{
|
|
4036
|
+
"type": "null"
|
|
4037
|
+
}
|
|
4038
|
+
]
|
|
4039
|
+
},
|
|
4040
|
+
"total": {
|
|
4041
|
+
"description": "How many items match, when the backend counts them.",
|
|
4042
|
+
"anyOf": [
|
|
4043
|
+
{
|
|
4044
|
+
"type": "integer",
|
|
4045
|
+
"minimum": 0,
|
|
4046
|
+
"maximum": 9007199254740991
|
|
4047
|
+
},
|
|
4048
|
+
{
|
|
4049
|
+
"type": "null"
|
|
4050
|
+
}
|
|
4051
|
+
]
|
|
4052
|
+
}
|
|
4053
|
+
},
|
|
4054
|
+
"required": [
|
|
4055
|
+
"perPage",
|
|
4056
|
+
"nextCursor"
|
|
4057
|
+
],
|
|
4058
|
+
"additionalProperties": {},
|
|
4059
|
+
"description": "The meta of a page of a list whose `pagination` is `cursor`: no page numbers, and no total unless the backend has one."
|
|
4060
|
+
},
|
|
3223
4061
|
"ItemResponse": {
|
|
3224
4062
|
"type": "object",
|
|
3225
4063
|
"properties": {
|
|
@@ -3242,7 +4080,14 @@
|
|
|
3242
4080
|
}
|
|
3243
4081
|
},
|
|
3244
4082
|
"meta": {
|
|
3245
|
-
"
|
|
4083
|
+
"anyOf": [
|
|
4084
|
+
{
|
|
4085
|
+
"$ref": "#/components/schemas/Pagination"
|
|
4086
|
+
},
|
|
4087
|
+
{
|
|
4088
|
+
"$ref": "#/components/schemas/CursorPagination"
|
|
4089
|
+
}
|
|
4090
|
+
]
|
|
3246
4091
|
}
|
|
3247
4092
|
},
|
|
3248
4093
|
"required": [
|
|
@@ -3363,6 +4208,10 @@
|
|
|
3363
4208
|
"type": "string"
|
|
3364
4209
|
},
|
|
3365
4210
|
"additionalProperties": {}
|
|
4211
|
+
},
|
|
4212
|
+
"dryRun": {
|
|
4213
|
+
"description": "Answer what the action would do without running it: a `200` action result whose `summary` counts the items that would succeed and those that would be skipped. Only for actions with `dryRun: true`.",
|
|
4214
|
+
"type": "boolean"
|
|
3366
4215
|
}
|
|
3367
4216
|
},
|
|
3368
4217
|
"additionalProperties": {}
|
|
@@ -3566,20 +4415,28 @@
|
|
|
3566
4415
|
"type": "object",
|
|
3567
4416
|
"properties": {
|
|
3568
4417
|
"crop": {
|
|
3569
|
-
"description": "In pixels of the original image.",
|
|
4418
|
+
"description": "In whole pixels of the upright original image (after its EXIF orientation), from its top left corner.",
|
|
3570
4419
|
"type": "object",
|
|
3571
4420
|
"properties": {
|
|
3572
4421
|
"x": {
|
|
3573
|
-
"type": "
|
|
4422
|
+
"type": "integer",
|
|
4423
|
+
"minimum": 0,
|
|
4424
|
+
"maximum": 9007199254740991
|
|
3574
4425
|
},
|
|
3575
4426
|
"y": {
|
|
3576
|
-
"type": "
|
|
4427
|
+
"type": "integer",
|
|
4428
|
+
"minimum": 0,
|
|
4429
|
+
"maximum": 9007199254740991
|
|
3577
4430
|
},
|
|
3578
4431
|
"width": {
|
|
3579
|
-
"type": "
|
|
4432
|
+
"type": "integer",
|
|
4433
|
+
"exclusiveMinimum": 0,
|
|
4434
|
+
"maximum": 9007199254740991
|
|
3580
4435
|
},
|
|
3581
4436
|
"height": {
|
|
3582
|
-
"type": "
|
|
4437
|
+
"type": "integer",
|
|
4438
|
+
"exclusiveMinimum": 0,
|
|
4439
|
+
"maximum": 9007199254740991
|
|
3583
4440
|
}
|
|
3584
4441
|
},
|
|
3585
4442
|
"required": [
|
|
@@ -3590,89 +4447,346 @@
|
|
|
3590
4447
|
],
|
|
3591
4448
|
"additionalProperties": {}
|
|
3592
4449
|
},
|
|
3593
|
-
"rotate": {
|
|
4450
|
+
"rotate": {
|
|
4451
|
+
"description": "Clockwise, in degrees.",
|
|
4452
|
+
"anyOf": [
|
|
4453
|
+
{
|
|
4454
|
+
"type": "number",
|
|
4455
|
+
"const": 0
|
|
4456
|
+
},
|
|
4457
|
+
{
|
|
4458
|
+
"type": "number",
|
|
4459
|
+
"const": 90
|
|
4460
|
+
},
|
|
4461
|
+
{
|
|
4462
|
+
"type": "number",
|
|
4463
|
+
"const": 180
|
|
4464
|
+
},
|
|
4465
|
+
{
|
|
4466
|
+
"type": "number",
|
|
4467
|
+
"const": 270
|
|
4468
|
+
}
|
|
4469
|
+
]
|
|
4470
|
+
},
|
|
4471
|
+
"flipX": {
|
|
4472
|
+
"description": "Mirrors left to right (horizontal).",
|
|
4473
|
+
"type": "boolean"
|
|
4474
|
+
},
|
|
4475
|
+
"flipY": {
|
|
4476
|
+
"description": "Mirrors top to bottom (vertical).",
|
|
4477
|
+
"type": "boolean"
|
|
4478
|
+
},
|
|
4479
|
+
"focalPoint": {
|
|
4480
|
+
"description": "From 0 to 1, relative to the width and height of the upright original image, not of the crop: changing the crop does not move it. Renderers map it into the transformed image and clamp it to the crop.",
|
|
4481
|
+
"type": "object",
|
|
4482
|
+
"properties": {
|
|
4483
|
+
"x": {
|
|
4484
|
+
"type": "number",
|
|
4485
|
+
"minimum": 0,
|
|
4486
|
+
"maximum": 1
|
|
4487
|
+
},
|
|
4488
|
+
"y": {
|
|
4489
|
+
"type": "number",
|
|
4490
|
+
"minimum": 0,
|
|
4491
|
+
"maximum": 1
|
|
4492
|
+
}
|
|
4493
|
+
},
|
|
4494
|
+
"required": [
|
|
4495
|
+
"x",
|
|
4496
|
+
"y"
|
|
4497
|
+
],
|
|
4498
|
+
"additionalProperties": {}
|
|
4499
|
+
},
|
|
4500
|
+
"base": {
|
|
4501
|
+
"description": "What a transform for one use starts from: the original file by default, or the media's own transform (`media`). With `media`, the crop and the focal point are relative to the media's version instead of the original (decision 0031).",
|
|
4502
|
+
"type": "string",
|
|
4503
|
+
"enum": [
|
|
4504
|
+
"media",
|
|
4505
|
+
"original"
|
|
4506
|
+
]
|
|
4507
|
+
},
|
|
4508
|
+
"baseTransform": {
|
|
4509
|
+
"description": "With `base: \"media\"`: the media's own transform this one was made on. When the media's transform is no longer the same, clients ask to check the crop, and renderers clamp it.",
|
|
4510
|
+
"$ref": "#/components/schemas/MediaTransform"
|
|
4511
|
+
}
|
|
4512
|
+
},
|
|
4513
|
+
"additionalProperties": {},
|
|
4514
|
+
"description": "Non-destructive edits of an image, applied in this order: crop, then rotate, then flip. Renderers ignore the keys they don't know, which editor tools can add."
|
|
4515
|
+
},
|
|
4516
|
+
"StoredFile": {
|
|
4517
|
+
"type": "object",
|
|
4518
|
+
"properties": {
|
|
4519
|
+
"name": {
|
|
4520
|
+
"type": "string",
|
|
4521
|
+
"description": "The name of the file, as the user knows it."
|
|
4522
|
+
},
|
|
4523
|
+
"url": {
|
|
4524
|
+
"description": "Where to download it. A private file gets a temporary URL.",
|
|
4525
|
+
"type": [
|
|
4526
|
+
"string",
|
|
4527
|
+
"null"
|
|
4528
|
+
]
|
|
4529
|
+
},
|
|
4530
|
+
"mime": {
|
|
4531
|
+
"type": [
|
|
4532
|
+
"string",
|
|
4533
|
+
"null"
|
|
4534
|
+
]
|
|
4535
|
+
},
|
|
4536
|
+
"size": {
|
|
4537
|
+
"anyOf": [
|
|
4538
|
+
{
|
|
4539
|
+
"type": "integer",
|
|
4540
|
+
"minimum": 0,
|
|
4541
|
+
"maximum": 9007199254740991
|
|
4542
|
+
},
|
|
4543
|
+
{
|
|
4544
|
+
"type": "null"
|
|
4545
|
+
}
|
|
4546
|
+
]
|
|
4547
|
+
}
|
|
4548
|
+
},
|
|
4549
|
+
"required": [
|
|
4550
|
+
"name"
|
|
4551
|
+
],
|
|
4552
|
+
"additionalProperties": {},
|
|
4553
|
+
"description": "A file stored by the backend: the value of a `file` field in items. Requests send it back to keep the file, `{ \"upload\" }` to replace it, or `null` to remove it."
|
|
4554
|
+
},
|
|
4555
|
+
"UploadReference": {
|
|
4556
|
+
"type": "object",
|
|
4557
|
+
"properties": {
|
|
4558
|
+
"upload": {
|
|
4559
|
+
"type": "string",
|
|
4560
|
+
"minLength": 1
|
|
4561
|
+
}
|
|
4562
|
+
},
|
|
4563
|
+
"required": [
|
|
4564
|
+
"upload"
|
|
4565
|
+
],
|
|
4566
|
+
"additionalProperties": {},
|
|
4567
|
+
"description": "A file uploaded directly to storage, by the id of its upload: in a file value, such as the `file` of a media, or an action parameter."
|
|
4568
|
+
},
|
|
4569
|
+
"Upload": {
|
|
4570
|
+
"type": "object",
|
|
4571
|
+
"properties": {
|
|
4572
|
+
"id": {
|
|
4573
|
+
"type": "string",
|
|
4574
|
+
"minLength": 1,
|
|
4575
|
+
"description": "The id of the upload: `upl_…`."
|
|
4576
|
+
},
|
|
4577
|
+
"key": {
|
|
4578
|
+
"description": "The key of the object in storage.",
|
|
4579
|
+
"type": "string"
|
|
4580
|
+
},
|
|
4581
|
+
"name": {
|
|
4582
|
+
"type": "string"
|
|
4583
|
+
},
|
|
4584
|
+
"mime": {
|
|
4585
|
+
"type": "string"
|
|
4586
|
+
},
|
|
4587
|
+
"size": {
|
|
4588
|
+
"type": "integer",
|
|
4589
|
+
"minimum": 0,
|
|
4590
|
+
"maximum": 9007199254740991
|
|
4591
|
+
}
|
|
4592
|
+
},
|
|
4593
|
+
"required": [
|
|
4594
|
+
"id"
|
|
4595
|
+
],
|
|
4596
|
+
"additionalProperties": {},
|
|
4597
|
+
"description": "A file the browser uploaded to storage, before it becomes a media, an import or another value."
|
|
4598
|
+
},
|
|
4599
|
+
"UploadResponse": {
|
|
4600
|
+
"type": "object",
|
|
4601
|
+
"properties": {
|
|
4602
|
+
"data": {
|
|
4603
|
+
"$ref": "#/components/schemas/Upload"
|
|
4604
|
+
}
|
|
4605
|
+
},
|
|
4606
|
+
"required": [
|
|
4607
|
+
"data"
|
|
4608
|
+
],
|
|
4609
|
+
"additionalProperties": {}
|
|
4610
|
+
},
|
|
4611
|
+
"UploadSignRequest": {
|
|
4612
|
+
"type": "object",
|
|
4613
|
+
"properties": {
|
|
4614
|
+
"method": {
|
|
4615
|
+
"type": "string",
|
|
4616
|
+
"enum": [
|
|
4617
|
+
"GET",
|
|
4618
|
+
"POST",
|
|
4619
|
+
"PUT",
|
|
4620
|
+
"DELETE"
|
|
4621
|
+
]
|
|
4622
|
+
},
|
|
4623
|
+
"key": {
|
|
4624
|
+
"type": "string",
|
|
4625
|
+
"minLength": 1
|
|
4626
|
+
},
|
|
4627
|
+
"uploadId": {
|
|
4628
|
+
"description": "The S3 multipart upload.",
|
|
4629
|
+
"type": "string"
|
|
4630
|
+
},
|
|
4631
|
+
"partNumber": {
|
|
4632
|
+
"type": "integer",
|
|
4633
|
+
"exclusiveMinimum": 0,
|
|
4634
|
+
"maximum": 9007199254740991
|
|
4635
|
+
},
|
|
4636
|
+
"contentType": {
|
|
4637
|
+
"type": "string"
|
|
4638
|
+
},
|
|
4639
|
+
"expiresIn": {
|
|
4640
|
+
"type": "integer",
|
|
4641
|
+
"exclusiveMinimum": 0,
|
|
4642
|
+
"maximum": 9007199254740991
|
|
4643
|
+
}
|
|
4644
|
+
},
|
|
4645
|
+
"required": [
|
|
4646
|
+
"method",
|
|
4647
|
+
"key"
|
|
4648
|
+
],
|
|
4649
|
+
"additionalProperties": {},
|
|
4650
|
+
"description": "A request of the browser's S3 client to sign (Uppy 6's `signRequest`)."
|
|
4651
|
+
},
|
|
4652
|
+
"UploadSignResponse": {
|
|
4653
|
+
"type": "object",
|
|
4654
|
+
"properties": {
|
|
4655
|
+
"url": {
|
|
4656
|
+
"type": "string"
|
|
4657
|
+
},
|
|
4658
|
+
"key": {
|
|
4659
|
+
"description": "The key the backend chose, for the first request of a file.",
|
|
4660
|
+
"type": "string"
|
|
4661
|
+
},
|
|
4662
|
+
"headers": {
|
|
4663
|
+
"description": "Headers the URL was signed with, which the browser sends.",
|
|
4664
|
+
"type": "object",
|
|
4665
|
+
"propertyNames": {
|
|
4666
|
+
"type": "string"
|
|
4667
|
+
},
|
|
4668
|
+
"additionalProperties": {
|
|
4669
|
+
"type": "string"
|
|
4670
|
+
}
|
|
4671
|
+
},
|
|
4672
|
+
"upload": {
|
|
4673
|
+
"description": "The upload the first request of a file created: `upl_…`.",
|
|
4674
|
+
"type": "string"
|
|
4675
|
+
}
|
|
4676
|
+
},
|
|
4677
|
+
"required": [
|
|
4678
|
+
"url"
|
|
4679
|
+
],
|
|
4680
|
+
"additionalProperties": {},
|
|
4681
|
+
"description": "A presigned request."
|
|
4682
|
+
},
|
|
4683
|
+
"FieldCheckRequest": {
|
|
4684
|
+
"type": "object",
|
|
4685
|
+
"properties": {
|
|
4686
|
+
"value": {
|
|
4687
|
+
"type": "string",
|
|
4688
|
+
"description": "The value to check, as it is typed."
|
|
4689
|
+
},
|
|
4690
|
+
"locale": {
|
|
4691
|
+
"description": "The locale of the value, for a localized field.",
|
|
4692
|
+
"type": "string"
|
|
4693
|
+
},
|
|
4694
|
+
"id": {
|
|
4695
|
+
"description": "The item being edited, or null when creating one.",
|
|
3594
4696
|
"anyOf": [
|
|
3595
4697
|
{
|
|
3596
|
-
"
|
|
3597
|
-
"const": 0
|
|
3598
|
-
},
|
|
3599
|
-
{
|
|
3600
|
-
"type": "number",
|
|
3601
|
-
"const": 90
|
|
3602
|
-
},
|
|
3603
|
-
{
|
|
3604
|
-
"type": "number",
|
|
3605
|
-
"const": 180
|
|
4698
|
+
"$ref": "#/components/schemas/Id"
|
|
3606
4699
|
},
|
|
3607
4700
|
{
|
|
3608
|
-
"type": "
|
|
3609
|
-
"const": 270
|
|
4701
|
+
"type": "null"
|
|
3610
4702
|
}
|
|
3611
4703
|
]
|
|
3612
4704
|
},
|
|
3613
|
-
"
|
|
3614
|
-
"
|
|
3615
|
-
},
|
|
3616
|
-
"flipY": {
|
|
3617
|
-
"type": "boolean"
|
|
3618
|
-
},
|
|
3619
|
-
"focalPoint": {
|
|
3620
|
-
"description": "Relative to the width and height, from 0 to 1.",
|
|
4705
|
+
"values": {
|
|
4706
|
+
"description": "The form's current values, as they would be sent to save, for what the check depends on (a page's parent).",
|
|
3621
4707
|
"type": "object",
|
|
3622
|
-
"
|
|
3623
|
-
"
|
|
3624
|
-
"type": "number",
|
|
3625
|
-
"minimum": 0,
|
|
3626
|
-
"maximum": 1
|
|
3627
|
-
},
|
|
3628
|
-
"y": {
|
|
3629
|
-
"type": "number",
|
|
3630
|
-
"minimum": 0,
|
|
3631
|
-
"maximum": 1
|
|
3632
|
-
}
|
|
4708
|
+
"propertyNames": {
|
|
4709
|
+
"type": "string"
|
|
3633
4710
|
},
|
|
3634
|
-
"required": [
|
|
3635
|
-
"x",
|
|
3636
|
-
"y"
|
|
3637
|
-
],
|
|
3638
4711
|
"additionalProperties": {}
|
|
3639
4712
|
}
|
|
3640
4713
|
},
|
|
3641
|
-
"
|
|
4714
|
+
"required": [
|
|
4715
|
+
"value"
|
|
4716
|
+
],
|
|
4717
|
+
"additionalProperties": {},
|
|
4718
|
+
"description": "A value of a field with `check`, to check with the backend."
|
|
3642
4719
|
},
|
|
3643
|
-
"
|
|
4720
|
+
"FieldCheckResponse": {
|
|
3644
4721
|
"type": "object",
|
|
3645
4722
|
"properties": {
|
|
3646
|
-
"
|
|
3647
|
-
"
|
|
4723
|
+
"available": {
|
|
4724
|
+
"type": "boolean",
|
|
4725
|
+
"description": "Whether no other item of the resource, in its scope and the same locale, has the value."
|
|
3648
4726
|
},
|
|
3649
|
-
"
|
|
3650
|
-
"description": "
|
|
4727
|
+
"suggestion": {
|
|
4728
|
+
"description": "An available value close to the one checked, when it is taken.",
|
|
3651
4729
|
"type": [
|
|
3652
4730
|
"string",
|
|
3653
4731
|
"null"
|
|
3654
4732
|
]
|
|
3655
4733
|
},
|
|
3656
|
-
"
|
|
3657
|
-
"
|
|
4734
|
+
"prefix": {
|
|
4735
|
+
"description": "What the field shows in front of the value: the start of its URL.",
|
|
4736
|
+
"type": [
|
|
4737
|
+
"string",
|
|
4738
|
+
"null"
|
|
4739
|
+
]
|
|
4740
|
+
},
|
|
4741
|
+
"url": {
|
|
4742
|
+
"description": "The URL the value gives the item, which the field links to.",
|
|
4743
|
+
"type": [
|
|
4744
|
+
"string",
|
|
4745
|
+
"null"
|
|
4746
|
+
]
|
|
3658
4747
|
},
|
|
4748
|
+
"disabled": {
|
|
4749
|
+
"description": "The field doesn't apply to this item (the home page has no slug): the field is read-only.",
|
|
4750
|
+
"type": "boolean"
|
|
4751
|
+
}
|
|
4752
|
+
},
|
|
4753
|
+
"required": [
|
|
4754
|
+
"available"
|
|
4755
|
+
],
|
|
4756
|
+
"additionalProperties": {},
|
|
4757
|
+
"description": "What the backend says about a value: not authoritative, since saving still validates it."
|
|
4758
|
+
},
|
|
4759
|
+
"MediaInfo": {
|
|
4760
|
+
"type": "object",
|
|
4761
|
+
"properties": {
|
|
3659
4762
|
"type": {
|
|
3660
4763
|
"type": "string",
|
|
3661
|
-
"description": "`image`, `video`, `audio`, `document`, `font`, or another type."
|
|
3662
|
-
},
|
|
3663
|
-
"name": {
|
|
3664
|
-
"type": "string"
|
|
4764
|
+
"description": "`image`, `video`, `audio`, `document`, `font`, or another type the backend knows."
|
|
3665
4765
|
},
|
|
3666
4766
|
"mime": {
|
|
3667
|
-
"type":
|
|
4767
|
+
"type": [
|
|
4768
|
+
"string",
|
|
4769
|
+
"null"
|
|
4770
|
+
]
|
|
3668
4771
|
},
|
|
3669
4772
|
"size": {
|
|
3670
|
-
"
|
|
3671
|
-
|
|
3672
|
-
|
|
4773
|
+
"anyOf": [
|
|
4774
|
+
{
|
|
4775
|
+
"type": "integer",
|
|
4776
|
+
"minimum": 0,
|
|
4777
|
+
"maximum": 9007199254740991
|
|
4778
|
+
},
|
|
4779
|
+
{
|
|
4780
|
+
"type": "null"
|
|
4781
|
+
}
|
|
4782
|
+
]
|
|
3673
4783
|
},
|
|
3674
4784
|
"url": {
|
|
3675
|
-
"
|
|
4785
|
+
"description": "The main file to show or play: a rendition, or the original until it exists.",
|
|
4786
|
+
"type": [
|
|
4787
|
+
"string",
|
|
4788
|
+
"null"
|
|
4789
|
+
]
|
|
3676
4790
|
},
|
|
3677
4791
|
"thumbnailUrl": {
|
|
3678
4792
|
"type": [
|
|
@@ -3681,6 +4795,7 @@
|
|
|
3681
4795
|
]
|
|
3682
4796
|
},
|
|
3683
4797
|
"variants": {
|
|
4798
|
+
"description": "Named renditions: sizes of an image, qualities of a video.",
|
|
3684
4799
|
"type": "object",
|
|
3685
4800
|
"propertyNames": {
|
|
3686
4801
|
"type": "string"
|
|
@@ -3704,6 +4819,60 @@
|
|
|
3704
4819
|
"additionalProperties": {}
|
|
3705
4820
|
}
|
|
3706
4821
|
},
|
|
4822
|
+
"width": {
|
|
4823
|
+
"type": [
|
|
4824
|
+
"number",
|
|
4825
|
+
"null"
|
|
4826
|
+
]
|
|
4827
|
+
},
|
|
4828
|
+
"height": {
|
|
4829
|
+
"type": [
|
|
4830
|
+
"number",
|
|
4831
|
+
"null"
|
|
4832
|
+
]
|
|
4833
|
+
},
|
|
4834
|
+
"duration": {
|
|
4835
|
+
"description": "In seconds.",
|
|
4836
|
+
"type": [
|
|
4837
|
+
"number",
|
|
4838
|
+
"null"
|
|
4839
|
+
]
|
|
4840
|
+
},
|
|
4841
|
+
"status": {
|
|
4842
|
+
"description": "Where the processing of the file is: `pending` and `processing` until its renditions are made, then `ready` or `failed`. Without it, the media is ready.",
|
|
4843
|
+
"type": "string",
|
|
4844
|
+
"enum": [
|
|
4845
|
+
"pending",
|
|
4846
|
+
"processing",
|
|
4847
|
+
"ready",
|
|
4848
|
+
"failed"
|
|
4849
|
+
]
|
|
4850
|
+
},
|
|
4851
|
+
"error": {
|
|
4852
|
+
"description": "Why the processing failed, when `status` is `failed`, so that editors see it without the backend's monitoring.",
|
|
4853
|
+
"anyOf": [
|
|
4854
|
+
{
|
|
4855
|
+
"type": "object",
|
|
4856
|
+
"properties": {
|
|
4857
|
+
"code": {
|
|
4858
|
+
"type": "string",
|
|
4859
|
+
"description": "The code of the step that failed, such as a transcoder task code (`timeout`, `input_unreadable`)."
|
|
4860
|
+
},
|
|
4861
|
+
"message": {
|
|
4862
|
+
"description": "Why it failed, for people.",
|
|
4863
|
+
"type": "string"
|
|
4864
|
+
}
|
|
4865
|
+
},
|
|
4866
|
+
"required": [
|
|
4867
|
+
"code"
|
|
4868
|
+
],
|
|
4869
|
+
"additionalProperties": {}
|
|
4870
|
+
},
|
|
4871
|
+
{
|
|
4872
|
+
"type": "null"
|
|
4873
|
+
}
|
|
4874
|
+
]
|
|
4875
|
+
},
|
|
3707
4876
|
"metadata": {
|
|
3708
4877
|
"type": "object",
|
|
3709
4878
|
"propertyNames": {
|
|
@@ -3712,6 +4881,7 @@
|
|
|
3712
4881
|
"additionalProperties": {}
|
|
3713
4882
|
},
|
|
3714
4883
|
"transform": {
|
|
4884
|
+
"description": "The media's own transform, from its library, which clients need to draw a transform for one use made over it (decision 0031).",
|
|
3715
4885
|
"anyOf": [
|
|
3716
4886
|
{
|
|
3717
4887
|
"$ref": "#/components/schemas/MediaTransform"
|
|
@@ -3720,56 +4890,77 @@
|
|
|
3720
4890
|
"type": "null"
|
|
3721
4891
|
}
|
|
3722
4892
|
]
|
|
3723
|
-
},
|
|
3724
|
-
"tags": {
|
|
3725
|
-
"type": "array",
|
|
3726
|
-
"items": {
|
|
3727
|
-
"type": "string"
|
|
3728
|
-
}
|
|
3729
4893
|
}
|
|
3730
4894
|
},
|
|
3731
4895
|
"required": [
|
|
3732
|
-
"
|
|
3733
|
-
"version",
|
|
3734
|
-
"abilities",
|
|
3735
|
-
"type",
|
|
3736
|
-
"name",
|
|
3737
|
-
"mime",
|
|
3738
|
-
"size",
|
|
3739
|
-
"url"
|
|
4896
|
+
"type"
|
|
3740
4897
|
],
|
|
3741
|
-
"additionalProperties": {}
|
|
4898
|
+
"additionalProperties": {},
|
|
4899
|
+
"description": "What the backend computed about the file of a media item: the `media` of the items of a `media` resource, and of the values of `media` fields. Read-only: the editable properties of a media are the fields of its resource."
|
|
3742
4900
|
},
|
|
3743
|
-
"
|
|
4901
|
+
"MediaItem": {
|
|
3744
4902
|
"type": "object",
|
|
3745
4903
|
"properties": {
|
|
3746
|
-
"
|
|
3747
|
-
"$ref": "#/components/schemas/
|
|
4904
|
+
"id": {
|
|
4905
|
+
"$ref": "#/components/schemas/Id"
|
|
4906
|
+
},
|
|
4907
|
+
"version": {
|
|
4908
|
+
"description": "Changes on every update. `null` when the backend has no versions.",
|
|
4909
|
+
"type": [
|
|
4910
|
+
"string",
|
|
4911
|
+
"null"
|
|
4912
|
+
]
|
|
4913
|
+
},
|
|
4914
|
+
"abilities": {
|
|
4915
|
+
"$ref": "#/components/schemas/Abilities"
|
|
4916
|
+
},
|
|
4917
|
+
"media": {
|
|
4918
|
+
"$ref": "#/components/schemas/MediaInfo"
|
|
3748
4919
|
}
|
|
3749
4920
|
},
|
|
3750
4921
|
"required": [
|
|
3751
|
-
"
|
|
4922
|
+
"id",
|
|
4923
|
+
"version",
|
|
4924
|
+
"abilities",
|
|
4925
|
+
"media"
|
|
3752
4926
|
],
|
|
3753
|
-
"additionalProperties": {}
|
|
4927
|
+
"additionalProperties": {},
|
|
4928
|
+
"description": "An item of a resource of kind `media`: the values of its fields (`file`, the original, and those of the project), and the `media` the backend computed."
|
|
3754
4929
|
},
|
|
3755
|
-
"
|
|
4930
|
+
"MediaReference": {
|
|
3756
4931
|
"type": "object",
|
|
3757
4932
|
"properties": {
|
|
3758
|
-
"
|
|
3759
|
-
"
|
|
3760
|
-
"items": {
|
|
3761
|
-
"$ref": "#/components/schemas/Media"
|
|
3762
|
-
}
|
|
4933
|
+
"id": {
|
|
4934
|
+
"$ref": "#/components/schemas/Id"
|
|
3763
4935
|
},
|
|
3764
|
-
"
|
|
3765
|
-
"
|
|
4936
|
+
"resource": {
|
|
4937
|
+
"description": "The library of the media. Required for a field that allows several libraries, since ids are unique only within their resource (decision 0027).",
|
|
4938
|
+
"type": "string"
|
|
4939
|
+
},
|
|
4940
|
+
"label": {
|
|
4941
|
+
"description": "The `itemTitle` of the media.",
|
|
4942
|
+
"type": "string"
|
|
4943
|
+
},
|
|
4944
|
+
"media": {
|
|
4945
|
+
"$ref": "#/components/schemas/MediaInfo"
|
|
4946
|
+
},
|
|
4947
|
+
"transform": {
|
|
4948
|
+
"description": "The edits of the image for this use only: from the original file, or over the media's own transform with `base: \"media\"`.",
|
|
4949
|
+
"anyOf": [
|
|
4950
|
+
{
|
|
4951
|
+
"$ref": "#/components/schemas/MediaTransform"
|
|
4952
|
+
},
|
|
4953
|
+
{
|
|
4954
|
+
"type": "null"
|
|
4955
|
+
}
|
|
4956
|
+
]
|
|
3766
4957
|
}
|
|
3767
4958
|
},
|
|
3768
4959
|
"required": [
|
|
3769
|
-
"
|
|
3770
|
-
"meta"
|
|
4960
|
+
"id"
|
|
3771
4961
|
],
|
|
3772
|
-
"additionalProperties": {}
|
|
4962
|
+
"additionalProperties": {},
|
|
4963
|
+
"description": "The value of a `media` or `image` field in items: the media, with what lists and fields show, and its edits for this use. Requests send the id, or `{ id, resource, transform }`: `resource` is required when the field allows several libraries."
|
|
3773
4964
|
},
|
|
3774
4965
|
"Session": {
|
|
3775
4966
|
"type": "object",
|
|
@@ -3792,7 +4983,8 @@
|
|
|
3792
4983
|
"type": "object",
|
|
3793
4984
|
"properties": {
|
|
3794
4985
|
"resource": {
|
|
3795
|
-
"type": "string"
|
|
4986
|
+
"type": "string",
|
|
4987
|
+
"description": "The id of the resource."
|
|
3796
4988
|
},
|
|
3797
4989
|
"items": {
|
|
3798
4990
|
"type": "array",
|
|
@@ -3801,6 +4993,7 @@
|
|
|
3801
4993
|
}
|
|
3802
4994
|
},
|
|
3803
4995
|
"total": {
|
|
4996
|
+
"description": "How many items of the resource match, when the backend counts them: the list of the resource, searched, shows them all.",
|
|
3804
4997
|
"type": "integer",
|
|
3805
4998
|
"minimum": 0,
|
|
3806
4999
|
"maximum": 9007199254740991
|
|
@@ -3817,7 +5010,8 @@
|
|
|
3817
5010
|
"required": [
|
|
3818
5011
|
"data"
|
|
3819
5012
|
],
|
|
3820
|
-
"additionalProperties": {}
|
|
5013
|
+
"additionalProperties": {},
|
|
5014
|
+
"description": "The results of the global search: the resources with results, in the order of the definition."
|
|
3821
5015
|
},
|
|
3822
5016
|
"PreviewResponse": {
|
|
3823
5017
|
"type": "object",
|
|
@@ -3833,6 +5027,86 @@
|
|
|
3833
5027
|
"url"
|
|
3834
5028
|
],
|
|
3835
5029
|
"additionalProperties": {}
|
|
5030
|
+
},
|
|
5031
|
+
"EmbedValue": {
|
|
5032
|
+
"type": "object",
|
|
5033
|
+
"properties": {
|
|
5034
|
+
"url": {
|
|
5035
|
+
"type": "string",
|
|
5036
|
+
"description": "The URL of the video, sound or post."
|
|
5037
|
+
},
|
|
5038
|
+
"type": {
|
|
5039
|
+
"type": "string",
|
|
5040
|
+
"enum": [
|
|
5041
|
+
"video",
|
|
5042
|
+
"audio",
|
|
5043
|
+
"photo",
|
|
5044
|
+
"rich",
|
|
5045
|
+
"link"
|
|
5046
|
+
]
|
|
5047
|
+
},
|
|
5048
|
+
"title": {
|
|
5049
|
+
"type": "string"
|
|
5050
|
+
},
|
|
5051
|
+
"provider": {
|
|
5052
|
+
"description": "The name of the provider.",
|
|
5053
|
+
"type": "string"
|
|
5054
|
+
},
|
|
5055
|
+
"thumbnailUrl": {
|
|
5056
|
+
"type": "string"
|
|
5057
|
+
},
|
|
5058
|
+
"html": {
|
|
5059
|
+
"description": "The HTML that embeds it, from the oEmbed of its provider.",
|
|
5060
|
+
"type": "string"
|
|
5061
|
+
},
|
|
5062
|
+
"width": {
|
|
5063
|
+
"type": "number"
|
|
5064
|
+
},
|
|
5065
|
+
"height": {
|
|
5066
|
+
"type": "number"
|
|
5067
|
+
}
|
|
5068
|
+
},
|
|
5069
|
+
"required": [
|
|
5070
|
+
"url"
|
|
5071
|
+
],
|
|
5072
|
+
"additionalProperties": {},
|
|
5073
|
+
"description": "The value of an `embed` field: its URL, and what the backend got from its oEmbed."
|
|
5074
|
+
},
|
|
5075
|
+
"EmbedResponse": {
|
|
5076
|
+
"type": "object",
|
|
5077
|
+
"properties": {
|
|
5078
|
+
"data": {
|
|
5079
|
+
"$ref": "#/components/schemas/EmbedValue"
|
|
5080
|
+
}
|
|
5081
|
+
},
|
|
5082
|
+
"required": [
|
|
5083
|
+
"data"
|
|
5084
|
+
],
|
|
5085
|
+
"additionalProperties": {}
|
|
5086
|
+
},
|
|
5087
|
+
"LocationValue": {
|
|
5088
|
+
"type": "object",
|
|
5089
|
+
"properties": {
|
|
5090
|
+
"lat": {
|
|
5091
|
+
"type": "number",
|
|
5092
|
+
"minimum": -90,
|
|
5093
|
+
"maximum": 90
|
|
5094
|
+
},
|
|
5095
|
+
"lng": {
|
|
5096
|
+
"type": "number",
|
|
5097
|
+
"minimum": -180,
|
|
5098
|
+
"maximum": 180
|
|
5099
|
+
},
|
|
5100
|
+
"address": {
|
|
5101
|
+
"type": "string"
|
|
5102
|
+
}
|
|
5103
|
+
},
|
|
5104
|
+
"required": [
|
|
5105
|
+
"lat",
|
|
5106
|
+
"lng"
|
|
5107
|
+
],
|
|
5108
|
+
"additionalProperties": {},
|
|
5109
|
+
"description": "The value of a `location` field: a point, and its address."
|
|
3836
5110
|
}
|
|
3837
5111
|
}
|
|
3838
5112
|
}
|