@dotcms/ai 1.5.5-next.2270 → 1.5.5-next.2285

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/ai",
-  "version": "1.5.5-next.2270",
+  "version": "1.5.5-next.2285",
   "description": "The dotCMS agentic runtime — run model-written or human-written code safely against a dotCMS instance, with auth and policy owned in one place.",
   "repository": {
     "type": "git",

package/spec.cjs.js

@@ -989,7 +989,7 @@ var paths = {
 			requestBody: {
 				description: "Updated container configuration data including identifier and modified properties",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -1135,7 +1135,7 @@ var paths = {
 			requestBody: {
 				description: "Container configuration data including title, code, content type structures, and display settings",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -1747,11 +1747,11 @@ var paths = {
 					description: "Sort direction: choose between ascending or descending.",
 					schema: {
 						type: "string",
-						"default": "ASC",
 						"enum": [
 							"ASC",
 							"DESC"
-						]
+						],
+						"default": "ASC"
 					}
 				},
 				{
@@ -3149,61 +3149,41 @@ var paths = {
 			}
 		}
 	},
-	"/api/v1/folder/byPath": {
-		post: {
+	"/api/v1/folder/sitename/{siteName}/uri/{uri}": {
+		get: {
 			tags: [
 				"Folders"
 			],
-			summary: "Find subfolders by path",
-			description: "Retrieves subfolders of a given path, filtered by the path sent. The path format supports site-specific search (//siteName/path) or global search (/path). For example: '//default/folder1/' returns subfolder1, subfolder2 under folder1 in the 'default' site. '/folder1/s' returns all subfolders starting with 's' under folder1 across all sites.",
-			operationId: "findSubFoldersByPath",
+			summary: "Load a folder by site name and URI",
+			description: "Retrieves a folder by its URI path within the specified site.",
+			operationId: "loadFolderByURI",
 			parameters: [
 				{
-					name: "offset",
-					"in": "query",
-					description: "Number of results to skip for pagination. Must be >= 0.",
+					name: "siteName",
+					"in": "path",
+					required: true,
 					schema: {
-						type: "integer",
-						format: "int32",
-						"default": 0
+						type: "string"
 					}
 				},
 				{
-					name: "limit",
-					"in": "query",
-					description: "Maximum number of results to return. Default 40. Use -1 for unlimited (capped at 10000 as a safety limit).",
+					name: "uri",
+					"in": "path",
+					required: true,
 					schema: {
-						type: "integer",
-						format: "int32",
-						"default": 40
+						pattern: ".+",
+						type: "string"
 					}
 				}
 			],
-			requestBody: {
-				content: {
-					"*/*": {
-						schema: {
-							type: "object",
-							properties: {
-								path: {
-									type: "string"
-								}
-							}
-						}
-					}
-				}
-			},
 			responses: {
 				"200": {
-					description: "Subfolders retrieved successfully",
+					description: "Folder retrieved successfully",
 					content: {
 						"application/json": {
 						}
 					}
 				},
-				"400": {
-					description: "Path property must be sent"
-				},
 				"401": {
 					description: "Authentication required"
 				},
@@ -3211,54 +3191,117 @@ var paths = {
 					description: "Insufficient permissions"
 				},
 				"404": {
-					description: "Site not found"
+					description: "Folder not found"
 				}
 			}
 		}
 	},
-	"/api/v1/folder/sitename/{siteName}/uri/{uri}": {
+	"/api/v1/folder/search": {
 		get: {
 			tags: [
 				"Folders"
 			],
-			summary: "Load a folder by site name and URI",
-			description: "Retrieves a folder by its URI path within the specified site.",
-			operationId: "loadFolderByURI",
+			summary: "Search folders",
+			description: "Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned.",
+			operationId: "searchFolders",
 			parameters: [
 				{
-					name: "siteName",
-					"in": "path",
-					required: true,
+					name: "name",
+					"in": "query",
+					description: "Optional case-insensitive partial match on folder name (minimum 3 characters when provided)",
 					schema: {
 						type: "string"
 					}
 				},
 				{
-					name: "uri",
-					"in": "path",
-					required: true,
+					name: "path",
+					"in": "query",
+					description: "Path scope for the search. Defaults to '/' (site root).",
+					schema: {
+						type: "string",
+						"default": "/"
+					}
+				},
+				{
+					name: "recursive",
+					"in": "query",
+					description: "false = direct children of 'path' only (default); true = search all descendants",
+					schema: {
+						type: "boolean",
+						"default": false
+					}
+				},
+				{
+					name: "siteId",
+					"in": "query",
+					description: "Site ID to scope the search (required)",
 					schema: {
-						pattern: ".+",
 						type: "string"
 					}
+				},
+				{
+					name: "orderby",
+					"in": "query",
+					description: "Column to sort by.",
+					schema: {
+						type: "string",
+						"enum": [
+							"name",
+							"mod_date"
+						],
+						"default": "name"
+					}
+				},
+				{
+					name: "direction",
+					"in": "query",
+					description: "Sort direction",
+					schema: {
+						type: "string",
+						"enum": [
+							"ASC",
+							"DESC"
+						],
+						"default": "ASC"
+					}
+				},
+				{
+					name: "page",
+					"in": "query",
+					description: "Page number (1-based, default 1)",
+					schema: {
+						type: "integer",
+						format: "int32",
+						"default": 1
+					}
+				},
+				{
+					name: "per_page",
+					"in": "query",
+					description: "Number of results per page (default 40)",
+					schema: {
+						type: "integer",
+						format: "int32",
+						"default": 40
+					}
 				}
 			],
 			responses: {
 				"200": {
-					description: "Folder retrieved successfully",
+					description: "Paginated list of matching folders",
 					content: {
 						"application/json": {
 						}
 					}
 				},
-				"401": {
-					description: "Authentication required"
+				"400": {
+					description: "'siteId' is required; 'name' must be at least 3 characters if provided"
 				},
-				"403": {
-					description: "Insufficient permissions"
+				"401": {
+					description: "User is not authenticated"
 				},
-				"404": {
-					description: "Folder not found"
+				"500": {
+					description: "Internal server error"
 				}
 			}
 		}
@@ -5218,8 +5261,9 @@ var paths = {
 				}
 			],
 			requestBody: {
+				description: "Updated site properties. 'siteName' (the hostname) is required.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							type: "object",
 							properties: {
@@ -5298,7 +5342,8 @@ var paths = {
 							}
 						}
 					}
-				}
+				},
+				required: true
 			},
 			responses: {
 				"200": {
@@ -5330,8 +5375,9 @@ var paths = {
 			description: "Creates a new site with the provided properties including hostname, aliases, tag storage, SEO settings, and optional site variables.",
 			operationId: "createSite",
 			requestBody: {
+				description: "Site properties to create. 'siteName' (the hostname) is required.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							type: "object",
 							properties: {
@@ -5410,7 +5456,8 @@ var paths = {
 							}
 						}
 					}
-				}
+				},
+				required: true
 			},
 			responses: {
 				"200": {
@@ -7639,7 +7686,7 @@ var paths = {
 			requestBody: {
 				description: "Template data to update. Must include the template identifier.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -7877,7 +7924,7 @@ var paths = {
 			requestBody: {
 				description: "Template data to create",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -10919,11 +10966,11 @@ var paths = {
 					description: "*Optional.* Case-insensitive parameter indicating how results are to be displayed.\n\nIn listing mode, all associated actions are returned; in editing mode (the default), it returns only the actions accessible to the contentlet's current workflow step.",
 					schema: {
 						type: "string",
-						"default": "EDITING",
 						"enum": [
 							"EDITING",
 							"LISTING"
-						]
+						],
+						"default": "EDITING"
 					}
 				}
 			],
@@ -14430,11 +14477,11 @@ var paths = {
 					description: "Asset version to retrieve. Accepted values: working (default), live.",
 					schema: {
 						type: "string",
-						"default": "working",
 						"enum": [
 							"working",
 							"live"
-						]
+						],
+						"default": "working"
 					},
 					example: "working"
 				}
@@ -14512,11 +14559,11 @@ var paths = {
 					description: "Asset version to retrieve. Accepted values: working (default), live.",
 					schema: {
 						type: "string",
-						"default": "working",
 						"enum": [
 							"working",
 							"live"
-						]
+						],
+						"default": "working"
 					},
 					example: "working"
 				}
@@ -15619,11 +15666,11 @@ var paths = {
 					description: "Export format",
 					schema: {
 						type: "string",
-						"default": "csv",
 						"enum": [
 							"csv",
 							"json"
-						]
+						],
+						"default": "csv"
 					},
 					example: "csv"
 				},

package/spec.esm.js

@@ -987,7 +987,7 @@ var paths = {
 			requestBody: {
 				description: "Updated container configuration data including identifier and modified properties",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -1133,7 +1133,7 @@ var paths = {
 			requestBody: {
 				description: "Container configuration data including title, code, content type structures, and display settings",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -1745,11 +1745,11 @@ var paths = {
 					description: "Sort direction: choose between ascending or descending.",
 					schema: {
 						type: "string",
-						"default": "ASC",
 						"enum": [
 							"ASC",
 							"DESC"
-						]
+						],
+						"default": "ASC"
 					}
 				},
 				{
@@ -3147,61 +3147,41 @@ var paths = {
 			}
 		}
 	},
-	"/api/v1/folder/byPath": {
-		post: {
+	"/api/v1/folder/sitename/{siteName}/uri/{uri}": {
+		get: {
 			tags: [
 				"Folders"
 			],
-			summary: "Find subfolders by path",
-			description: "Retrieves subfolders of a given path, filtered by the path sent. The path format supports site-specific search (//siteName/path) or global search (/path). For example: '//default/folder1/' returns subfolder1, subfolder2 under folder1 in the 'default' site. '/folder1/s' returns all subfolders starting with 's' under folder1 across all sites.",
-			operationId: "findSubFoldersByPath",
+			summary: "Load a folder by site name and URI",
+			description: "Retrieves a folder by its URI path within the specified site.",
+			operationId: "loadFolderByURI",
 			parameters: [
 				{
-					name: "offset",
-					"in": "query",
-					description: "Number of results to skip for pagination. Must be >= 0.",
+					name: "siteName",
+					"in": "path",
+					required: true,
 					schema: {
-						type: "integer",
-						format: "int32",
-						"default": 0
+						type: "string"
 					}
 				},
 				{
-					name: "limit",
-					"in": "query",
-					description: "Maximum number of results to return. Default 40. Use -1 for unlimited (capped at 10000 as a safety limit).",
+					name: "uri",
+					"in": "path",
+					required: true,
 					schema: {
-						type: "integer",
-						format: "int32",
-						"default": 40
+						pattern: ".+",
+						type: "string"
 					}
 				}
 			],
-			requestBody: {
-				content: {
-					"*/*": {
-						schema: {
-							type: "object",
-							properties: {
-								path: {
-									type: "string"
-								}
-							}
-						}
-					}
-				}
-			},
 			responses: {
 				"200": {
-					description: "Subfolders retrieved successfully",
+					description: "Folder retrieved successfully",
 					content: {
 						"application/json": {
 						}
 					}
 				},
-				"400": {
-					description: "Path property must be sent"
-				},
 				"401": {
 					description: "Authentication required"
 				},
@@ -3209,54 +3189,117 @@ var paths = {
 					description: "Insufficient permissions"
 				},
 				"404": {
-					description: "Site not found"
+					description: "Folder not found"
 				}
 			}
 		}
 	},
-	"/api/v1/folder/sitename/{siteName}/uri/{uri}": {
+	"/api/v1/folder/search": {
 		get: {
 			tags: [
 				"Folders"
 			],
-			summary: "Load a folder by site name and URI",
-			description: "Retrieves a folder by its URI path within the specified site.",
-			operationId: "loadFolderByURI",
+			summary: "Search folders",
+			description: "Returns folders within a site matching an optional name filter and/or path scope. Supports recursive depth control, standard pagination, and sorting. With no 'name' and default path '/' + recursive=true, all site folders are returned.",
+			operationId: "searchFolders",
 			parameters: [
 				{
-					name: "siteName",
-					"in": "path",
-					required: true,
+					name: "name",
+					"in": "query",
+					description: "Optional case-insensitive partial match on folder name (minimum 3 characters when provided)",
 					schema: {
 						type: "string"
 					}
 				},
 				{
-					name: "uri",
-					"in": "path",
-					required: true,
+					name: "path",
+					"in": "query",
+					description: "Path scope for the search. Defaults to '/' (site root).",
+					schema: {
+						type: "string",
+						"default": "/"
+					}
+				},
+				{
+					name: "recursive",
+					"in": "query",
+					description: "false = direct children of 'path' only (default); true = search all descendants",
+					schema: {
+						type: "boolean",
+						"default": false
+					}
+				},
+				{
+					name: "siteId",
+					"in": "query",
+					description: "Site ID to scope the search (required)",
 					schema: {
-						pattern: ".+",
 						type: "string"
 					}
+				},
+				{
+					name: "orderby",
+					"in": "query",
+					description: "Column to sort by.",
+					schema: {
+						type: "string",
+						"enum": [
+							"name",
+							"mod_date"
+						],
+						"default": "name"
+					}
+				},
+				{
+					name: "direction",
+					"in": "query",
+					description: "Sort direction",
+					schema: {
+						type: "string",
+						"enum": [
+							"ASC",
+							"DESC"
+						],
+						"default": "ASC"
+					}
+				},
+				{
+					name: "page",
+					"in": "query",
+					description: "Page number (1-based, default 1)",
+					schema: {
+						type: "integer",
+						format: "int32",
+						"default": 1
+					}
+				},
+				{
+					name: "per_page",
+					"in": "query",
+					description: "Number of results per page (default 40)",
+					schema: {
+						type: "integer",
+						format: "int32",
+						"default": 40
+					}
 				}
 			],
 			responses: {
 				"200": {
-					description: "Folder retrieved successfully",
+					description: "Paginated list of matching folders",
 					content: {
 						"application/json": {
 						}
 					}
 				},
-				"401": {
-					description: "Authentication required"
+				"400": {
+					description: "'siteId' is required; 'name' must be at least 3 characters if provided"
 				},
-				"403": {
-					description: "Insufficient permissions"
+				"401": {
+					description: "User is not authenticated"
 				},
-				"404": {
-					description: "Folder not found"
+				"500": {
+					description: "Internal server error"
 				}
 			}
 		}
@@ -5216,8 +5259,9 @@ var paths = {
 				}
 			],
 			requestBody: {
+				description: "Updated site properties. 'siteName' (the hostname) is required.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							type: "object",
 							properties: {
@@ -5296,7 +5340,8 @@ var paths = {
 							}
 						}
 					}
-				}
+				},
+				required: true
 			},
 			responses: {
 				"200": {
@@ -5328,8 +5373,9 @@ var paths = {
 			description: "Creates a new site with the provided properties including hostname, aliases, tag storage, SEO settings, and optional site variables.",
 			operationId: "createSite",
 			requestBody: {
+				description: "Site properties to create. 'siteName' (the hostname) is required.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							type: "object",
 							properties: {
@@ -5408,7 +5454,8 @@ var paths = {
 							}
 						}
 					}
-				}
+				},
+				required: true
 			},
 			responses: {
 				"200": {
@@ -7637,7 +7684,7 @@ var paths = {
 			requestBody: {
 				description: "Template data to update. Must include the template identifier.",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -7875,7 +7922,7 @@ var paths = {
 			requestBody: {
 				description: "Template data to create",
 				content: {
-					"*/*": {
+					"application/json": {
 						schema: {
 							required: [
 								"title"
@@ -10917,11 +10964,11 @@ var paths = {
 					description: "*Optional.* Case-insensitive parameter indicating how results are to be displayed.\n\nIn listing mode, all associated actions are returned; in editing mode (the default), it returns only the actions accessible to the contentlet's current workflow step.",
 					schema: {
 						type: "string",
-						"default": "EDITING",
 						"enum": [
 							"EDITING",
 							"LISTING"
-						]
+						],
+						"default": "EDITING"
 					}
 				}
 			],
@@ -14428,11 +14475,11 @@ var paths = {
 					description: "Asset version to retrieve. Accepted values: working (default), live.",
 					schema: {
 						type: "string",
-						"default": "working",
 						"enum": [
 							"working",
 							"live"
-						]
+						],
+						"default": "working"
 					},
 					example: "working"
 				}
@@ -14510,11 +14557,11 @@ var paths = {
 					description: "Asset version to retrieve. Accepted values: working (default), live.",
 					schema: {
 						type: "string",
-						"default": "working",
 						"enum": [
 							"working",
 							"live"
-						]
+						],
+						"default": "working"
 					},
 					example: "working"
 				}
@@ -15617,11 +15664,11 @@ var paths = {
 					description: "Export format",
 					schema: {
 						type: "string",
-						"default": "csv",
 						"enum": [
 							"csv",
 							"json"
-						]
+						],
+						"default": "csv"
 					},
 					example: "csv"
 				},