@crowi/api-contract 2.0.0-alpha.0 → 2.0.0-alpha.2
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 +566 -3
- package/dist/generated/openapi.d.ts +566 -3
- package/dist/generated/openapi.js.map +1 -1
- package/dist/index.d.mts +1740 -250
- package/dist/index.d.ts +1740 -250
- package/dist/index.js +283 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +275 -6
- package/dist/index.mjs.map +1 -1
- package/package.json +8 -3
|
@@ -32,6 +32,10 @@ interface paths {
|
|
|
32
32
|
"application/json": {
|
|
33
33
|
title: string | null;
|
|
34
34
|
confidential: string | null;
|
|
35
|
+
version: string;
|
|
36
|
+
apiVersion: string;
|
|
37
|
+
capabilities: string[];
|
|
38
|
+
canSelfRegister: boolean;
|
|
35
39
|
};
|
|
36
40
|
};
|
|
37
41
|
};
|
|
@@ -5249,6 +5253,7 @@ interface paths {
|
|
|
5249
5253
|
include_deleted?: boolean | null;
|
|
5250
5254
|
sort?: "updatedAt" | "createdAt" | "path";
|
|
5251
5255
|
order?: "asc" | "desc";
|
|
5256
|
+
revision_id?: string;
|
|
5252
5257
|
};
|
|
5253
5258
|
header?: never;
|
|
5254
5259
|
path?: never;
|
|
@@ -5476,6 +5481,110 @@ interface paths {
|
|
|
5476
5481
|
likerCount?: number;
|
|
5477
5482
|
seenUsersCount?: number;
|
|
5478
5483
|
} | null;
|
|
5484
|
+
contentPage?: {
|
|
5485
|
+
_id: string;
|
|
5486
|
+
path: string;
|
|
5487
|
+
revision?: string | {
|
|
5488
|
+
_id: string;
|
|
5489
|
+
path: string;
|
|
5490
|
+
body: string;
|
|
5491
|
+
/** @default markdown */
|
|
5492
|
+
format: string;
|
|
5493
|
+
author?: {
|
|
5494
|
+
_id: string;
|
|
5495
|
+
id?: string;
|
|
5496
|
+
username: string;
|
|
5497
|
+
name: string;
|
|
5498
|
+
/** Format: email */
|
|
5499
|
+
email: string;
|
|
5500
|
+
image?: string | null;
|
|
5501
|
+
createdAt: string;
|
|
5502
|
+
} | null;
|
|
5503
|
+
createdAt: string;
|
|
5504
|
+
meta?: {
|
|
5505
|
+
toc?: {
|
|
5506
|
+
level: number;
|
|
5507
|
+
text: string;
|
|
5508
|
+
anchorId: string;
|
|
5509
|
+
}[];
|
|
5510
|
+
wikiLinks?: {
|
|
5511
|
+
raw: string;
|
|
5512
|
+
target: string;
|
|
5513
|
+
displayText?: string;
|
|
5514
|
+
}[];
|
|
5515
|
+
mentions?: {
|
|
5516
|
+
username: string;
|
|
5517
|
+
}[];
|
|
5518
|
+
codeBlockLanguages?: string[];
|
|
5519
|
+
};
|
|
5520
|
+
renderedAst?: unknown;
|
|
5521
|
+
rendererVersion?: string;
|
|
5522
|
+
parentRevisionId?: string | null;
|
|
5523
|
+
/** @enum {string} */
|
|
5524
|
+
type?: "snapshot" | "incremental";
|
|
5525
|
+
savedBy?: string | {
|
|
5526
|
+
_id: string;
|
|
5527
|
+
id?: string;
|
|
5528
|
+
username: string;
|
|
5529
|
+
name: string;
|
|
5530
|
+
/** Format: email */
|
|
5531
|
+
email: string;
|
|
5532
|
+
image?: string | null;
|
|
5533
|
+
createdAt: string;
|
|
5534
|
+
} | null;
|
|
5535
|
+
contributors?: (string | {
|
|
5536
|
+
_id: string;
|
|
5537
|
+
id?: string;
|
|
5538
|
+
username: string;
|
|
5539
|
+
name: string;
|
|
5540
|
+
/** Format: email */
|
|
5541
|
+
email: string;
|
|
5542
|
+
image?: string | null;
|
|
5543
|
+
createdAt: string;
|
|
5544
|
+
})[];
|
|
5545
|
+
message?: string;
|
|
5546
|
+
/** @enum {string} */
|
|
5547
|
+
editVia?: "web" | "oauth" | "pat";
|
|
5548
|
+
};
|
|
5549
|
+
redirectTo?: string | null;
|
|
5550
|
+
/** @enum {string|null} */
|
|
5551
|
+
status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
|
|
5552
|
+
grant?: number;
|
|
5553
|
+
grantedUsers?: string[];
|
|
5554
|
+
creator?: string | {
|
|
5555
|
+
_id: string;
|
|
5556
|
+
id?: string;
|
|
5557
|
+
username: string;
|
|
5558
|
+
name: string;
|
|
5559
|
+
/** Format: email */
|
|
5560
|
+
email: string;
|
|
5561
|
+
image?: string | null;
|
|
5562
|
+
createdAt: string;
|
|
5563
|
+
} | null;
|
|
5564
|
+
lastUpdateUser?: string | {
|
|
5565
|
+
_id: string;
|
|
5566
|
+
id?: string;
|
|
5567
|
+
username: string;
|
|
5568
|
+
name: string;
|
|
5569
|
+
/** Format: email */
|
|
5570
|
+
email: string;
|
|
5571
|
+
image?: string | null;
|
|
5572
|
+
createdAt: string;
|
|
5573
|
+
} | null;
|
|
5574
|
+
liker?: string[];
|
|
5575
|
+
/** @default 0 */
|
|
5576
|
+
commentCount: number;
|
|
5577
|
+
extended?: {
|
|
5578
|
+
[key: string]: unknown;
|
|
5579
|
+
};
|
|
5580
|
+
createdAt: string;
|
|
5581
|
+
updatedAt?: string;
|
|
5582
|
+
currentRevision?: string | null;
|
|
5583
|
+
yjsCheckpointAt?: string | null;
|
|
5584
|
+
latestRevision?: string;
|
|
5585
|
+
likerCount?: number;
|
|
5586
|
+
seenUsersCount?: number;
|
|
5587
|
+
} | null;
|
|
5479
5588
|
};
|
|
5480
5589
|
};
|
|
5481
5590
|
};
|
|
@@ -6553,7 +6662,202 @@ interface paths {
|
|
|
6553
6662
|
};
|
|
6554
6663
|
};
|
|
6555
6664
|
responses: {
|
|
6556
|
-
/** @description The restored page */
|
|
6665
|
+
/** @description The restored page */
|
|
6666
|
+
200: {
|
|
6667
|
+
headers: {
|
|
6668
|
+
[name: string]: unknown;
|
|
6669
|
+
};
|
|
6670
|
+
content: {
|
|
6671
|
+
"application/json": {
|
|
6672
|
+
page: {
|
|
6673
|
+
_id: string;
|
|
6674
|
+
path: string;
|
|
6675
|
+
revision?: string | {
|
|
6676
|
+
_id: string;
|
|
6677
|
+
path: string;
|
|
6678
|
+
body: string;
|
|
6679
|
+
/** @default markdown */
|
|
6680
|
+
format: string;
|
|
6681
|
+
author?: {
|
|
6682
|
+
_id: string;
|
|
6683
|
+
id?: string;
|
|
6684
|
+
username: string;
|
|
6685
|
+
name: string;
|
|
6686
|
+
/** Format: email */
|
|
6687
|
+
email: string;
|
|
6688
|
+
image?: string | null;
|
|
6689
|
+
createdAt: string;
|
|
6690
|
+
} | null;
|
|
6691
|
+
createdAt: string;
|
|
6692
|
+
meta?: {
|
|
6693
|
+
toc?: {
|
|
6694
|
+
level: number;
|
|
6695
|
+
text: string;
|
|
6696
|
+
anchorId: string;
|
|
6697
|
+
}[];
|
|
6698
|
+
wikiLinks?: {
|
|
6699
|
+
raw: string;
|
|
6700
|
+
target: string;
|
|
6701
|
+
displayText?: string;
|
|
6702
|
+
}[];
|
|
6703
|
+
mentions?: {
|
|
6704
|
+
username: string;
|
|
6705
|
+
}[];
|
|
6706
|
+
codeBlockLanguages?: string[];
|
|
6707
|
+
};
|
|
6708
|
+
renderedAst?: unknown;
|
|
6709
|
+
rendererVersion?: string;
|
|
6710
|
+
parentRevisionId?: string | null;
|
|
6711
|
+
/** @enum {string} */
|
|
6712
|
+
type?: "snapshot" | "incremental";
|
|
6713
|
+
savedBy?: string | {
|
|
6714
|
+
_id: string;
|
|
6715
|
+
id?: string;
|
|
6716
|
+
username: string;
|
|
6717
|
+
name: string;
|
|
6718
|
+
/** Format: email */
|
|
6719
|
+
email: string;
|
|
6720
|
+
image?: string | null;
|
|
6721
|
+
createdAt: string;
|
|
6722
|
+
} | null;
|
|
6723
|
+
contributors?: (string | {
|
|
6724
|
+
_id: string;
|
|
6725
|
+
id?: string;
|
|
6726
|
+
username: string;
|
|
6727
|
+
name: string;
|
|
6728
|
+
/** Format: email */
|
|
6729
|
+
email: string;
|
|
6730
|
+
image?: string | null;
|
|
6731
|
+
createdAt: string;
|
|
6732
|
+
})[];
|
|
6733
|
+
message?: string;
|
|
6734
|
+
/** @enum {string} */
|
|
6735
|
+
editVia?: "web" | "oauth" | "pat";
|
|
6736
|
+
};
|
|
6737
|
+
redirectTo?: string | null;
|
|
6738
|
+
/** @enum {string|null} */
|
|
6739
|
+
status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
|
|
6740
|
+
grant?: number;
|
|
6741
|
+
grantedUsers?: string[];
|
|
6742
|
+
creator?: string | {
|
|
6743
|
+
_id: string;
|
|
6744
|
+
id?: string;
|
|
6745
|
+
username: string;
|
|
6746
|
+
name: string;
|
|
6747
|
+
/** Format: email */
|
|
6748
|
+
email: string;
|
|
6749
|
+
image?: string | null;
|
|
6750
|
+
createdAt: string;
|
|
6751
|
+
} | null;
|
|
6752
|
+
lastUpdateUser?: string | {
|
|
6753
|
+
_id: string;
|
|
6754
|
+
id?: string;
|
|
6755
|
+
username: string;
|
|
6756
|
+
name: string;
|
|
6757
|
+
/** Format: email */
|
|
6758
|
+
email: string;
|
|
6759
|
+
image?: string | null;
|
|
6760
|
+
createdAt: string;
|
|
6761
|
+
} | null;
|
|
6762
|
+
liker?: string[];
|
|
6763
|
+
/** @default 0 */
|
|
6764
|
+
commentCount: number;
|
|
6765
|
+
extended?: {
|
|
6766
|
+
[key: string]: unknown;
|
|
6767
|
+
};
|
|
6768
|
+
createdAt: string;
|
|
6769
|
+
updatedAt?: string;
|
|
6770
|
+
currentRevision?: string | null;
|
|
6771
|
+
yjsCheckpointAt?: string | null;
|
|
6772
|
+
latestRevision?: string;
|
|
6773
|
+
likerCount?: number;
|
|
6774
|
+
seenUsersCount?: number;
|
|
6775
|
+
};
|
|
6776
|
+
};
|
|
6777
|
+
};
|
|
6778
|
+
};
|
|
6779
|
+
/** @description PAGE_REVERT_FAILED */
|
|
6780
|
+
400: {
|
|
6781
|
+
headers: {
|
|
6782
|
+
[name: string]: unknown;
|
|
6783
|
+
};
|
|
6784
|
+
content: {
|
|
6785
|
+
"application/json": {
|
|
6786
|
+
error: {
|
|
6787
|
+
code: string;
|
|
6788
|
+
message: string;
|
|
6789
|
+
};
|
|
6790
|
+
};
|
|
6791
|
+
};
|
|
6792
|
+
};
|
|
6793
|
+
/** @description Authentication required */
|
|
6794
|
+
401: {
|
|
6795
|
+
headers: {
|
|
6796
|
+
[name: string]: unknown;
|
|
6797
|
+
};
|
|
6798
|
+
content: {
|
|
6799
|
+
"application/json": {
|
|
6800
|
+
error: {
|
|
6801
|
+
/** @enum {string} */
|
|
6802
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
6803
|
+
/** @enum {string} */
|
|
6804
|
+
message: "Authentication is required";
|
|
6805
|
+
redirectTo?: string;
|
|
6806
|
+
};
|
|
6807
|
+
};
|
|
6808
|
+
};
|
|
6809
|
+
};
|
|
6810
|
+
/** @description Page not found (also covers grant-denied) */
|
|
6811
|
+
404: {
|
|
6812
|
+
headers: {
|
|
6813
|
+
[name: string]: unknown;
|
|
6814
|
+
};
|
|
6815
|
+
content: {
|
|
6816
|
+
"application/json": {
|
|
6817
|
+
error: {
|
|
6818
|
+
/** @enum {string} */
|
|
6819
|
+
code: "PAGE_NOT_FOUND";
|
|
6820
|
+
/** @enum {string} */
|
|
6821
|
+
message: "Page not found";
|
|
6822
|
+
};
|
|
6823
|
+
};
|
|
6824
|
+
};
|
|
6825
|
+
};
|
|
6826
|
+
};
|
|
6827
|
+
};
|
|
6828
|
+
delete?: never;
|
|
6829
|
+
options?: never;
|
|
6830
|
+
head?: never;
|
|
6831
|
+
patch?: never;
|
|
6832
|
+
trace?: never;
|
|
6833
|
+
};
|
|
6834
|
+
"/pages/revert-to-revision": {
|
|
6835
|
+
parameters: {
|
|
6836
|
+
query?: never;
|
|
6837
|
+
header?: never;
|
|
6838
|
+
path?: never;
|
|
6839
|
+
cookie?: never;
|
|
6840
|
+
};
|
|
6841
|
+
get?: never;
|
|
6842
|
+
put?: never;
|
|
6843
|
+
/** Revert a page to one of its past revisions (non-destructive — stacks a new revision) */
|
|
6844
|
+
post: {
|
|
6845
|
+
parameters: {
|
|
6846
|
+
query?: never;
|
|
6847
|
+
header?: never;
|
|
6848
|
+
path?: never;
|
|
6849
|
+
cookie?: never;
|
|
6850
|
+
};
|
|
6851
|
+
requestBody?: {
|
|
6852
|
+
content: {
|
|
6853
|
+
"application/json": {
|
|
6854
|
+
page_id: string;
|
|
6855
|
+
revision_id: string;
|
|
6856
|
+
};
|
|
6857
|
+
};
|
|
6858
|
+
};
|
|
6859
|
+
responses: {
|
|
6860
|
+
/** @description The page with the reverted body as its new latest revision */
|
|
6557
6861
|
200: {
|
|
6558
6862
|
headers: {
|
|
6559
6863
|
[name: string]: unknown;
|
|
@@ -6667,7 +6971,7 @@ interface paths {
|
|
|
6667
6971
|
};
|
|
6668
6972
|
};
|
|
6669
6973
|
};
|
|
6670
|
-
/** @description
|
|
6974
|
+
/** @description PAGE_REVERT_TO_REVISION_FAILED (e.g. the revision does not belong to the page) */
|
|
6671
6975
|
400: {
|
|
6672
6976
|
headers: {
|
|
6673
6977
|
[name: string]: unknown;
|
|
@@ -11425,6 +11729,160 @@ interface paths {
|
|
|
11425
11729
|
patch?: never;
|
|
11426
11730
|
trace?: never;
|
|
11427
11731
|
};
|
|
11732
|
+
"/admin/users/{id}/resend-invite": {
|
|
11733
|
+
parameters: {
|
|
11734
|
+
query?: never;
|
|
11735
|
+
header?: never;
|
|
11736
|
+
path?: never;
|
|
11737
|
+
cookie?: never;
|
|
11738
|
+
};
|
|
11739
|
+
get?: never;
|
|
11740
|
+
put?: never;
|
|
11741
|
+
/** Re-issue an invite token and resend the invitation email (INVITED status only) */
|
|
11742
|
+
post: {
|
|
11743
|
+
parameters: {
|
|
11744
|
+
query?: never;
|
|
11745
|
+
header?: never;
|
|
11746
|
+
path: {
|
|
11747
|
+
id: string;
|
|
11748
|
+
};
|
|
11749
|
+
cookie?: never;
|
|
11750
|
+
};
|
|
11751
|
+
requestBody?: never;
|
|
11752
|
+
responses: {
|
|
11753
|
+
/** @description Invitation email resent; returns the (unchanged) user */
|
|
11754
|
+
200: {
|
|
11755
|
+
headers: {
|
|
11756
|
+
[name: string]: unknown;
|
|
11757
|
+
};
|
|
11758
|
+
content: {
|
|
11759
|
+
"application/json": {
|
|
11760
|
+
user: {
|
|
11761
|
+
_id: string;
|
|
11762
|
+
id?: string;
|
|
11763
|
+
username: string;
|
|
11764
|
+
name: string;
|
|
11765
|
+
/** Format: email */
|
|
11766
|
+
email: string;
|
|
11767
|
+
image?: string | null;
|
|
11768
|
+
introduction?: string;
|
|
11769
|
+
createdAt: string;
|
|
11770
|
+
admin?: boolean;
|
|
11771
|
+
/** @enum {integer} */
|
|
11772
|
+
status?: 1 | 2 | 3 | 4 | 5;
|
|
11773
|
+
};
|
|
11774
|
+
};
|
|
11775
|
+
};
|
|
11776
|
+
};
|
|
11777
|
+
/** @description Invalid id */
|
|
11778
|
+
400: {
|
|
11779
|
+
headers: {
|
|
11780
|
+
[name: string]: unknown;
|
|
11781
|
+
};
|
|
11782
|
+
content: {
|
|
11783
|
+
"application/json": {
|
|
11784
|
+
error: {
|
|
11785
|
+
/** @enum {string} */
|
|
11786
|
+
code: "VALIDATION_ERROR";
|
|
11787
|
+
message: string;
|
|
11788
|
+
details?: {
|
|
11789
|
+
fieldErrors: {
|
|
11790
|
+
[key: string]: string[];
|
|
11791
|
+
};
|
|
11792
|
+
formErrors: string[];
|
|
11793
|
+
};
|
|
11794
|
+
};
|
|
11795
|
+
};
|
|
11796
|
+
};
|
|
11797
|
+
};
|
|
11798
|
+
/** @description Authentication required */
|
|
11799
|
+
401: {
|
|
11800
|
+
headers: {
|
|
11801
|
+
[name: string]: unknown;
|
|
11802
|
+
};
|
|
11803
|
+
content: {
|
|
11804
|
+
"application/json": {
|
|
11805
|
+
error: {
|
|
11806
|
+
/** @enum {string} */
|
|
11807
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
11808
|
+
/** @enum {string} */
|
|
11809
|
+
message: "Authentication is required";
|
|
11810
|
+
redirectTo?: string;
|
|
11811
|
+
};
|
|
11812
|
+
};
|
|
11813
|
+
};
|
|
11814
|
+
};
|
|
11815
|
+
/** @description Admin permission required */
|
|
11816
|
+
403: {
|
|
11817
|
+
headers: {
|
|
11818
|
+
[name: string]: unknown;
|
|
11819
|
+
};
|
|
11820
|
+
content: {
|
|
11821
|
+
"application/json": {
|
|
11822
|
+
error: {
|
|
11823
|
+
/** @enum {string} */
|
|
11824
|
+
code: "ADMIN_REQUIRED";
|
|
11825
|
+
/** @enum {string} */
|
|
11826
|
+
message: "Admin permission required";
|
|
11827
|
+
redirectTo?: string;
|
|
11828
|
+
};
|
|
11829
|
+
};
|
|
11830
|
+
};
|
|
11831
|
+
};
|
|
11832
|
+
/** @description User not found */
|
|
11833
|
+
404: {
|
|
11834
|
+
headers: {
|
|
11835
|
+
[name: string]: unknown;
|
|
11836
|
+
};
|
|
11837
|
+
content: {
|
|
11838
|
+
"application/json": {
|
|
11839
|
+
error: {
|
|
11840
|
+
/** @enum {string} */
|
|
11841
|
+
code: "NOT_FOUND";
|
|
11842
|
+
message: string;
|
|
11843
|
+
};
|
|
11844
|
+
};
|
|
11845
|
+
};
|
|
11846
|
+
};
|
|
11847
|
+
/** @description User is not in the INVITED status, so there is no pending invite to resend */
|
|
11848
|
+
409: {
|
|
11849
|
+
headers: {
|
|
11850
|
+
[name: string]: unknown;
|
|
11851
|
+
};
|
|
11852
|
+
content: {
|
|
11853
|
+
"application/json": {
|
|
11854
|
+
error: {
|
|
11855
|
+
/** @enum {string} */
|
|
11856
|
+
code: "CONFLICT";
|
|
11857
|
+
message: string;
|
|
11858
|
+
};
|
|
11859
|
+
};
|
|
11860
|
+
};
|
|
11861
|
+
};
|
|
11862
|
+
/** @description Internal server error (e.g. the invitation email failed to send) */
|
|
11863
|
+
500: {
|
|
11864
|
+
headers: {
|
|
11865
|
+
[name: string]: unknown;
|
|
11866
|
+
};
|
|
11867
|
+
content: {
|
|
11868
|
+
"application/json": {
|
|
11869
|
+
error: {
|
|
11870
|
+
/** @enum {string} */
|
|
11871
|
+
code: "INTERNAL_ERROR";
|
|
11872
|
+
/** @enum {string} */
|
|
11873
|
+
message: "Internal server error";
|
|
11874
|
+
};
|
|
11875
|
+
};
|
|
11876
|
+
};
|
|
11877
|
+
};
|
|
11878
|
+
};
|
|
11879
|
+
};
|
|
11880
|
+
delete?: never;
|
|
11881
|
+
options?: never;
|
|
11882
|
+
head?: never;
|
|
11883
|
+
patch?: never;
|
|
11884
|
+
trace?: never;
|
|
11885
|
+
};
|
|
11428
11886
|
"/admin/users/{id}/email": {
|
|
11429
11887
|
parameters: {
|
|
11430
11888
|
query?: never;
|
|
@@ -12696,7 +13154,7 @@ interface components {
|
|
|
12696
13154
|
};
|
|
12697
13155
|
};
|
|
12698
13156
|
/** @enum {string} */
|
|
12699
|
-
ErrorCode: "AUTHENTICATION_REQUIRED" | "ADMIN_REQUIRED" | "THIRD_PARTY_AUTH_REQUIRED" | "USER_REGISTERED" | "USER_SUSPENDED" | "USER_INVITED" | "USER_NOT_ACTIVE" | "EMAIL_NOT_CONFIRMED" | "INTERNAL_ERROR" | "VALIDATION_ERROR" | "INVALID_REQUEST" | "NOT_FOUND" | "CONFLICT" | "SERVICE_UNAVAILABLE" | "APPLICATION_NOT_INSTALLED" | "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "PAGE_NOT_GRANTED" | "PAGE_REVISION_ERROR" | "INVALID_GRANT" | "COMMENT_NOT_FOUND" | "NOTIFICATION_NOT_FOUND" | "USER_NOT_FOUND" | "USER_EXISTS" | "USERNAME_TAKEN" | "EMAIL_TAKEN" | "EMAIL_NOT_ALLOWED" | "INVALID_ACTIVATION_TOKEN" | "INVALID_INVITE_TOKEN" | "INVITE_ALREADY_ACCEPTED" | "INVALID_RESET_TOKEN" | "INVALID_EMAIL_CHANGE_TOKEN" | "INVALID_CREDENTIALS" | "REFRESH_TOKEN_REQUIRED" | "REGISTRATION_CLOSED" | "ENCRYPTION_NOT_CONFIGURED" | "MAIL_TEST_FAILED" | "PLUGIN_NOT_FOUND" | "PLUGIN_CONFIG_VALIDATION_FAILED";
|
|
13157
|
+
ErrorCode: "AUTHENTICATION_REQUIRED" | "ADMIN_REQUIRED" | "THIRD_PARTY_AUTH_REQUIRED" | "USER_REGISTERED" | "USER_SUSPENDED" | "USER_INVITED" | "USER_NOT_ACTIVE" | "EMAIL_NOT_CONFIRMED" | "INTERNAL_ERROR" | "VALIDATION_ERROR" | "INVALID_REQUEST" | "NOT_FOUND" | "CONFLICT" | "SERVICE_UNAVAILABLE" | "APPLICATION_NOT_INSTALLED" | "INVALID_PAGE_ID" | "PAGE_NOT_FOUND" | "PAGE_NOT_GRANTED" | "PAGE_REVISION_ERROR" | "PAGE_TWIN_EXISTS" | "INVALID_GRANT" | "COMMENT_NOT_FOUND" | "NOTIFICATION_NOT_FOUND" | "USER_NOT_FOUND" | "USER_EXISTS" | "USERNAME_TAKEN" | "EMAIL_TAKEN" | "EMAIL_NOT_ALLOWED" | "INVALID_ACTIVATION_TOKEN" | "INVALID_INVITE_TOKEN" | "INVITE_ALREADY_ACCEPTED" | "INVALID_RESET_TOKEN" | "INVALID_EMAIL_CHANGE_TOKEN" | "INVALID_CREDENTIALS" | "REFRESH_TOKEN_REQUIRED" | "REGISTRATION_CLOSED" | "ENCRYPTION_NOT_CONFIGURED" | "MAIL_TEST_FAILED" | "PLUGIN_NOT_FOUND" | "PLUGIN_CONFIG_VALIDATION_FAILED";
|
|
12700
13158
|
ApplicationNotInstalledError: {
|
|
12701
13159
|
error: {
|
|
12702
13160
|
/** @enum {string} */
|
|
@@ -13224,6 +13682,7 @@ interface components {
|
|
|
13224
13682
|
* @enum {string}
|
|
13225
13683
|
*/
|
|
13226
13684
|
order: "asc" | "desc";
|
|
13685
|
+
revision_id?: string;
|
|
13227
13686
|
};
|
|
13228
13687
|
ListPagesResponse: {
|
|
13229
13688
|
pages: {
|
|
@@ -13439,6 +13898,110 @@ interface components {
|
|
|
13439
13898
|
likerCount?: number;
|
|
13440
13899
|
seenUsersCount?: number;
|
|
13441
13900
|
} | null;
|
|
13901
|
+
contentPage?: {
|
|
13902
|
+
_id: string;
|
|
13903
|
+
path: string;
|
|
13904
|
+
revision?: string | {
|
|
13905
|
+
_id: string;
|
|
13906
|
+
path: string;
|
|
13907
|
+
body: string;
|
|
13908
|
+
/** @default markdown */
|
|
13909
|
+
format: string;
|
|
13910
|
+
author?: {
|
|
13911
|
+
_id: string;
|
|
13912
|
+
id?: string;
|
|
13913
|
+
username: string;
|
|
13914
|
+
name: string;
|
|
13915
|
+
/** Format: email */
|
|
13916
|
+
email: string;
|
|
13917
|
+
image?: string | null;
|
|
13918
|
+
createdAt: string;
|
|
13919
|
+
} | null;
|
|
13920
|
+
createdAt: string;
|
|
13921
|
+
meta?: {
|
|
13922
|
+
toc?: {
|
|
13923
|
+
level: number;
|
|
13924
|
+
text: string;
|
|
13925
|
+
anchorId: string;
|
|
13926
|
+
}[];
|
|
13927
|
+
wikiLinks?: {
|
|
13928
|
+
raw: string;
|
|
13929
|
+
target: string;
|
|
13930
|
+
displayText?: string;
|
|
13931
|
+
}[];
|
|
13932
|
+
mentions?: {
|
|
13933
|
+
username: string;
|
|
13934
|
+
}[];
|
|
13935
|
+
codeBlockLanguages?: string[];
|
|
13936
|
+
};
|
|
13937
|
+
renderedAst?: unknown;
|
|
13938
|
+
rendererVersion?: string;
|
|
13939
|
+
parentRevisionId?: string | null;
|
|
13940
|
+
/** @enum {string} */
|
|
13941
|
+
type?: "snapshot" | "incremental";
|
|
13942
|
+
savedBy?: string | {
|
|
13943
|
+
_id: string;
|
|
13944
|
+
id?: string;
|
|
13945
|
+
username: string;
|
|
13946
|
+
name: string;
|
|
13947
|
+
/** Format: email */
|
|
13948
|
+
email: string;
|
|
13949
|
+
image?: string | null;
|
|
13950
|
+
createdAt: string;
|
|
13951
|
+
} | null;
|
|
13952
|
+
contributors?: (string | {
|
|
13953
|
+
_id: string;
|
|
13954
|
+
id?: string;
|
|
13955
|
+
username: string;
|
|
13956
|
+
name: string;
|
|
13957
|
+
/** Format: email */
|
|
13958
|
+
email: string;
|
|
13959
|
+
image?: string | null;
|
|
13960
|
+
createdAt: string;
|
|
13961
|
+
})[];
|
|
13962
|
+
message?: string;
|
|
13963
|
+
/** @enum {string} */
|
|
13964
|
+
editVia?: "web" | "oauth" | "pat";
|
|
13965
|
+
};
|
|
13966
|
+
redirectTo?: string | null;
|
|
13967
|
+
/** @enum {string|null} */
|
|
13968
|
+
status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
|
|
13969
|
+
grant?: number;
|
|
13970
|
+
grantedUsers?: string[];
|
|
13971
|
+
creator?: string | {
|
|
13972
|
+
_id: string;
|
|
13973
|
+
id?: string;
|
|
13974
|
+
username: string;
|
|
13975
|
+
name: string;
|
|
13976
|
+
/** Format: email */
|
|
13977
|
+
email: string;
|
|
13978
|
+
image?: string | null;
|
|
13979
|
+
createdAt: string;
|
|
13980
|
+
} | null;
|
|
13981
|
+
lastUpdateUser?: string | {
|
|
13982
|
+
_id: string;
|
|
13983
|
+
id?: string;
|
|
13984
|
+
username: string;
|
|
13985
|
+
name: string;
|
|
13986
|
+
/** Format: email */
|
|
13987
|
+
email: string;
|
|
13988
|
+
image?: string | null;
|
|
13989
|
+
createdAt: string;
|
|
13990
|
+
} | null;
|
|
13991
|
+
liker?: string[];
|
|
13992
|
+
/** @default 0 */
|
|
13993
|
+
commentCount: number;
|
|
13994
|
+
extended?: {
|
|
13995
|
+
[key: string]: unknown;
|
|
13996
|
+
};
|
|
13997
|
+
createdAt: string;
|
|
13998
|
+
updatedAt?: string;
|
|
13999
|
+
currentRevision?: string | null;
|
|
14000
|
+
yjsCheckpointAt?: string | null;
|
|
14001
|
+
latestRevision?: string;
|
|
14002
|
+
likerCount?: number;
|
|
14003
|
+
seenUsersCount?: number;
|
|
14004
|
+
} | null;
|
|
13442
14005
|
};
|
|
13443
14006
|
GetPageResponse: {
|
|
13444
14007
|
page: {
|