aboutsummaryrefslogtreecommitdiff
path: root/api/paths.yaml
diff options
context:
space:
mode:
authorBruce Hill <bruce@bruce-hill.com>2025-11-27 12:05:49 -0500
committerBruce Hill <bruce@bruce-hill.com>2025-11-27 12:07:34 -0500
commit437be558a893ac70c030794df99a866e8ed01879 (patch)
tree63126858e06f14db9e23306d7d9d4c7e25f3f421 /api/paths.yaml
parent35053e65b946264715aca2b348ee25313b55d2f6 (diff)
Add `recursive` arg to Path.create_directory()
Diffstat (limited to 'api/paths.yaml')
-rw-r--r--api/paths.yaml7
1 files changed, 7 insertions, 0 deletions
diff --git a/api/paths.yaml b/api/paths.yaml
index 8fbd18dc..65d63671 100644
--- a/api/paths.yaml
+++ b/api/paths.yaml
@@ -258,6 +258,7 @@ Path.create_directory:
description: >
Creates a new directory at the specified path with the given permissions. If
any of the parent directories do not exist, they will be created as needed.
+ note: >
return:
type: 'Void'
description: >
@@ -271,6 +272,12 @@ Path.create_directory:
default: 'Int32(0o755)'
description: >
The permissions to set on the new directory.
+ recursive:
+ default: 'yes'
+ description: >
+ If set to `yes`, then recursively create any parent directories if they
+ don't exist, otherwise fail if the parent directory does not exist. When
+ set to `yes`, this function behaves like `mkdir -p`.
example: |
(./new_directory).create_directory()