@crowi/api-contract 2.0.0-alpha.7 → 2.0.0-alpha.8
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 +345 -1
- package/dist/generated/openapi.d.ts +345 -1
- package/dist/generated/openapi.js.map +1 -1
- package/dist/index.d.mts +38474 -37454
- package/dist/index.d.ts +38474 -37454
- package/dist/index.js +4214 -4090
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +4224 -4105
- package/dist/index.mjs.map +1 -1
- package/package.json +3 -3
|
@@ -36,6 +36,7 @@ interface paths {
|
|
|
36
36
|
apiVersion: string;
|
|
37
37
|
capabilities: components["schemas"]["Capability"][];
|
|
38
38
|
canSelfRegister: boolean;
|
|
39
|
+
rendererStylesheets: string[];
|
|
39
40
|
};
|
|
40
41
|
};
|
|
41
42
|
};
|
|
@@ -2153,6 +2154,64 @@ interface paths {
|
|
|
2153
2154
|
patch?: never;
|
|
2154
2155
|
trace?: never;
|
|
2155
2156
|
};
|
|
2157
|
+
"/oauth/client-info": {
|
|
2158
|
+
parameters: {
|
|
2159
|
+
query?: never;
|
|
2160
|
+
header?: never;
|
|
2161
|
+
path?: never;
|
|
2162
|
+
cookie?: never;
|
|
2163
|
+
};
|
|
2164
|
+
/** Look up non-secret metadata for a registered OAuth client (authorize/consent screen) */
|
|
2165
|
+
get: {
|
|
2166
|
+
parameters: {
|
|
2167
|
+
query: {
|
|
2168
|
+
client_id: string;
|
|
2169
|
+
};
|
|
2170
|
+
header?: never;
|
|
2171
|
+
path?: never;
|
|
2172
|
+
cookie?: never;
|
|
2173
|
+
};
|
|
2174
|
+
requestBody?: never;
|
|
2175
|
+
responses: {
|
|
2176
|
+
/** @description Client metadata */
|
|
2177
|
+
200: {
|
|
2178
|
+
headers: {
|
|
2179
|
+
[name: string]: unknown;
|
|
2180
|
+
};
|
|
2181
|
+
content: {
|
|
2182
|
+
"application/json": {
|
|
2183
|
+
clientId: string;
|
|
2184
|
+
name: string;
|
|
2185
|
+
firstParty: boolean;
|
|
2186
|
+
trusted: boolean;
|
|
2187
|
+
};
|
|
2188
|
+
};
|
|
2189
|
+
};
|
|
2190
|
+
/** @description No client registered with this client_id */
|
|
2191
|
+
404: {
|
|
2192
|
+
headers: {
|
|
2193
|
+
[name: string]: unknown;
|
|
2194
|
+
};
|
|
2195
|
+
content: {
|
|
2196
|
+
"application/json": {
|
|
2197
|
+
error: {
|
|
2198
|
+
/** @enum {string} */
|
|
2199
|
+
code: "NOT_FOUND";
|
|
2200
|
+
message: string;
|
|
2201
|
+
};
|
|
2202
|
+
};
|
|
2203
|
+
};
|
|
2204
|
+
};
|
|
2205
|
+
};
|
|
2206
|
+
};
|
|
2207
|
+
put?: never;
|
|
2208
|
+
post?: never;
|
|
2209
|
+
delete?: never;
|
|
2210
|
+
options?: never;
|
|
2211
|
+
head?: never;
|
|
2212
|
+
patch?: never;
|
|
2213
|
+
trace?: never;
|
|
2214
|
+
};
|
|
2156
2215
|
"/user/{username}": {
|
|
2157
2216
|
parameters: {
|
|
2158
2217
|
query?: never;
|
|
@@ -2903,6 +2962,246 @@ interface paths {
|
|
|
2903
2962
|
patch?: never;
|
|
2904
2963
|
trace?: never;
|
|
2905
2964
|
};
|
|
2965
|
+
"/user/{username}/subpages": {
|
|
2966
|
+
parameters: {
|
|
2967
|
+
query?: never;
|
|
2968
|
+
header?: never;
|
|
2969
|
+
path?: never;
|
|
2970
|
+
cookie?: never;
|
|
2971
|
+
};
|
|
2972
|
+
/** Get pages under /user/{username}/ (path-rooted, fully recursive, paginated) */
|
|
2973
|
+
get: {
|
|
2974
|
+
parameters: {
|
|
2975
|
+
query?: {
|
|
2976
|
+
limit?: number;
|
|
2977
|
+
offset?: number | null;
|
|
2978
|
+
};
|
|
2979
|
+
header?: never;
|
|
2980
|
+
path: {
|
|
2981
|
+
username: string;
|
|
2982
|
+
};
|
|
2983
|
+
cookie?: never;
|
|
2984
|
+
};
|
|
2985
|
+
requestBody?: never;
|
|
2986
|
+
responses: {
|
|
2987
|
+
/** @description Paginated subpages (path-ascending, `_id` tie-break) */
|
|
2988
|
+
200: {
|
|
2989
|
+
headers: {
|
|
2990
|
+
[name: string]: unknown;
|
|
2991
|
+
};
|
|
2992
|
+
content: {
|
|
2993
|
+
"application/json": {
|
|
2994
|
+
pages: {
|
|
2995
|
+
_id: string;
|
|
2996
|
+
path: string;
|
|
2997
|
+
revision?: string | {
|
|
2998
|
+
_id: string;
|
|
2999
|
+
path: string;
|
|
3000
|
+
body: string;
|
|
3001
|
+
/** @default markdown */
|
|
3002
|
+
format: string;
|
|
3003
|
+
author?: {
|
|
3004
|
+
_id: string;
|
|
3005
|
+
id?: string;
|
|
3006
|
+
username: string;
|
|
3007
|
+
name: string;
|
|
3008
|
+
/** Format: email */
|
|
3009
|
+
email: string;
|
|
3010
|
+
image?: string | null;
|
|
3011
|
+
createdAt: string;
|
|
3012
|
+
} | null;
|
|
3013
|
+
createdAt: string;
|
|
3014
|
+
meta?: {
|
|
3015
|
+
toc?: {
|
|
3016
|
+
level: number;
|
|
3017
|
+
text: string;
|
|
3018
|
+
anchorId: string;
|
|
3019
|
+
}[];
|
|
3020
|
+
wikiLinks?: {
|
|
3021
|
+
raw: string;
|
|
3022
|
+
target: string;
|
|
3023
|
+
displayText?: string;
|
|
3024
|
+
}[];
|
|
3025
|
+
mentions?: {
|
|
3026
|
+
username: string;
|
|
3027
|
+
}[];
|
|
3028
|
+
codeBlockLanguages?: string[];
|
|
3029
|
+
};
|
|
3030
|
+
renderedAst?: unknown;
|
|
3031
|
+
rendererVersion?: string;
|
|
3032
|
+
parentRevisionId?: string | null;
|
|
3033
|
+
/** @enum {string} */
|
|
3034
|
+
type?: "snapshot" | "incremental";
|
|
3035
|
+
savedBy?: string | {
|
|
3036
|
+
_id: string;
|
|
3037
|
+
id?: string;
|
|
3038
|
+
username: string;
|
|
3039
|
+
name: string;
|
|
3040
|
+
/** Format: email */
|
|
3041
|
+
email: string;
|
|
3042
|
+
image?: string | null;
|
|
3043
|
+
createdAt: string;
|
|
3044
|
+
} | null;
|
|
3045
|
+
contributors?: (string | {
|
|
3046
|
+
_id: string;
|
|
3047
|
+
id?: string;
|
|
3048
|
+
username: string;
|
|
3049
|
+
name: string;
|
|
3050
|
+
/** Format: email */
|
|
3051
|
+
email: string;
|
|
3052
|
+
image?: string | null;
|
|
3053
|
+
createdAt: string;
|
|
3054
|
+
})[];
|
|
3055
|
+
message?: string;
|
|
3056
|
+
/** @enum {string} */
|
|
3057
|
+
editVia?: "web" | "oauth" | "pat";
|
|
3058
|
+
};
|
|
3059
|
+
redirectTo?: string | null;
|
|
3060
|
+
/** @enum {string|null} */
|
|
3061
|
+
status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
|
|
3062
|
+
grant?: number;
|
|
3063
|
+
grantedUsers?: string[];
|
|
3064
|
+
creator?: string | {
|
|
3065
|
+
_id: string;
|
|
3066
|
+
id?: string;
|
|
3067
|
+
username: string;
|
|
3068
|
+
name: string;
|
|
3069
|
+
/** Format: email */
|
|
3070
|
+
email: string;
|
|
3071
|
+
image?: string | null;
|
|
3072
|
+
createdAt: string;
|
|
3073
|
+
} | null;
|
|
3074
|
+
lastUpdateUser?: string | {
|
|
3075
|
+
_id: string;
|
|
3076
|
+
id?: string;
|
|
3077
|
+
username: string;
|
|
3078
|
+
name: string;
|
|
3079
|
+
/** Format: email */
|
|
3080
|
+
email: string;
|
|
3081
|
+
image?: string | null;
|
|
3082
|
+
createdAt: string;
|
|
3083
|
+
} | null;
|
|
3084
|
+
liker?: string[];
|
|
3085
|
+
/** @default 0 */
|
|
3086
|
+
commentCount: number;
|
|
3087
|
+
extended?: {
|
|
3088
|
+
[key: string]: unknown;
|
|
3089
|
+
};
|
|
3090
|
+
createdAt: string;
|
|
3091
|
+
updatedAt?: string;
|
|
3092
|
+
currentRevision?: string | null;
|
|
3093
|
+
yjsCheckpointAt?: string | null;
|
|
3094
|
+
latestRevision?: string;
|
|
3095
|
+
likerCount?: number;
|
|
3096
|
+
seenUsersCount?: number;
|
|
3097
|
+
}[];
|
|
3098
|
+
pager: {
|
|
3099
|
+
prev: number | null;
|
|
3100
|
+
next: number | null;
|
|
3101
|
+
offset: number;
|
|
3102
|
+
};
|
|
3103
|
+
total: number;
|
|
3104
|
+
};
|
|
3105
|
+
};
|
|
3106
|
+
};
|
|
3107
|
+
/** @description Invalid limit/offset */
|
|
3108
|
+
400: {
|
|
3109
|
+
headers: {
|
|
3110
|
+
[name: string]: unknown;
|
|
3111
|
+
};
|
|
3112
|
+
content: {
|
|
3113
|
+
"application/json": {
|
|
3114
|
+
error: {
|
|
3115
|
+
/** @enum {string} */
|
|
3116
|
+
code: "VALIDATION_ERROR";
|
|
3117
|
+
message: string;
|
|
3118
|
+
details?: {
|
|
3119
|
+
fieldErrors: {
|
|
3120
|
+
[key: string]: string[];
|
|
3121
|
+
};
|
|
3122
|
+
formErrors: string[];
|
|
3123
|
+
};
|
|
3124
|
+
};
|
|
3125
|
+
};
|
|
3126
|
+
};
|
|
3127
|
+
};
|
|
3128
|
+
/** @description Authentication required */
|
|
3129
|
+
401: {
|
|
3130
|
+
headers: {
|
|
3131
|
+
[name: string]: unknown;
|
|
3132
|
+
};
|
|
3133
|
+
content: {
|
|
3134
|
+
"application/json": {
|
|
3135
|
+
error: {
|
|
3136
|
+
/** @enum {string} */
|
|
3137
|
+
code: "AUTHENTICATION_REQUIRED";
|
|
3138
|
+
/** @enum {string} */
|
|
3139
|
+
message: "Authentication is required";
|
|
3140
|
+
redirectTo?: string;
|
|
3141
|
+
};
|
|
3142
|
+
};
|
|
3143
|
+
};
|
|
3144
|
+
};
|
|
3145
|
+
/** @description Missing profile:read and/or pages:read scope */
|
|
3146
|
+
403: {
|
|
3147
|
+
headers: {
|
|
3148
|
+
[name: string]: unknown;
|
|
3149
|
+
};
|
|
3150
|
+
content: {
|
|
3151
|
+
"application/json": {
|
|
3152
|
+
error: {
|
|
3153
|
+
/** @enum {string} */
|
|
3154
|
+
code: "INSUFFICIENT_SCOPE";
|
|
3155
|
+
message: string;
|
|
3156
|
+
details?: {
|
|
3157
|
+
requiredScope: string;
|
|
3158
|
+
};
|
|
3159
|
+
};
|
|
3160
|
+
};
|
|
3161
|
+
};
|
|
3162
|
+
};
|
|
3163
|
+
/** @description User not found */
|
|
3164
|
+
404: {
|
|
3165
|
+
headers: {
|
|
3166
|
+
[name: string]: unknown;
|
|
3167
|
+
};
|
|
3168
|
+
content: {
|
|
3169
|
+
"application/json": {
|
|
3170
|
+
error: {
|
|
3171
|
+
/** @enum {string} */
|
|
3172
|
+
code: "USER_NOT_FOUND";
|
|
3173
|
+
/** @enum {string} */
|
|
3174
|
+
message: "User not found";
|
|
3175
|
+
};
|
|
3176
|
+
};
|
|
3177
|
+
};
|
|
3178
|
+
};
|
|
3179
|
+
/** @description Internal server error */
|
|
3180
|
+
500: {
|
|
3181
|
+
headers: {
|
|
3182
|
+
[name: string]: unknown;
|
|
3183
|
+
};
|
|
3184
|
+
content: {
|
|
3185
|
+
"application/json": {
|
|
3186
|
+
error: {
|
|
3187
|
+
/** @enum {string} */
|
|
3188
|
+
code: "INTERNAL_ERROR";
|
|
3189
|
+
/** @enum {string} */
|
|
3190
|
+
message: "Internal server error";
|
|
3191
|
+
};
|
|
3192
|
+
};
|
|
3193
|
+
};
|
|
3194
|
+
};
|
|
3195
|
+
};
|
|
3196
|
+
};
|
|
3197
|
+
put?: never;
|
|
3198
|
+
post?: never;
|
|
3199
|
+
delete?: never;
|
|
3200
|
+
options?: never;
|
|
3201
|
+
head?: never;
|
|
3202
|
+
patch?: never;
|
|
3203
|
+
trace?: never;
|
|
3204
|
+
};
|
|
2906
3205
|
"/users": {
|
|
2907
3206
|
parameters: {
|
|
2908
3207
|
query?: never;
|
|
@@ -5695,6 +5994,17 @@ interface paths {
|
|
|
5695
5994
|
isPage: boolean;
|
|
5696
5995
|
hasPortal: boolean;
|
|
5697
5996
|
count: number;
|
|
5997
|
+
lastUpdatedAt?: string | null;
|
|
5998
|
+
updater?: {
|
|
5999
|
+
_id: string;
|
|
6000
|
+
id?: string;
|
|
6001
|
+
username: string;
|
|
6002
|
+
name: string;
|
|
6003
|
+
/** Format: email */
|
|
6004
|
+
email: string;
|
|
6005
|
+
image?: string | null;
|
|
6006
|
+
createdAt: string;
|
|
6007
|
+
} | null;
|
|
5698
6008
|
}[];
|
|
5699
6009
|
};
|
|
5700
6010
|
};
|
|
@@ -7675,6 +7985,20 @@ interface paths {
|
|
|
7675
7985
|
};
|
|
7676
7986
|
};
|
|
7677
7987
|
};
|
|
7988
|
+
/** @description Per-user rate limit exceeded */
|
|
7989
|
+
429: {
|
|
7990
|
+
headers: {
|
|
7991
|
+
[name: string]: unknown;
|
|
7992
|
+
};
|
|
7993
|
+
content: {
|
|
7994
|
+
"application/json": {
|
|
7995
|
+
/** @enum {string} */
|
|
7996
|
+
error: "rate_limited";
|
|
7997
|
+
message: string;
|
|
7998
|
+
retryAfterSeconds: number;
|
|
7999
|
+
};
|
|
8000
|
+
};
|
|
8001
|
+
};
|
|
7678
8002
|
/** @description Renderer pipeline failure */
|
|
7679
8003
|
500: {
|
|
7680
8004
|
headers: {
|
|
@@ -8491,6 +8815,7 @@ interface paths {
|
|
|
8491
8815
|
fileSize: number;
|
|
8492
8816
|
createdAt: string;
|
|
8493
8817
|
url: string;
|
|
8818
|
+
originalUrl: string;
|
|
8494
8819
|
inUse: boolean;
|
|
8495
8820
|
}[];
|
|
8496
8821
|
past: {
|
|
@@ -8518,6 +8843,7 @@ interface paths {
|
|
|
8518
8843
|
fileSize: number;
|
|
8519
8844
|
createdAt: string;
|
|
8520
8845
|
url: string;
|
|
8846
|
+
originalUrl: string;
|
|
8521
8847
|
inUse: boolean;
|
|
8522
8848
|
};
|
|
8523
8849
|
referencingRevisions: {
|
|
@@ -8666,6 +8992,7 @@ interface paths {
|
|
|
8666
8992
|
fileSize: number;
|
|
8667
8993
|
createdAt: string;
|
|
8668
8994
|
url: string;
|
|
8995
|
+
originalUrl: string;
|
|
8669
8996
|
inUse: boolean;
|
|
8670
8997
|
}[];
|
|
8671
8998
|
};
|
|
@@ -8788,6 +9115,7 @@ interface paths {
|
|
|
8788
9115
|
fileSize: number;
|
|
8789
9116
|
createdAt: string;
|
|
8790
9117
|
url: string;
|
|
9118
|
+
originalUrl: string;
|
|
8791
9119
|
inUse: boolean;
|
|
8792
9120
|
};
|
|
8793
9121
|
url: string;
|
|
@@ -9093,6 +9421,7 @@ interface paths {
|
|
|
9093
9421
|
fileSize: number;
|
|
9094
9422
|
createdAt: string;
|
|
9095
9423
|
url: string;
|
|
9424
|
+
originalUrl: string;
|
|
9096
9425
|
};
|
|
9097
9426
|
};
|
|
9098
9427
|
};
|
|
@@ -10093,6 +10422,7 @@ interface paths {
|
|
|
10093
10422
|
/** @enum {string} */
|
|
10094
10423
|
registrationMode: "Open" | "Resricted" | "Closed";
|
|
10095
10424
|
registrationWhiteList: string[];
|
|
10425
|
+
linkCardEnabled: boolean;
|
|
10096
10426
|
};
|
|
10097
10427
|
};
|
|
10098
10428
|
};
|
|
@@ -10162,6 +10492,7 @@ interface paths {
|
|
|
10162
10492
|
/** @enum {string} */
|
|
10163
10493
|
registrationMode: "Open" | "Resricted" | "Closed";
|
|
10164
10494
|
registrationWhiteList: string[];
|
|
10495
|
+
linkCardEnabled: boolean;
|
|
10165
10496
|
};
|
|
10166
10497
|
};
|
|
10167
10498
|
};
|
|
@@ -10176,6 +10507,7 @@ interface paths {
|
|
|
10176
10507
|
/** @enum {string} */
|
|
10177
10508
|
registrationMode: "Open" | "Resricted" | "Closed";
|
|
10178
10509
|
registrationWhiteList: string[];
|
|
10510
|
+
linkCardEnabled: boolean;
|
|
10179
10511
|
};
|
|
10180
10512
|
};
|
|
10181
10513
|
};
|
|
@@ -13625,6 +13957,12 @@ interface components {
|
|
|
13625
13957
|
/** @enum {string} */
|
|
13626
13958
|
status: "approved" | "denied";
|
|
13627
13959
|
};
|
|
13960
|
+
ClientInfoResponse: {
|
|
13961
|
+
clientId: string;
|
|
13962
|
+
name: string;
|
|
13963
|
+
firstParty: boolean;
|
|
13964
|
+
trusted: boolean;
|
|
13965
|
+
};
|
|
13628
13966
|
UserPublic: {
|
|
13629
13967
|
_id: string;
|
|
13630
13968
|
id?: string;
|
|
@@ -14579,6 +14917,7 @@ interface components {
|
|
|
14579
14917
|
fileSize: number;
|
|
14580
14918
|
createdAt: string;
|
|
14581
14919
|
url: string;
|
|
14920
|
+
originalUrl: string;
|
|
14582
14921
|
inUse: boolean;
|
|
14583
14922
|
};
|
|
14584
14923
|
AttachmentMeta: {
|
|
@@ -14605,6 +14944,7 @@ interface components {
|
|
|
14605
14944
|
fileSize: number;
|
|
14606
14945
|
createdAt: string;
|
|
14607
14946
|
url: string;
|
|
14947
|
+
originalUrl: string;
|
|
14608
14948
|
};
|
|
14609
14949
|
ListAttachmentsResponse: {
|
|
14610
14950
|
attachments: {
|
|
@@ -14631,6 +14971,7 @@ interface components {
|
|
|
14631
14971
|
fileSize: number;
|
|
14632
14972
|
createdAt: string;
|
|
14633
14973
|
url: string;
|
|
14974
|
+
originalUrl: string;
|
|
14634
14975
|
inUse: boolean;
|
|
14635
14976
|
}[];
|
|
14636
14977
|
};
|
|
@@ -14659,6 +15000,7 @@ interface components {
|
|
|
14659
15000
|
fileSize: number;
|
|
14660
15001
|
createdAt: string;
|
|
14661
15002
|
url: string;
|
|
15003
|
+
originalUrl: string;
|
|
14662
15004
|
inUse: boolean;
|
|
14663
15005
|
};
|
|
14664
15006
|
referencingRevisions: {
|
|
@@ -14706,6 +15048,7 @@ interface components {
|
|
|
14706
15048
|
fileSize: number;
|
|
14707
15049
|
createdAt: string;
|
|
14708
15050
|
url: string;
|
|
15051
|
+
originalUrl: string;
|
|
14709
15052
|
inUse: boolean;
|
|
14710
15053
|
}[];
|
|
14711
15054
|
past: {
|
|
@@ -14733,6 +15076,7 @@ interface components {
|
|
|
14733
15076
|
fileSize: number;
|
|
14734
15077
|
createdAt: string;
|
|
14735
15078
|
url: string;
|
|
15079
|
+
originalUrl: string;
|
|
14736
15080
|
inUse: boolean;
|
|
14737
15081
|
};
|
|
14738
15082
|
referencingRevisions: {
|
|
@@ -15165,7 +15509,7 @@ interface components {
|
|
|
15165
15509
|
};
|
|
15166
15510
|
};
|
|
15167
15511
|
/** @enum {string} */
|
|
15168
|
-
Capability: "oauth" | "oauth:auth-code" | "oauth:device" | "oauth:pkce" | "pat" | "pages" | "comments" | "bookmarks" | "attachments" | "notifications" | "search" | "collab" | "collab:redis";
|
|
15512
|
+
Capability: "oauth" | "oauth:auth-code" | "oauth:device" | "oauth:pkce" | "pat" | "pages" | "comments" | "bookmarks" | "attachments" | "notifications" | "search" | "collab" | "collab:redis" | "link-card";
|
|
15169
15513
|
};
|
|
15170
15514
|
responses: never;
|
|
15171
15515
|
parameters: never;
|