@crowi/api-contract 2.0.0-alpha.10 → 2.0.0-alpha.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/openapi.d.mts +401 -47
- package/dist/generated/openapi.d.ts +401 -47
- package/dist/generated/openapi.js.map +1 -1
- package/dist/index.d.mts +1899 -179
- package/dist/index.d.ts +1899 -179
- package/dist/index.js +1390 -859
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1242 -754
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -729,6 +729,211 @@ interface paths {
|
|
|
729
729
|
patch?: never;
|
|
730
730
|
trace?: never;
|
|
731
731
|
};
|
|
732
|
+
"/invite/accept": {
|
|
733
|
+
parameters: {
|
|
734
|
+
query?: never;
|
|
735
|
+
header?: never;
|
|
736
|
+
path?: never;
|
|
737
|
+
cookie?: never;
|
|
738
|
+
};
|
|
739
|
+
/** Preview an invite (returns the invited email) for the acceptance page */
|
|
740
|
+
get: {
|
|
741
|
+
parameters: {
|
|
742
|
+
query: {
|
|
743
|
+
token: string;
|
|
744
|
+
};
|
|
745
|
+
header?: never;
|
|
746
|
+
path?: never;
|
|
747
|
+
cookie?: never;
|
|
748
|
+
};
|
|
749
|
+
requestBody?: never;
|
|
750
|
+
responses: {
|
|
751
|
+
/** @description Invite is valid */
|
|
752
|
+
200: {
|
|
753
|
+
headers: {
|
|
754
|
+
[name: string]: unknown;
|
|
755
|
+
};
|
|
756
|
+
content: {
|
|
757
|
+
"application/json": {
|
|
758
|
+
/** Format: email */
|
|
759
|
+
email: string;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
};
|
|
763
|
+
/** @description Invite token is invalid or expired */
|
|
764
|
+
401: {
|
|
765
|
+
headers: {
|
|
766
|
+
[name: string]: unknown;
|
|
767
|
+
};
|
|
768
|
+
content: {
|
|
769
|
+
"application/json": {
|
|
770
|
+
error: {
|
|
771
|
+
code: components["schemas"]["ErrorCode"];
|
|
772
|
+
message: string;
|
|
773
|
+
details?: unknown;
|
|
774
|
+
};
|
|
775
|
+
};
|
|
776
|
+
};
|
|
777
|
+
};
|
|
778
|
+
/** @description Invite already accepted */
|
|
779
|
+
409: {
|
|
780
|
+
headers: {
|
|
781
|
+
[name: string]: unknown;
|
|
782
|
+
};
|
|
783
|
+
content: {
|
|
784
|
+
"application/json": {
|
|
785
|
+
error: {
|
|
786
|
+
code: components["schemas"]["ErrorCode"];
|
|
787
|
+
message: string;
|
|
788
|
+
details?: unknown;
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
/** @description Internal server error */
|
|
794
|
+
500: {
|
|
795
|
+
headers: {
|
|
796
|
+
[name: string]: unknown;
|
|
797
|
+
};
|
|
798
|
+
content: {
|
|
799
|
+
"application/json": {
|
|
800
|
+
error: {
|
|
801
|
+
/** @enum {string} */
|
|
802
|
+
code: "INTERNAL_ERROR";
|
|
803
|
+
/** @enum {string} */
|
|
804
|
+
message: "Internal server error";
|
|
805
|
+
};
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
};
|
|
809
|
+
};
|
|
810
|
+
};
|
|
811
|
+
put?: never;
|
|
812
|
+
/** Accept an invite: set credentials, activate the account, sign in */
|
|
813
|
+
post: {
|
|
814
|
+
parameters: {
|
|
815
|
+
query?: never;
|
|
816
|
+
header?: never;
|
|
817
|
+
path?: never;
|
|
818
|
+
cookie?: never;
|
|
819
|
+
};
|
|
820
|
+
requestBody?: {
|
|
821
|
+
content: {
|
|
822
|
+
"application/json": {
|
|
823
|
+
token: string;
|
|
824
|
+
username: string;
|
|
825
|
+
name: string;
|
|
826
|
+
password: string;
|
|
827
|
+
};
|
|
828
|
+
};
|
|
829
|
+
};
|
|
830
|
+
responses: {
|
|
831
|
+
/** @description Invite accepted; account activated and signed in */
|
|
832
|
+
200: {
|
|
833
|
+
headers: {
|
|
834
|
+
[name: string]: unknown;
|
|
835
|
+
};
|
|
836
|
+
content: {
|
|
837
|
+
"application/json": {
|
|
838
|
+
accessToken: string;
|
|
839
|
+
refreshToken: string;
|
|
840
|
+
expiresIn: number;
|
|
841
|
+
user: {
|
|
842
|
+
id: string;
|
|
843
|
+
username: string;
|
|
844
|
+
/** Format: email */
|
|
845
|
+
email: string;
|
|
846
|
+
name: string;
|
|
847
|
+
image?: string;
|
|
848
|
+
admin?: boolean;
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
/** @description Validation failed */
|
|
854
|
+
400: {
|
|
855
|
+
headers: {
|
|
856
|
+
[name: string]: unknown;
|
|
857
|
+
};
|
|
858
|
+
content: {
|
|
859
|
+
"application/json": {
|
|
860
|
+
error: {
|
|
861
|
+
code: components["schemas"]["ErrorCode"];
|
|
862
|
+
message: string;
|
|
863
|
+
details?: unknown;
|
|
864
|
+
};
|
|
865
|
+
};
|
|
866
|
+
};
|
|
867
|
+
};
|
|
868
|
+
/** @description Invite token is invalid or expired */
|
|
869
|
+
401: {
|
|
870
|
+
headers: {
|
|
871
|
+
[name: string]: unknown;
|
|
872
|
+
};
|
|
873
|
+
content: {
|
|
874
|
+
"application/json": {
|
|
875
|
+
error: {
|
|
876
|
+
code: components["schemas"]["ErrorCode"];
|
|
877
|
+
message: string;
|
|
878
|
+
details?: unknown;
|
|
879
|
+
};
|
|
880
|
+
};
|
|
881
|
+
};
|
|
882
|
+
};
|
|
883
|
+
/** @description Invited user no longer exists */
|
|
884
|
+
404: {
|
|
885
|
+
headers: {
|
|
886
|
+
[name: string]: unknown;
|
|
887
|
+
};
|
|
888
|
+
content: {
|
|
889
|
+
"application/json": {
|
|
890
|
+
error: {
|
|
891
|
+
code: components["schemas"]["ErrorCode"];
|
|
892
|
+
message: string;
|
|
893
|
+
details?: unknown;
|
|
894
|
+
};
|
|
895
|
+
};
|
|
896
|
+
};
|
|
897
|
+
};
|
|
898
|
+
/** @description Invite already accepted, or username already taken */
|
|
899
|
+
409: {
|
|
900
|
+
headers: {
|
|
901
|
+
[name: string]: unknown;
|
|
902
|
+
};
|
|
903
|
+
content: {
|
|
904
|
+
"application/json": {
|
|
905
|
+
error: {
|
|
906
|
+
code: components["schemas"]["ErrorCode"];
|
|
907
|
+
message: string;
|
|
908
|
+
details?: unknown;
|
|
909
|
+
};
|
|
910
|
+
};
|
|
911
|
+
};
|
|
912
|
+
};
|
|
913
|
+
/** @description Internal server error */
|
|
914
|
+
500: {
|
|
915
|
+
headers: {
|
|
916
|
+
[name: string]: unknown;
|
|
917
|
+
};
|
|
918
|
+
content: {
|
|
919
|
+
"application/json": {
|
|
920
|
+
error: {
|
|
921
|
+
/** @enum {string} */
|
|
922
|
+
code: "INTERNAL_ERROR";
|
|
923
|
+
/** @enum {string} */
|
|
924
|
+
message: "Internal server error";
|
|
925
|
+
};
|
|
926
|
+
};
|
|
927
|
+
};
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
};
|
|
931
|
+
delete?: never;
|
|
932
|
+
options?: never;
|
|
933
|
+
head?: never;
|
|
934
|
+
patch?: never;
|
|
935
|
+
trace?: never;
|
|
936
|
+
};
|
|
732
937
|
"/me": {
|
|
733
938
|
parameters: {
|
|
734
939
|
query?: never;
|
|
@@ -1234,7 +1439,8 @@ interface paths {
|
|
|
1234
1439
|
codeBlockLanguages?: string[];
|
|
1235
1440
|
rawSpaceLinks?: string[];
|
|
1236
1441
|
};
|
|
1237
|
-
renderedAst?:
|
|
1442
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
1443
|
+
renderedAstArtifactKey?: string;
|
|
1238
1444
|
rendererVersion?: string;
|
|
1239
1445
|
parentRevisionId?: string | null;
|
|
1240
1446
|
/** @enum {string} */
|
|
@@ -2235,7 +2441,7 @@ interface paths {
|
|
|
2235
2441
|
};
|
|
2236
2442
|
requestBody?: never;
|
|
2237
2443
|
responses: {
|
|
2238
|
-
/** @description User profile with statistics + recent activity */
|
|
2444
|
+
/** @description User profile with statistics (createdPagesCount, bookmarksCount, likesCount, commentsCount — the last two are the target user's OWN likes/comments, not activity their pages received) + recent activity */
|
|
2239
2445
|
200: {
|
|
2240
2446
|
headers: {
|
|
2241
2447
|
[name: string]: unknown;
|
|
@@ -2258,6 +2464,8 @@ interface paths {
|
|
|
2258
2464
|
};
|
|
2259
2465
|
createdPagesCount: number;
|
|
2260
2466
|
bookmarksCount: number;
|
|
2467
|
+
likesCount: number;
|
|
2468
|
+
commentsCount: number;
|
|
2261
2469
|
recentPages?: {
|
|
2262
2470
|
_id: string;
|
|
2263
2471
|
path: string;
|
|
@@ -2295,7 +2503,8 @@ interface paths {
|
|
|
2295
2503
|
codeBlockLanguages?: string[];
|
|
2296
2504
|
rawSpaceLinks?: string[];
|
|
2297
2505
|
};
|
|
2298
|
-
renderedAst?:
|
|
2506
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
2507
|
+
renderedAstArtifactKey?: string;
|
|
2299
2508
|
rendererVersion?: string;
|
|
2300
2509
|
parentRevisionId?: string | null;
|
|
2301
2510
|
/** @enum {string} */
|
|
@@ -2402,7 +2611,8 @@ interface paths {
|
|
|
2402
2611
|
codeBlockLanguages?: string[];
|
|
2403
2612
|
rawSpaceLinks?: string[];
|
|
2404
2613
|
};
|
|
2405
|
-
renderedAst?:
|
|
2614
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
2615
|
+
renderedAstArtifactKey?: string;
|
|
2406
2616
|
rendererVersion?: string;
|
|
2407
2617
|
parentRevisionId?: string | null;
|
|
2408
2618
|
/** @enum {string} */
|
|
@@ -2616,7 +2826,8 @@ interface paths {
|
|
|
2616
2826
|
codeBlockLanguages?: string[];
|
|
2617
2827
|
rawSpaceLinks?: string[];
|
|
2618
2828
|
};
|
|
2619
|
-
renderedAst?:
|
|
2829
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
2830
|
+
renderedAstArtifactKey?: string;
|
|
2620
2831
|
rendererVersion?: string;
|
|
2621
2832
|
parentRevisionId?: string | null;
|
|
2622
2833
|
/** @enum {string} */
|
|
@@ -2834,7 +3045,8 @@ interface paths {
|
|
|
2834
3045
|
codeBlockLanguages?: string[];
|
|
2835
3046
|
rawSpaceLinks?: string[];
|
|
2836
3047
|
};
|
|
2837
|
-
renderedAst?:
|
|
3048
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
3049
|
+
renderedAstArtifactKey?: string;
|
|
2838
3050
|
rendererVersion?: string;
|
|
2839
3051
|
parentRevisionId?: string | null;
|
|
2840
3052
|
/** @enum {string} */
|
|
@@ -3036,7 +3248,8 @@ interface paths {
|
|
|
3036
3248
|
codeBlockLanguages?: string[];
|
|
3037
3249
|
rawSpaceLinks?: string[];
|
|
3038
3250
|
};
|
|
3039
|
-
renderedAst?:
|
|
3251
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
3252
|
+
renderedAstArtifactKey?: string;
|
|
3040
3253
|
rendererVersion?: string;
|
|
3041
3254
|
parentRevisionId?: string | null;
|
|
3042
3255
|
/** @enum {string} */
|
|
@@ -3362,7 +3575,8 @@ interface paths {
|
|
|
3362
3575
|
codeBlockLanguages?: string[];
|
|
3363
3576
|
rawSpaceLinks?: string[];
|
|
3364
3577
|
};
|
|
3365
|
-
renderedAst?:
|
|
3578
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
3579
|
+
renderedAstArtifactKey?: string;
|
|
3366
3580
|
rendererVersion?: string;
|
|
3367
3581
|
parentRevisionId?: string | null;
|
|
3368
3582
|
/** @enum {string} */
|
|
@@ -3562,7 +3776,8 @@ interface paths {
|
|
|
3562
3776
|
codeBlockLanguages?: string[];
|
|
3563
3777
|
rawSpaceLinks?: string[];
|
|
3564
3778
|
};
|
|
3565
|
-
renderedAst?:
|
|
3779
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
3780
|
+
renderedAstArtifactKey?: string;
|
|
3566
3781
|
rendererVersion?: string;
|
|
3567
3782
|
parentRevisionId?: string | null;
|
|
3568
3783
|
/** @enum {string} */
|
|
@@ -3848,7 +4063,8 @@ interface paths {
|
|
|
3848
4063
|
codeBlockLanguages?: string[];
|
|
3849
4064
|
rawSpaceLinks?: string[];
|
|
3850
4065
|
};
|
|
3851
|
-
renderedAst?:
|
|
4066
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
4067
|
+
renderedAstArtifactKey?: string;
|
|
3852
4068
|
rendererVersion?: string;
|
|
3853
4069
|
parentRevisionId?: string | null;
|
|
3854
4070
|
/** @enum {string} */
|
|
@@ -4591,7 +4807,8 @@ interface paths {
|
|
|
4591
4807
|
codeBlockLanguages?: string[];
|
|
4592
4808
|
rawSpaceLinks?: string[];
|
|
4593
4809
|
};
|
|
4594
|
-
renderedAst?:
|
|
4810
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
4811
|
+
renderedAstArtifactKey?: string;
|
|
4595
4812
|
rendererVersion?: string;
|
|
4596
4813
|
parentRevisionId?: string | null;
|
|
4597
4814
|
/** @enum {string} */
|
|
@@ -4700,7 +4917,7 @@ interface paths {
|
|
|
4700
4917
|
};
|
|
4701
4918
|
requestBody?: never;
|
|
4702
4919
|
responses: {
|
|
4703
|
-
/** @description Full revision document */
|
|
4920
|
+
/** @description Full revision document. `renderedAst` shape is content-negotiated via the `X-Crowi-Ast-Version` request header (RFC-0023): requests declaring `X-Crowi-Ast-Version: 1` receive the typed `{astVersion, root}` envelope; all other requests receive the stored bare mdast Root verbatim. The response varies on this header (`Vary: X-Crowi-Ast-Version`). */
|
|
4704
4921
|
200: {
|
|
4705
4922
|
headers: {
|
|
4706
4923
|
[name: string]: unknown;
|
|
@@ -4741,7 +4958,8 @@ interface paths {
|
|
|
4741
4958
|
codeBlockLanguages?: string[];
|
|
4742
4959
|
rawSpaceLinks?: string[];
|
|
4743
4960
|
};
|
|
4744
|
-
renderedAst?:
|
|
4961
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
4962
|
+
renderedAstArtifactKey?: string;
|
|
4745
4963
|
rendererVersion?: string;
|
|
4746
4964
|
parentRevisionId?: string | null;
|
|
4747
4965
|
/** @enum {string} */
|
|
@@ -4852,7 +5070,7 @@ interface paths {
|
|
|
4852
5070
|
};
|
|
4853
5071
|
requestBody?: never;
|
|
4854
5072
|
responses: {
|
|
4855
|
-
/** @description The requested page with populated revision */
|
|
5073
|
+
/** @description The requested page with populated revision. `revision.renderedAst` shape is content-negotiated via the `X-Crowi-Ast-Version` request header (RFC-0023): requests declaring `X-Crowi-Ast-Version: 1` receive the typed `{astVersion, root}` envelope; all other requests receive the stored bare mdast Root verbatim. The response varies on this header (`Vary: X-Crowi-Ast-Version`). */
|
|
4856
5074
|
200: {
|
|
4857
5075
|
headers: {
|
|
4858
5076
|
[name: string]: unknown;
|
|
@@ -4896,7 +5114,8 @@ interface paths {
|
|
|
4896
5114
|
codeBlockLanguages?: string[];
|
|
4897
5115
|
rawSpaceLinks?: string[];
|
|
4898
5116
|
};
|
|
4899
|
-
renderedAst?:
|
|
5117
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
5118
|
+
renderedAstArtifactKey?: string;
|
|
4900
5119
|
rendererVersion?: string;
|
|
4901
5120
|
parentRevisionId?: string | null;
|
|
4902
5121
|
/** @enum {string} */
|
|
@@ -5097,7 +5316,8 @@ interface paths {
|
|
|
5097
5316
|
codeBlockLanguages?: string[];
|
|
5098
5317
|
rawSpaceLinks?: string[];
|
|
5099
5318
|
};
|
|
5100
|
-
renderedAst?:
|
|
5319
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
5320
|
+
renderedAstArtifactKey?: string;
|
|
5101
5321
|
rendererVersion?: string;
|
|
5102
5322
|
parentRevisionId?: string | null;
|
|
5103
5323
|
/** @enum {string} */
|
|
@@ -5294,7 +5514,8 @@ interface paths {
|
|
|
5294
5514
|
codeBlockLanguages?: string[];
|
|
5295
5515
|
rawSpaceLinks?: string[];
|
|
5296
5516
|
};
|
|
5297
|
-
renderedAst?:
|
|
5517
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
5518
|
+
renderedAstArtifactKey?: string;
|
|
5298
5519
|
rendererVersion?: string;
|
|
5299
5520
|
parentRevisionId?: string | null;
|
|
5300
5521
|
/** @enum {string} */
|
|
@@ -5460,7 +5681,8 @@ interface paths {
|
|
|
5460
5681
|
codeBlockLanguages?: string[];
|
|
5461
5682
|
rawSpaceLinks?: string[];
|
|
5462
5683
|
};
|
|
5463
|
-
renderedAst?:
|
|
5684
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
5685
|
+
renderedAstArtifactKey?: string;
|
|
5464
5686
|
rendererVersion?: string;
|
|
5465
5687
|
parentRevisionId?: string | null;
|
|
5466
5688
|
/** @enum {string} */
|
|
@@ -5626,7 +5848,7 @@ interface paths {
|
|
|
5626
5848
|
};
|
|
5627
5849
|
requestBody?: never;
|
|
5628
5850
|
responses: {
|
|
5629
|
-
/** @description Page list (newest first) with optional portal page */
|
|
5851
|
+
/** @description Page list (newest first) with optional portal page and an accurate `total` (the full, unpaginated count of the same viewer-visible set `pages` is a page of). The portal document is the only row carrying `revision.renderedAst`; its shape is content-negotiated via the `X-Crowi-Ast-Version` request header (RFC-0023, same semantics as GET /pages). The response varies on this header (`Vary: X-Crowi-Ast-Version`). */
|
|
5630
5852
|
200: {
|
|
5631
5853
|
headers: {
|
|
5632
5854
|
[name: string]: unknown;
|
|
@@ -5670,7 +5892,8 @@ interface paths {
|
|
|
5670
5892
|
codeBlockLanguages?: string[];
|
|
5671
5893
|
rawSpaceLinks?: string[];
|
|
5672
5894
|
};
|
|
5673
|
-
renderedAst?:
|
|
5895
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
5896
|
+
renderedAstArtifactKey?: string;
|
|
5674
5897
|
rendererVersion?: string;
|
|
5675
5898
|
parentRevisionId?: string | null;
|
|
5676
5899
|
/** @enum {string} */
|
|
@@ -5780,7 +6003,8 @@ interface paths {
|
|
|
5780
6003
|
codeBlockLanguages?: string[];
|
|
5781
6004
|
rawSpaceLinks?: string[];
|
|
5782
6005
|
};
|
|
5783
|
-
renderedAst?:
|
|
6006
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
6007
|
+
renderedAstArtifactKey?: string;
|
|
5784
6008
|
rendererVersion?: string;
|
|
5785
6009
|
parentRevisionId?: string | null;
|
|
5786
6010
|
/** @enum {string} */
|
|
@@ -5885,7 +6109,8 @@ interface paths {
|
|
|
5885
6109
|
codeBlockLanguages?: string[];
|
|
5886
6110
|
rawSpaceLinks?: string[];
|
|
5887
6111
|
};
|
|
5888
|
-
renderedAst?:
|
|
6112
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
6113
|
+
renderedAstArtifactKey?: string;
|
|
5889
6114
|
rendererVersion?: string;
|
|
5890
6115
|
parentRevisionId?: string | null;
|
|
5891
6116
|
/** @enum {string} */
|
|
@@ -5953,6 +6178,7 @@ interface paths {
|
|
|
5953
6178
|
likerCount?: number;
|
|
5954
6179
|
seenUsersCount?: number;
|
|
5955
6180
|
} | null;
|
|
6181
|
+
total: number;
|
|
5956
6182
|
};
|
|
5957
6183
|
};
|
|
5958
6184
|
};
|
|
@@ -6126,7 +6352,8 @@ interface paths {
|
|
|
6126
6352
|
codeBlockLanguages?: string[];
|
|
6127
6353
|
rawSpaceLinks?: string[];
|
|
6128
6354
|
};
|
|
6129
|
-
renderedAst?:
|
|
6355
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
6356
|
+
renderedAstArtifactKey?: string;
|
|
6130
6357
|
rendererVersion?: string;
|
|
6131
6358
|
parentRevisionId?: string | null;
|
|
6132
6359
|
/** @enum {string} */
|
|
@@ -6531,7 +6758,8 @@ interface paths {
|
|
|
6531
6758
|
codeBlockLanguages?: string[];
|
|
6532
6759
|
rawSpaceLinks?: string[];
|
|
6533
6760
|
};
|
|
6534
|
-
renderedAst?:
|
|
6761
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
6762
|
+
renderedAstArtifactKey?: string;
|
|
6535
6763
|
rendererVersion?: string;
|
|
6536
6764
|
parentRevisionId?: string | null;
|
|
6537
6765
|
/** @enum {string} */
|
|
@@ -6727,7 +6955,8 @@ interface paths {
|
|
|
6727
6955
|
codeBlockLanguages?: string[];
|
|
6728
6956
|
rawSpaceLinks?: string[];
|
|
6729
6957
|
};
|
|
6730
|
-
renderedAst?:
|
|
6958
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
6959
|
+
renderedAstArtifactKey?: string;
|
|
6731
6960
|
rendererVersion?: string;
|
|
6732
6961
|
parentRevisionId?: string | null;
|
|
6733
6962
|
/** @enum {string} */
|
|
@@ -6923,7 +7152,8 @@ interface paths {
|
|
|
6923
7152
|
codeBlockLanguages?: string[];
|
|
6924
7153
|
rawSpaceLinks?: string[];
|
|
6925
7154
|
};
|
|
6926
|
-
renderedAst?:
|
|
7155
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
7156
|
+
renderedAstArtifactKey?: string;
|
|
6927
7157
|
rendererVersion?: string;
|
|
6928
7158
|
parentRevisionId?: string | null;
|
|
6929
7159
|
/** @enum {string} */
|
|
@@ -7324,7 +7554,8 @@ interface paths {
|
|
|
7324
7554
|
codeBlockLanguages?: string[];
|
|
7325
7555
|
rawSpaceLinks?: string[];
|
|
7326
7556
|
};
|
|
7327
|
-
renderedAst?:
|
|
7557
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
7558
|
+
renderedAstArtifactKey?: string;
|
|
7328
7559
|
rendererVersion?: string;
|
|
7329
7560
|
parentRevisionId?: string | null;
|
|
7330
7561
|
/** @enum {string} */
|
|
@@ -7520,7 +7751,8 @@ interface paths {
|
|
|
7520
7751
|
codeBlockLanguages?: string[];
|
|
7521
7752
|
rawSpaceLinks?: string[];
|
|
7522
7753
|
};
|
|
7523
|
-
renderedAst?:
|
|
7754
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
7755
|
+
renderedAstArtifactKey?: string;
|
|
7524
7756
|
rendererVersion?: string;
|
|
7525
7757
|
parentRevisionId?: string | null;
|
|
7526
7758
|
/** @enum {string} */
|
|
@@ -7719,7 +7951,8 @@ interface paths {
|
|
|
7719
7951
|
codeBlockLanguages?: string[];
|
|
7720
7952
|
rawSpaceLinks?: string[];
|
|
7721
7953
|
};
|
|
7722
|
-
renderedAst?:
|
|
7954
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
7955
|
+
renderedAstArtifactKey?: string;
|
|
7723
7956
|
rendererVersion?: string;
|
|
7724
7957
|
parentRevisionId?: string | null;
|
|
7725
7958
|
/** @enum {string} */
|
|
@@ -7985,14 +8218,15 @@ interface paths {
|
|
|
7985
8218
|
};
|
|
7986
8219
|
};
|
|
7987
8220
|
responses: {
|
|
7988
|
-
/** @description Rendered mdast tree (serialised — same shape as a persisted revision.renderedAst) */
|
|
8221
|
+
/** @description Rendered mdast tree (serialised — same shape as a persisted revision.renderedAst). Content-negotiated via the `X-Crowi-Ast-Version` request header (RFC-0023): requests declaring `X-Crowi-Ast-Version: 1` receive the typed `{astVersion, root}` envelope; all other requests receive the bare mdast Root. The response varies on this header (`Vary: X-Crowi-Ast-Version`). */
|
|
7989
8222
|
200: {
|
|
7990
8223
|
headers: {
|
|
7991
8224
|
[name: string]: unknown;
|
|
7992
8225
|
};
|
|
7993
8226
|
content: {
|
|
7994
8227
|
"application/json": {
|
|
7995
|
-
renderedAst?:
|
|
8228
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
8229
|
+
renderedAstArtifactKey?: string;
|
|
7996
8230
|
};
|
|
7997
8231
|
};
|
|
7998
8232
|
};
|
|
@@ -9212,6 +9446,21 @@ interface paths {
|
|
|
9212
9446
|
};
|
|
9213
9447
|
};
|
|
9214
9448
|
};
|
|
9449
|
+
/** @description MIME type not in the unified upload allow-list (feature-attachment-upload-policy) */
|
|
9450
|
+
415: {
|
|
9451
|
+
headers: {
|
|
9452
|
+
[name: string]: unknown;
|
|
9453
|
+
};
|
|
9454
|
+
content: {
|
|
9455
|
+
"application/json": {
|
|
9456
|
+
error: {
|
|
9457
|
+
/** @enum {string} */
|
|
9458
|
+
code: "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "FILE_MISSING" | "FILE_TOO_LARGE" | "DISALLOWED_MIME" | "INVALID_ATTACHMENT_ID" | "ATTACHMENT_NOT_FOUND" | "FORBIDDEN_FOR_DELETE" | "UPLOAD_FAILED" | "REMOVE_FAILED";
|
|
9459
|
+
message: string;
|
|
9460
|
+
};
|
|
9461
|
+
};
|
|
9462
|
+
};
|
|
9463
|
+
};
|
|
9215
9464
|
/** @description Upload / storage failure */
|
|
9216
9465
|
500: {
|
|
9217
9466
|
headers: {
|
|
@@ -9286,7 +9535,7 @@ interface paths {
|
|
|
9286
9535
|
content: {
|
|
9287
9536
|
"application/json": {
|
|
9288
9537
|
/** @enum {string} */
|
|
9289
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
9538
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
9290
9539
|
message: string;
|
|
9291
9540
|
details?: {
|
|
9292
9541
|
[key: string]: unknown;
|
|
@@ -9319,7 +9568,7 @@ interface paths {
|
|
|
9319
9568
|
content: {
|
|
9320
9569
|
"application/json": {
|
|
9321
9570
|
/** @enum {string} */
|
|
9322
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
9571
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
9323
9572
|
message: string;
|
|
9324
9573
|
details?: {
|
|
9325
9574
|
[key: string]: unknown;
|
|
@@ -9335,7 +9584,7 @@ interface paths {
|
|
|
9335
9584
|
content: {
|
|
9336
9585
|
"application/json": {
|
|
9337
9586
|
/** @enum {string} */
|
|
9338
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
9587
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
9339
9588
|
message: string;
|
|
9340
9589
|
details?: {
|
|
9341
9590
|
[key: string]: unknown;
|
|
@@ -9343,7 +9592,7 @@ interface paths {
|
|
|
9343
9592
|
};
|
|
9344
9593
|
};
|
|
9345
9594
|
};
|
|
9346
|
-
/** @description MIME type not in the
|
|
9595
|
+
/** @description MIME type not in the unified upload allow-list (feature-attachment-upload-policy) */
|
|
9347
9596
|
415: {
|
|
9348
9597
|
headers: {
|
|
9349
9598
|
[name: string]: unknown;
|
|
@@ -9351,7 +9600,7 @@ interface paths {
|
|
|
9351
9600
|
content: {
|
|
9352
9601
|
"application/json": {
|
|
9353
9602
|
/** @enum {string} */
|
|
9354
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
9603
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
9355
9604
|
message: string;
|
|
9356
9605
|
details?: {
|
|
9357
9606
|
[key: string]: unknown;
|
|
@@ -9367,7 +9616,7 @@ interface paths {
|
|
|
9367
9616
|
content: {
|
|
9368
9617
|
"application/json": {
|
|
9369
9618
|
/** @enum {string} */
|
|
9370
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
9619
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
9371
9620
|
message: string;
|
|
9372
9621
|
details?: {
|
|
9373
9622
|
[key: string]: unknown;
|
|
@@ -9723,7 +9972,8 @@ interface paths {
|
|
|
9723
9972
|
codeBlockLanguages?: string[];
|
|
9724
9973
|
rawSpaceLinks?: string[];
|
|
9725
9974
|
};
|
|
9726
|
-
renderedAst?:
|
|
9975
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
9976
|
+
renderedAstArtifactKey?: string;
|
|
9727
9977
|
rendererVersion?: string;
|
|
9728
9978
|
parentRevisionId?: string | null;
|
|
9729
9979
|
/** @enum {string} */
|
|
@@ -13127,6 +13377,91 @@ interface paths {
|
|
|
13127
13377
|
patch?: never;
|
|
13128
13378
|
trace?: never;
|
|
13129
13379
|
};
|
|
13380
|
+
"/admin/plugins/readiness": {
|
|
13381
|
+
parameters: {
|
|
13382
|
+
query?: never;
|
|
13383
|
+
header?: never;
|
|
13384
|
+
path?: never;
|
|
13385
|
+
cookie?: never;
|
|
13386
|
+
};
|
|
13387
|
+
/** List active plugins missing required readiness config fields */
|
|
13388
|
+
get: {
|
|
13389
|
+
parameters: {
|
|
13390
|
+
query?: never;
|
|
13391
|
+
header?: never;
|
|
13392
|
+
path?: never;
|
|
13393
|
+
cookie?: never;
|
|
13394
|
+
};
|
|
13395
|
+
requestBody?: never;
|
|
13396
|
+
responses: {
|
|
13397
|
+
/** @description Readiness issues for active plugins (empty when everything is configured) */
|
|
13398
|
+
200: {
|
|
13399
|
+
headers: {
|
|
13400
|
+
[name: string]: unknown;
|
|
13401
|
+
};
|
|
13402
|
+
content: {
|
|
13403
|
+
"application/json": {
|
|
13404
|
+
issues: {
|
|
13405
|
+
name: string;
|
|
13406
|
+
adminPlacement: {
|
|
13407
|
+
/** @enum {string} */
|
|
13408
|
+
section: "settings" | "shared" | "storage" | "mail" | "notification" | "auth" | "search" | "renderer" | "platform";
|
|
13409
|
+
label: string;
|
|
13410
|
+
icon?: string;
|
|
13411
|
+
};
|
|
13412
|
+
fields: {
|
|
13413
|
+
name: string;
|
|
13414
|
+
/** @enum {boolean} */
|
|
13415
|
+
configured: false;
|
|
13416
|
+
}[];
|
|
13417
|
+
}[];
|
|
13418
|
+
};
|
|
13419
|
+
};
|
|
13420
|
+
};
|
|
13421
|
+
/** @description Authentication required */
|
|
13422
|
+
401: {
|
|
13423
|
+
headers: {
|
|
13424
|
+
[name: string]: unknown;
|
|
13425
|
+
};
|
|
13426
|
+
content: {
|
|
13427
|
+
"application/json": {
|
|
13428
|
+
error: {
|
|
13429
|
+
/** @enum {string} */
|
|
13430
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
13431
|
+
/** @enum {string} */
|
|
13432
|
+
message: "Authentication is required";
|
|
13433
|
+
redirectTo?: string;
|
|
13434
|
+
};
|
|
13435
|
+
};
|
|
13436
|
+
};
|
|
13437
|
+
};
|
|
13438
|
+
/** @description Admin permission required */
|
|
13439
|
+
403: {
|
|
13440
|
+
headers: {
|
|
13441
|
+
[name: string]: unknown;
|
|
13442
|
+
};
|
|
13443
|
+
content: {
|
|
13444
|
+
"application/json": {
|
|
13445
|
+
error: {
|
|
13446
|
+
/** @enum {string} */
|
|
13447
|
+
code: "ADMIN_REQUIRED";
|
|
13448
|
+
/** @enum {string} */
|
|
13449
|
+
message: "Admin permission required";
|
|
13450
|
+
redirectTo?: string;
|
|
13451
|
+
};
|
|
13452
|
+
};
|
|
13453
|
+
};
|
|
13454
|
+
};
|
|
13455
|
+
};
|
|
13456
|
+
};
|
|
13457
|
+
put?: never;
|
|
13458
|
+
post?: never;
|
|
13459
|
+
delete?: never;
|
|
13460
|
+
options?: never;
|
|
13461
|
+
head?: never;
|
|
13462
|
+
patch?: never;
|
|
13463
|
+
trace?: never;
|
|
13464
|
+
};
|
|
13130
13465
|
"/admin/plugins/render-cache/clear-all": {
|
|
13131
13466
|
parameters: {
|
|
13132
13467
|
query?: never;
|
|
@@ -14053,7 +14388,8 @@ interface components {
|
|
|
14053
14388
|
codeBlockLanguages?: string[];
|
|
14054
14389
|
rawSpaceLinks?: string[];
|
|
14055
14390
|
};
|
|
14056
|
-
renderedAst?:
|
|
14391
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14392
|
+
renderedAstArtifactKey?: string;
|
|
14057
14393
|
rendererVersion?: string;
|
|
14058
14394
|
parentRevisionId?: string | null;
|
|
14059
14395
|
/** @enum {string} */
|
|
@@ -14121,6 +14457,16 @@ interface components {
|
|
|
14121
14457
|
likerCount?: number;
|
|
14122
14458
|
seenUsersCount?: number;
|
|
14123
14459
|
};
|
|
14460
|
+
RenderedAstEnvelope: {
|
|
14461
|
+
/** @enum {number} */
|
|
14462
|
+
astVersion: 1;
|
|
14463
|
+
root?: unknown;
|
|
14464
|
+
};
|
|
14465
|
+
LegacyRenderedAstRoot: {
|
|
14466
|
+
/** @enum {string} */
|
|
14467
|
+
type: "root";
|
|
14468
|
+
children: unknown[];
|
|
14469
|
+
};
|
|
14124
14470
|
PageWithRevision: {
|
|
14125
14471
|
_id: string;
|
|
14126
14472
|
path: string;
|
|
@@ -14158,7 +14504,8 @@ interface components {
|
|
|
14158
14504
|
codeBlockLanguages?: string[];
|
|
14159
14505
|
rawSpaceLinks?: string[];
|
|
14160
14506
|
};
|
|
14161
|
-
renderedAst?:
|
|
14507
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14508
|
+
renderedAstArtifactKey?: string;
|
|
14162
14509
|
rendererVersion?: string;
|
|
14163
14510
|
parentRevisionId?: string | null;
|
|
14164
14511
|
/** @enum {string} */
|
|
@@ -14260,7 +14607,8 @@ interface components {
|
|
|
14260
14607
|
codeBlockLanguages?: string[];
|
|
14261
14608
|
rawSpaceLinks?: string[];
|
|
14262
14609
|
};
|
|
14263
|
-
renderedAst?:
|
|
14610
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14611
|
+
renderedAstArtifactKey?: string;
|
|
14264
14612
|
rendererVersion?: string;
|
|
14265
14613
|
parentRevisionId?: string | null;
|
|
14266
14614
|
/** @enum {string} */
|
|
@@ -14383,7 +14731,8 @@ interface components {
|
|
|
14383
14731
|
codeBlockLanguages?: string[];
|
|
14384
14732
|
rawSpaceLinks?: string[];
|
|
14385
14733
|
};
|
|
14386
|
-
renderedAst?:
|
|
14734
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14735
|
+
renderedAstArtifactKey?: string;
|
|
14387
14736
|
rendererVersion?: string;
|
|
14388
14737
|
parentRevisionId?: string | null;
|
|
14389
14738
|
/** @enum {string} */
|
|
@@ -14493,7 +14842,8 @@ interface components {
|
|
|
14493
14842
|
codeBlockLanguages?: string[];
|
|
14494
14843
|
rawSpaceLinks?: string[];
|
|
14495
14844
|
};
|
|
14496
|
-
renderedAst?:
|
|
14845
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14846
|
+
renderedAstArtifactKey?: string;
|
|
14497
14847
|
rendererVersion?: string;
|
|
14498
14848
|
parentRevisionId?: string | null;
|
|
14499
14849
|
/** @enum {string} */
|
|
@@ -14598,7 +14948,8 @@ interface components {
|
|
|
14598
14948
|
codeBlockLanguages?: string[];
|
|
14599
14949
|
rawSpaceLinks?: string[];
|
|
14600
14950
|
};
|
|
14601
|
-
renderedAst?:
|
|
14951
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
14952
|
+
renderedAstArtifactKey?: string;
|
|
14602
14953
|
rendererVersion?: string;
|
|
14603
14954
|
parentRevisionId?: string | null;
|
|
14604
14955
|
/** @enum {string} */
|
|
@@ -14666,6 +15017,7 @@ interface components {
|
|
|
14666
15017
|
likerCount?: number;
|
|
14667
15018
|
seenUsersCount?: number;
|
|
14668
15019
|
} | null;
|
|
15020
|
+
total: number;
|
|
14669
15021
|
};
|
|
14670
15022
|
GetPageResponse: {
|
|
14671
15023
|
page: {
|
|
@@ -14705,7 +15057,8 @@ interface components {
|
|
|
14705
15057
|
codeBlockLanguages?: string[];
|
|
14706
15058
|
rawSpaceLinks?: string[];
|
|
14707
15059
|
};
|
|
14708
|
-
renderedAst?:
|
|
15060
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
15061
|
+
renderedAstArtifactKey?: string;
|
|
14709
15062
|
rendererVersion?: string;
|
|
14710
15063
|
parentRevisionId?: string | null;
|
|
14711
15064
|
/** @enum {string} */
|
|
@@ -14862,7 +15215,8 @@ interface components {
|
|
|
14862
15215
|
codeBlockLanguages?: string[];
|
|
14863
15216
|
rawSpaceLinks?: string[];
|
|
14864
15217
|
};
|
|
14865
|
-
renderedAst?:
|
|
15218
|
+
renderedAst?: components["schemas"]["RenderedAstEnvelope"] | components["schemas"]["LegacyRenderedAstRoot"];
|
|
15219
|
+
renderedAstArtifactKey?: string;
|
|
14866
15220
|
rendererVersion?: string;
|
|
14867
15221
|
parentRevisionId?: string | null;
|
|
14868
15222
|
/** @enum {string} */
|
|
@@ -15152,7 +15506,7 @@ interface components {
|
|
|
15152
15506
|
};
|
|
15153
15507
|
UploadAttachmentError: {
|
|
15154
15508
|
/** @enum {string} */
|
|
15155
|
-
error: "too_large" | "disallowed_type" | "rate_limited" | "no_permission";
|
|
15509
|
+
error: "too_large" | "disallowed_type" | "DISALLOWED_MIME" | "rate_limited" | "no_permission";
|
|
15156
15510
|
message: string;
|
|
15157
15511
|
details?: {
|
|
15158
15512
|
[key: string]: unknown;
|