@crowi/api-contract 2.0.0-alpha.6 → 2.0.0-alpha.8

package/dist/generated/openapi.d.mts

@@ -34,8 +34,9 @@ interface paths {
                             confidential: string | null;
                             version: string;
                             apiVersion: string;
-                            capabilities: string[];
+                            capabilities: components["schemas"]["Capability"][];
                             canSelfRegister: boolean;
+                            rendererStylesheets: string[];
                         };
                     };
                 };
@@ -2153,6 +2154,64 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/oauth/client-info": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Look up non-secret metadata for a registered OAuth client (authorize/consent screen) */
+        get: {
+            parameters: {
+                query: {
+                    client_id: string;
+                };
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Client metadata */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            clientId: string;
+                            name: string;
+                            firstParty: boolean;
+                            trusted: boolean;
+                        };
+                    };
+                };
+                /** @description No client registered with this client_id */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "NOT_FOUND";
+                                message: string;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/user/{username}": {
         parameters: {
             query?: never;
@@ -2903,6 +2962,246 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/user/{username}/subpages": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get pages under /user/{username}/ (path-rooted, fully recursive, paginated) */
+        get: {
+            parameters: {
+                query?: {
+                    limit?: number;
+                    offset?: number | null;
+                };
+                header?: never;
+                path: {
+                    username: string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Paginated subpages (path-ascending, `_id` tie-break) */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            pages: {
+                                _id: string;
+                                path: string;
+                                revision?: string | {
+                                    _id: string;
+                                    path: string;
+                                    body: string;
+                                    /** @default markdown */
+                                    format: string;
+                                    author?: {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    } | null;
+                                    createdAt: string;
+                                    meta?: {
+                                        toc?: {
+                                            level: number;
+                                            text: string;
+                                            anchorId: string;
+                                        }[];
+                                        wikiLinks?: {
+                                            raw: string;
+                                            target: string;
+                                            displayText?: string;
+                                        }[];
+                                        mentions?: {
+                                            username: string;
+                                        }[];
+                                        codeBlockLanguages?: string[];
+                                    };
+                                    renderedAst?: unknown;
+                                    rendererVersion?: string;
+                                    parentRevisionId?: string | null;
+                                    /** @enum {string} */
+                                    type?: "snapshot" | "incremental";
+                                    savedBy?: string | {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    } | null;
+                                    contributors?: (string | {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    })[];
+                                    message?: string;
+                                    /** @enum {string} */
+                                    editVia?: "web" | "oauth" | "pat";
+                                };
+                                redirectTo?: string | null;
+                                /** @enum {string|null} */
+                                status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
+                                grant?: number;
+                                grantedUsers?: string[];
+                                creator?: string | {
+                                    _id: string;
+                                    id?: string;
+                                    username: string;
+                                    name: string;
+                                    /** Format: email */
+                                    email: string;
+                                    image?: string | null;
+                                    createdAt: string;
+                                } | null;
+                                lastUpdateUser?: string | {
+                                    _id: string;
+                                    id?: string;
+                                    username: string;
+                                    name: string;
+                                    /** Format: email */
+                                    email: string;
+                                    image?: string | null;
+                                    createdAt: string;
+                                } | null;
+                                liker?: string[];
+                                /** @default 0 */
+                                commentCount: number;
+                                extended?: {
+                                    [key: string]: unknown;
+                                };
+                                createdAt: string;
+                                updatedAt?: string;
+                                currentRevision?: string | null;
+                                yjsCheckpointAt?: string | null;
+                                latestRevision?: string;
+                                likerCount?: number;
+                                seenUsersCount?: number;
+                            }[];
+                            pager: {
+                                prev: number | null;
+                                next: number | null;
+                                offset: number;
+                            };
+                            total: number;
+                        };
+                    };
+                };
+                /** @description Invalid limit/offset */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "VALIDATION_ERROR";
+                                message: string;
+                                details?: {
+                                    fieldErrors: {
+                                        [key: string]: string[];
+                                    };
+                                    formErrors: string[];
+                                };
+                            };
+                        };
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "AUTHENTICATION_REQUIRED";
+                                /** @enum {string} */
+                                message: "Authentication is required";
+                                redirectTo?: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Missing profile:read and/or pages:read scope */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "INSUFFICIENT_SCOPE";
+                                message: string;
+                                details?: {
+                                    requiredScope: string;
+                                };
+                            };
+                        };
+                    };
+                };
+                /** @description User not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "USER_NOT_FOUND";
+                                /** @enum {string} */
+                                message: "User not found";
+                            };
+                        };
+                    };
+                };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "INTERNAL_ERROR";
+                                /** @enum {string} */
+                                message: "Internal server error";
+                            };
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/users": {
         parameters: {
             query?: never;
@@ -3763,6 +4062,22 @@ interface paths {
                         };
                     };
                 };
+                /** @description Page not found or not granted */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "PAGE_NOT_FOUND";
+                                /** @enum {string} */
+                                message: "Page not found";
+                            };
+                        };
+                    };
+                };
             };
         };
         put?: never;
@@ -4686,6 +5001,22 @@ interface paths {
                         };
                     };
                 };
+                /** @description Internal server error */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "INTERNAL_ERROR";
+                                /** @enum {string} */
+                                message: "Internal server error";
+                            };
+                        };
+                    };
+                };
             };
         };
         /** Update existing page */
@@ -5663,6 +5994,17 @@ interface paths {
                                 isPage: boolean;
                                 hasPortal: boolean;
                                 count: number;
+                                lastUpdatedAt?: string | null;
+                                updater?: {
+                                    _id: string;
+                                    id?: string;
+                                    username: string;
+                                    name: string;
+                                    /** Format: email */
+                                    email: string;
+                                    image?: string | null;
+                                    createdAt: string;
+                                } | null;
                             }[];
                         };
                     };
@@ -6488,6 +6830,241 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/pages/link-access": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Resolve a page by id, granting first-time link-share access to GRANT_RESTRICTED pages */
+        post: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: {
+                content: {
+                    "application/json": {
+                        page_id: string;
+                    };
+                };
+            };
+            responses: {
+                /** @description The resolved page, with `granted` telling whether this call just added the caller to grantedUsers */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            page: {
+                                _id: string;
+                                path: string;
+                                revision: {
+                                    _id: string;
+                                    path: string;
+                                    body: string;
+                                    /** @default markdown */
+                                    format: string;
+                                    author?: {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    } | null;
+                                    createdAt: string;
+                                    meta?: {
+                                        toc?: {
+                                            level: number;
+                                            text: string;
+                                            anchorId: string;
+                                        }[];
+                                        wikiLinks?: {
+                                            raw: string;
+                                            target: string;
+                                            displayText?: string;
+                                        }[];
+                                        mentions?: {
+                                            username: string;
+                                        }[];
+                                        codeBlockLanguages?: string[];
+                                    };
+                                    renderedAst?: unknown;
+                                    rendererVersion?: string;
+                                    parentRevisionId?: string | null;
+                                    /** @enum {string} */
+                                    type?: "snapshot" | "incremental";
+                                    savedBy?: string | {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    } | null;
+                                    contributors?: (string | {
+                                        _id: string;
+                                        id?: string;
+                                        username: string;
+                                        name: string;
+                                        /** Format: email */
+                                        email: string;
+                                        image?: string | null;
+                                        createdAt: string;
+                                    })[];
+                                    message?: string;
+                                    /** @enum {string} */
+                                    editVia?: "web" | "oauth" | "pat";
+                                };
+                                redirectTo?: string | null;
+                                /** @enum {string|null} */
+                                status?: "wip" | "published" | "deleted" | "deprecated" | "draft" | null;
+                                grant?: number;
+                                grantedUsers?: string[];
+                                creator?: {
+                                    _id: string;
+                                    id?: string;
+                                    username: string;
+                                    name: string;
+                                    /** Format: email */
+                                    email: string;
+                                    image?: string | null;
+                                    createdAt: string;
+                                } | null;
+                                lastUpdateUser?: {
+                                    _id: string;
+                                    id?: string;
+                                    username: string;
+                                    name: string;
+                                    /** Format: email */
+                                    email: string;
+                                    image?: string | null;
+                                    createdAt: string;
+                                } | null;
+                                liker?: string[];
+                                /** @default 0 */
+                                commentCount: number;
+                                extended?: {
+                                    [key: string]: unknown;
+                                };
+                                createdAt: string;
+                                updatedAt?: string;
+                                currentRevision?: string | null;
+                                yjsCheckpointAt?: string | null;
+                                latestRevision?: string;
+                                likerCount?: number;
+                                seenUsersCount?: number;
+                            };
+                            granted: boolean;
+                        };
+                    };
+                };
+                /** @description Invalid page_id */
+                400: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "INVALID_PAGE_ID";
+                                message: string;
+                            };
+                        };
+                    };
+                };
+                /** @description Authentication required */
+                401: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "AUTHENTICATION_REQUIRED";
+                                /** @enum {string} */
+                                message: "Authentication is required";
+                                redirectTo?: string;
+                            };
+                        };
+                    };
+                };
+                /** @description The caller has no access to the page (isGrantedFor is false) or lacks scope / is a non-web session — 403 is about the caller lacking access, never about the page grant type per se */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "PAGE_NOT_GRANTED";
+                                /** @enum {string} */
+                                message: "Page is not granted for the user";
+                            };
+                        } | {
+                            error: {
+                                /** @enum {string} */
+                                code: "INSUFFICIENT_SCOPE";
+                                message: string;
+                                details?: {
+                                    requiredScope: string;
+                                };
+                            };
+                        };
+                    };
+                };
+                /** @description Page not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            error: {
+                                /** @enum {string} */
+                                code: "PAGE_NOT_FOUND";
+                                /** @enum {string} */
+                                message: "Page not found";
+                            };
+                        };
+                    };
+                };
+                /** @description Rate limit exceeded for POST /pages/link-access (per-user). Same wire shape as autocomplete rate limiting. */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {string} */
+                            error: "rate_limited";
+                            message: string;
+                            retryAfterSeconds: number;
+                        };
+                    };
+                };
+            };
+        };
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/pages/watch": {
         parameters: {
             query?: never;
@@ -7408,6 +7985,20 @@ interface paths {
                         };
                     };
                 };
+                /** @description Per-user rate limit exceeded */
+                429: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": {
+                            /** @enum {string} */
+                            error: "rate_limited";
+                            message: string;
+                            retryAfterSeconds: number;
+                        };
+                    };
+                };
                 /** @description Renderer pipeline failure */
                 500: {
                     headers: {
@@ -8224,6 +8815,7 @@ interface paths {
                                 fileSize: number;
                                 createdAt: string;
                                 url: string;
+                                originalUrl: string;
                                 inUse: boolean;
                             }[];
                             past: {
@@ -8251,6 +8843,7 @@ interface paths {
                                     fileSize: number;
                                     createdAt: string;
                                     url: string;
+                                    originalUrl: string;
                                     inUse: boolean;
                                 };
                                 referencingRevisions: {
@@ -8399,6 +8992,7 @@ interface paths {
                                 fileSize: number;
                                 createdAt: string;
                                 url: string;
+                                originalUrl: string;
                                 inUse: boolean;
                             }[];
                         };
@@ -8521,6 +9115,7 @@ interface paths {
                                 fileSize: number;
                                 createdAt: string;
                                 url: string;
+                                originalUrl: string;
                                 inUse: boolean;
                             };
                             url: string;
@@ -8826,6 +9421,7 @@ interface paths {
                             fileSize: number;
                             createdAt: string;
                             url: string;
+                            originalUrl: string;
                         };
                     };
                 };
@@ -9826,6 +10422,7 @@ interface paths {
                             /** @enum {string} */
                             registrationMode: "Open" | "Resricted" | "Closed";
                             registrationWhiteList: string[];
+                            linkCardEnabled: boolean;
                         };
                     };
                 };
@@ -9895,6 +10492,7 @@ interface paths {
                         /** @enum {string} */
                         registrationMode: "Open" | "Resricted" | "Closed";
                         registrationWhiteList: string[];
+                        linkCardEnabled: boolean;
                     };
                 };
             };
@@ -9909,6 +10507,7 @@ interface paths {
                             /** @enum {string} */
                             registrationMode: "Open" | "Resricted" | "Closed";
                             registrationWhiteList: string[];
+                            linkCardEnabled: boolean;
                         };
                     };
                 };
@@ -12176,6 +12775,7 @@ interface paths {
                                 name: string;
                                 version: string;
                                 requires?: string[];
+                                modelAccess?: string[];
                                 hasConfig: boolean;
                                 registers: string[];
                                 adminPlacement: {
@@ -12185,6 +12785,12 @@ interface paths {
                                     icon?: string;
                                 };
                                 supportsHotReload: boolean;
+                                /**
+                                 * @default active
+                                 * @enum {string}
+                                 */
+                                status: "active" | "failed";
+                                error?: string;
                             }[];
                         };
                     };
@@ -13351,6 +13957,12 @@ interface components {
             /** @enum {string} */
             status: "approved" | "denied";
         };
+        ClientInfoResponse: {
+            clientId: string;
+            name: string;
+            firstParty: boolean;
+            trusted: boolean;
+        };
         UserPublic: {
             _id: string;
             id?: string;
@@ -14305,6 +14917,7 @@ interface components {
             fileSize: number;
             createdAt: string;
             url: string;
+            originalUrl: string;
             inUse: boolean;
         };
         AttachmentMeta: {
@@ -14331,6 +14944,7 @@ interface components {
             fileSize: number;
             createdAt: string;
             url: string;
+            originalUrl: string;
         };
         ListAttachmentsResponse: {
             attachments: {
@@ -14357,6 +14971,7 @@ interface components {
                 fileSize: number;
                 createdAt: string;
                 url: string;
+                originalUrl: string;
                 inUse: boolean;
             }[];
         };
@@ -14385,6 +15000,7 @@ interface components {
                 fileSize: number;
                 createdAt: string;
                 url: string;
+                originalUrl: string;
                 inUse: boolean;
             };
             referencingRevisions: {
@@ -14432,6 +15048,7 @@ interface components {
                 fileSize: number;
                 createdAt: string;
                 url: string;
+                originalUrl: string;
                 inUse: boolean;
             }[];
             past: {
@@ -14459,6 +15076,7 @@ interface components {
                     fileSize: number;
                     createdAt: string;
                     url: string;
+                    originalUrl: string;
                     inUse: boolean;
                 };
                 referencingRevisions: {
@@ -14800,6 +15418,7 @@ interface components {
             name: string;
             version: string;
             requires?: string[];
+            modelAccess?: string[];
             hasConfig: boolean;
             registers: string[];
             adminPlacement: {
@@ -14809,12 +15428,19 @@ interface components {
                 icon?: string;
             };
             supportsHotReload: boolean;
+            /**
+             * @default active
+             * @enum {string}
+             */
+            status: "active" | "failed";
+            error?: string;
         };
         ListPluginsResponse: {
             plugins: {
                 name: string;
                 version: string;
                 requires?: string[];
+                modelAccess?: string[];
                 hasConfig: boolean;
                 registers: string[];
                 adminPlacement: {
@@ -14824,6 +15450,12 @@ interface components {
                     icon?: string;
                 };
                 supportsHotReload: boolean;
+                /**
+                 * @default active
+                 * @enum {string}
+                 */
+                status: "active" | "failed";
+                error?: string;
             }[];
         };
         PluginConfigResponse: {
@@ -14876,6 +15508,8 @@ interface components {
                 }[];
             };
         };
+        /** @enum {string} */
+        Capability: "oauth" | "oauth:auth-code" | "oauth:device" | "oauth:pkce" | "pat" | "pages" | "comments" | "bookmarks" | "attachments" | "notifications" | "search" | "collab" | "collab:redis" | "link-card";
     };
     responses: never;
     parameters: never;