@payloadcms/figma 0.0.1-alpha.41 → 0.0.1-alpha.43

package/dist/db-content-api/generated/content-api-types.d.ts

@@ -2837,7 +2837,7 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
-    '/api/v0/uploads/{filename}': {
+    '/api/v0/uploads/{collectionId}/{filename}': {
         parameters: {
             query?: never;
             header?: never;
@@ -2852,6 +2852,7 @@ export type paths = {
                 query?: never;
                 header?: never;
                 path: {
+                    collectionId: string;
                     filename: string;
                 };
                 cookie?: never;
@@ -2934,140 +2935,6 @@ export type paths = {
         patch?: never;
         trace?: never;
     };
-    '/.well-known/jwks.json': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description JSON Web Key Set */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        'application/json': components['schemas']['JwksResponse'];
-                    };
-                };
-                /** @description Internal Server Error - Key not found */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        'application/json': {
-                            message: string;
-                        };
-                    };
-                };
-            };
-        };
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/dev/jwt': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: {
-                content: {
-                    'application/json': components['schemas']['CreateJwtRequest'];
-                };
-            };
-            responses: {
-                /** @description JWT created successfully */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        'application/json': components['schemas']['CreateJwtResponse'];
-                    };
-                };
-                /** @description Internal Server Error - Private key not found */
-                500: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        'application/json': {
-                            message: string;
-                        };
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
-    '/dev/clear-db': {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        get?: never;
-        put?: never;
-        post: {
-            parameters: {
-                query?: never;
-                header?: never;
-                path?: never;
-                cookie?: never;
-            };
-            requestBody?: never;
-            responses: {
-                /** @description Database cleared successfully */
-                200: {
-                    headers: {
-                        [name: string]: unknown;
-                    };
-                    content: {
-                        'application/json': {
-                            message: string;
-                            success: boolean;
-                        };
-                    };
-                };
-            };
-        };
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
 };
 export type webhooks = Record<string, never>;
 export type components = {
@@ -3310,6 +3177,23 @@ export type components = {
                 count: number;
             };
         };
+        /**
+         * @example array
+         * @enum {string}
+         */
+        PathType: 'array';
+        /**
+         * @example {
+         *       "author.tagIds": "array"
+         *     }
+         */
+        PathTypesMeta: {
+            [key: string]: components['schemas']['PathType'];
+        };
+        RequestMeta: {
+            localizedPaths?: string[];
+            pathTypes?: components['schemas']['PathTypesMeta'];
+        };
         DataValue: string | number | boolean | unknown | components['schemas']['DataValue'][] | {
             [key: string]: components['schemas']['DataValue'];
         } | unknown;
@@ -3342,43 +3226,34 @@ export type components = {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
+            meta?: components['schemas']['RequestMeta'];
             where?: components['schemas']['WhereClause'];
         };
         /**
          * @example {
+         *       "id": "doc-key",
          *       "title": "Placeholder title",
-         *       "content": "This is placeholder content"
+         *       "content": "This is placeholder content",
+         *       "createdAt": "2024-01-01T00:00:00Z",
+         *       "updatedAt": "2024-01-02T00:00:00Z",
+         *       "deletedAt": "2024-01-05T00:00:00Z"
          *     }
          */
         DocumentData: {
             [key: string]: components['schemas']['DataValue'];
         };
         Document: {
-            /** @example doc-key */
-            id: string;
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
-            data: components['schemas']['DocumentData'];
-            /**
-             * Format: date
-             * @example 2024-01-01T00:00:00Z
-             */
-            createdAt: string;
-            /**
-             * Format: date
-             * @example 2024-01-01T00:00:00Z
-             */
-            updatedAt: string;
+            collection: string;
+            doc: components['schemas']['DocumentData'];
         };
         CreateDocumentResponse: {
-            result: {
-                /** @example doc-xxxxx-xxxxx */
+            result: components['schemas']['Document'] & {
+                /** @example doc-key */
                 id: string;
-            } | {
-                data: components['schemas']['Document'];
             };
         };
         /** @example createdAt */
@@ -3396,7 +3271,7 @@ export type components = {
          *           "value": "published"
          *         },
          *         "limit": 5,
-         *         "offset": 0,
+         *         "page": 1,
          *         "sort": [
          *           {
          *             "path": "title",
@@ -3413,14 +3288,11 @@ export type components = {
             count: boolean;
             where?: components['schemas']['WhereClause'];
             limit?: number;
-            offset?: number;
+            page?: number;
             sort?: components['schemas']['SortClause'];
         }[];
-        LocaleClause: {
-            locale: string;
-            fallbackLocale: string;
-            paths: string[];
-        };
+        /** @example es */
+        LocaleClause: string;
         /**
          * @example {
          *       "mode": "include",
@@ -3440,61 +3312,43 @@ export type components = {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
-            /** @example doc-key */
-            id: string;
-            data: components['schemas']['DocumentData'];
+            collection: string;
+            doc: components['schemas']['DocumentData'];
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
                 locale?: components['schemas']['LocaleClause'];
                 select?: components['schemas']['SelectClause'];
             };
         };
-        /**
-         * @example {
-         *       "total": 100,
-         *       "current": {
-         *         "limit": 10,
-         *         "page": 1
-         *       },
-         *       "next": {
-         *         "limit": 10,
-         *         "page": 2
-         *       }
-         *     }
-         */
-        Pagination: {
-            total: number;
-            current: {
-                limit: number;
-                page: number;
-            };
-            next?: {
-                limit: number;
-                page: number;
-            };
-            prev?: {
-                limit: number;
-                page: number;
-            };
-        };
         FindDocumentsResponse: {
             result: {
-                data: components['schemas']['Document'][];
-                pagination: components['schemas']['Pagination'];
+                data: (components['schemas']['Document'] & {
+                    /** @example doc-key */
+                    id: string;
+                })[];
+                totalDocs: number;
+                limit: number;
+                page: number;
+                totalPages: number;
+                pagingCounter: number;
+                hasPrevPage: boolean;
+                hasNextPage: boolean;
+                prevPage: number | null;
+                nextPage: number | null;
             };
         };
         FindDocumentsRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
             join?: components['schemas']['JoinClause'];
             /** @example 10 */
             limit?: number;
             locale?: components['schemas']['LocaleClause'];
             /** @example 1 */
             page?: number;
+            meta?: components['schemas']['RequestMeta'];
             select?: components['schemas']['SelectClause'];
             sort?: components['schemas']['SortClause'];
             where?: components['schemas']['WhereClause'];
@@ -3504,7 +3358,10 @@ export type components = {
                 /** @example 1 */
                 count: number;
             } | {
-                data: components['schemas']['Document'][];
+                data: (components['schemas']['Document'] & {
+                    /** @example doc-key */
+                    id: string;
+                })[];
             };
         };
         /**
@@ -3523,41 +3380,46 @@ export type components = {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
             /** @example false */
             createOnMissing: false | {
                 id: string;
             };
-            data: components['schemas']['DataWithOperations'];
-            where: components['schemas']['WhereClause'];
+            doc: components['schemas']['DataWithOperations'];
             /** @example 10 */
             limit?: number;
-            sort?: components['schemas']['SortClause'];
+            meta?: components['schemas']['RequestMeta'];
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
                 locale?: components['schemas']['LocaleClause'];
                 select?: components['schemas']['SelectClause'];
             };
+            sort?: components['schemas']['SortClause'];
+            where: components['schemas']['WhereClause'];
         };
         DeleteDocumentResponse: {
             result?: {
                 /** @example 1 */
                 count: number;
             } | {
-                data: components['schemas']['Document'][];
+                data: (components['schemas']['Document'] & {
+                    /** @example doc-key */
+                    id: string;
+                })[];
             };
         };
         DeleteDocumentRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
-            where: components['schemas']['WhereClause'];
+            collection: string;
+            meta?: components['schemas']['RequestMeta'];
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
                 locale?: components['schemas']['LocaleClause'];
                 select?: components['schemas']['SelectClause'];
             };
+            where: components['schemas']['WhereClause'];
         };
         CountDocumentVersionResponse: {
             result: {
@@ -3569,48 +3431,68 @@ export type components = {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
+            meta?: components['schemas']['RequestMeta'];
             where?: components['schemas']['WhereClause'];
         };
         DocumentVersion: {
-            /** @example ver-xxxxx-xxxxx */
-            id: string;
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
-            /** @example doc-key */
-            documentId: string;
-            /** @example true */
-            latest: boolean;
-            data: components['schemas']['DocumentData'];
-            /**
-             * Format: date
-             * @example 2024-01-01T00:00:00Z
-             */
-            createdAt: string;
-            /**
-             * Format: date
-             * @example 2024-01-01T00:00:00Z
-             */
-            updatedAt: string;
+            /** @example posts */
+            collection: string;
+            versionDoc: {
+                /** @example 2024-01-01T00:00:00Z */
+                createdAt?: string | null;
+                /** @example 2024-01-01T00:00:00Z */
+                updatedAt?: string | null;
+                /** @example true */
+                latest?: boolean;
+                /** @example doc-key */
+                parent?: string | number;
+                version: components['schemas']['DocumentData'] & unknown;
+                /** @example ver-xxxxx-xxxxx */
+                id: string;
+            };
         };
         CreateDocumentVersionResponse: {
-            result: {
+            result: components['schemas']['DocumentVersion'] & {
                 /** @example ver-xxxxx-xxxxx */
                 id: string;
-            } | {
-                data: components['schemas']['DocumentVersion'];
             };
         };
+        /**
+         * @example {
+         *       "contentSystemId": "cms-xxxxx-xxxxx",
+         *       "collection": "posts",
+         *       "versionDoc": {
+         *         "createdAt": "2024-01-01T00:00:00Z",
+         *         "updatedAt": "2024-01-01T00:00:00Z",
+         *         "latest": true,
+         *         "parent": "doc-key",
+         *         "version": {
+         *           "title": "Placeholder title",
+         *           "content": "This is placeholder content"
+         *         }
+         *       },
+         *       "returning": false
+         *     }
+         */
         CreateDocumentVersionRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
-            /** @example doc-key */
-            documentId: string;
-            /** @example true */
-            latest?: boolean;
-            data: components['schemas']['DocumentData'];
+            collection: string;
+            versionDoc: {
+                /** @example 2024-01-01T00:00:00Z */
+                createdAt?: string | null;
+                /** @example 2024-01-01T00:00:00Z */
+                updatedAt?: string | null;
+                /** @example true */
+                latest?: boolean;
+                /** @example doc-key */
+                parent?: string | number;
+                version: components['schemas']['DocumentData'] & unknown;
+            };
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
                 locale?: components['schemas']['LocaleClause'];
@@ -3619,21 +3501,33 @@ export type components = {
         };
         FindDocumentVersionsResponse: {
             result: {
-                data: components['schemas']['DocumentVersion'][];
-                pagination: components['schemas']['Pagination'];
+                data: (components['schemas']['DocumentVersion'] & {
+                    /** @example ver-xxxxx-xxxxx */
+                    id: string;
+                })[];
+                totalDocs: number;
+                limit: number;
+                page: number;
+                totalPages: number;
+                pagingCounter: number;
+                hasPrevPage: boolean;
+                hasNextPage: boolean;
+                prevPage: number | null;
+                nextPage: number | null;
             };
         };
         FindDocumentVersionsRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
             join?: components['schemas']['JoinClause'];
             /** @example 10 */
             limit?: number;
             locale?: components['schemas']['LocaleClause'];
             /** @example 1 */
             page?: number;
+            meta?: components['schemas']['RequestMeta'];
             select?: components['schemas']['SelectClause'];
             sort?: components['schemas']['SortClause'];
             where?: components['schemas']['WhereClause'];
@@ -3643,23 +3537,37 @@ export type components = {
                 /** @example 1 */
                 count: number;
             } | {
-                data: components['schemas']['DocumentVersion'][];
+                data: (components['schemas']['DocumentVersion'] & {
+                    /** @example ver-xxxxx-xxxxx */
+                    id: string;
+                })[];
             };
         };
         UpdateDocumentVersionRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
+            collection: string;
             /** @example false */
             createOnMissing: false | {
-                documentId: string;
+                parent: string;
                 latest: boolean;
             };
-            data: components['schemas']['DataWithOperations'];
+            versionDoc: {
+                /** @example 2024-01-01T00:00:00Z */
+                createdAt?: string | null;
+                /** @example 2024-01-01T00:00:00Z */
+                updatedAt?: string | null;
+                /** @example true */
+                latest?: boolean;
+                /** @example doc-key */
+                parent?: string | number;
+                version: components['schemas']['DocumentData'] & unknown;
+            };
             where: components['schemas']['WhereClause'];
             /** @example 10 */
             limit?: number;
+            meta?: components['schemas']['RequestMeta'];
             sort?: components['schemas']['SortClause'];
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
@@ -3672,20 +3580,24 @@ export type components = {
                 /** @example 1 */
                 count: number;
             } | {
-                data: components['schemas']['DocumentVersion'][];
+                data: (components['schemas']['DocumentVersion'] & {
+                    /** @example ver-xxxxx-xxxxx */
+                    id: string;
+                })[];
             };
         };
         DeleteDocumentVersionRequest: {
             /** @example cms-xxxxx-xxxxx */
             contentSystemId: string;
             /** @example posts */
-            collectionId: string;
-            where: components['schemas']['WhereClause'];
+            collection: string;
+            meta?: components['schemas']['RequestMeta'];
             returning?: false | {
                 join?: components['schemas']['JoinClause'];
                 locale?: components['schemas']['LocaleClause'];
                 select?: components['schemas']['SelectClause'];
             };
+            where: components['schemas']['WhereClause'];
         };
         GeneratePresignedUploadUrlResponse: {
             /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
@@ -3701,6 +3613,8 @@ export type components = {
              * @example 3600
              */
             expiresIn: number;
+            /** @example media */
+            collectionId: string;
         };
         GeneratePresignedDownloadUrlResponse: {
             /** @example https://s3.amazonaws.com/bucket/key?presigned-params */
@@ -3714,6 +3628,8 @@ export type components = {
              * @example 3600
              */
             expiresIn: number;
+            /** @example media */
+            collectionId: string;
         };
         InitiateMultipartUploadResponse: {
             /** @example abc123xyz789 */
@@ -3724,6 +3640,8 @@ export type components = {
             filename: string;
             /** @example video/mp4 */
             contentType: string;
+            /** @example media */
+            collectionId: string;
         };
         GenerateUploadPartUrlsResponse: {
             /**
@@ -3759,6 +3677,8 @@ export type components = {
              * @example 3600
              */
             expiresIn: number;
+            /** @example media */
+            collectionId: string;
         };
         CompleteMultipartUploadResponse: {
             /**
@@ -3786,6 +3706,8 @@ export type components = {
                 /** @example "abc123" */
                 ETag: string;
             }[];
+            /** @example media */
+            collectionId: string;
         };
         AbortMultipartUploadResponse: {
             /**
@@ -3799,6 +3721,8 @@ export type components = {
             filename: string;
             /** @example abc123xyz789 */
             uploadId: string;
+            /** @example media */
+            collectionId: string;
         };
         DeleteFileResponse: {
             /**
@@ -3807,41 +3731,6 @@ export type components = {
              */
             success: true;
         };
-        JwksResponse: {
-            keys: {
-                /** @example RSA */
-                kty: string;
-                /** @example sig */
-                use: string;
-                /** @example dev-key-1 */
-                kid: string;
-                /** @example RS256 */
-                alg: string;
-                /** @example base64url-encoded-modulus */
-                n: string;
-                /** @example AQAB */
-                e: string;
-            }[];
-        };
-        CreateJwtResponse: {
-            /**
-             * @description Generated JWT token
-             * @example eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
-             */
-            token: string;
-            /**
-             * @description Token expiration time in seconds
-             * @example 604800
-             */
-            expires_in: number;
-        };
-        CreateJwtRequest: {
-            /**
-             * @description Content system ID to include in the JWT aud field
-             * @example 4cfea8de-4f44-4efd-a8fc-7d539249e9f1
-             */
-            content_system_id?: string;
-        };
     };
     responses: never;
     parameters: never;