@synopackageland/sdk 0.0.0-stage → 0.9.1

package/spec/protocol/v1/schema/delegate.create.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/delegate.create.json",
+  "title": "delegate.create",
+  "description": "Create a time-limited grant (job_id, ttl_seconds) or an until-revoked destination grant (destination, lifetime).",
+  "since": "0.9.0",
+  "auth": "required",
+  "type": "object",
+  "properties": {
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "ops": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "string",
+        "pattern": "^files\\."
+      }
+    },
+    "scope": {
+      "type": "string"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "ttl_seconds": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 2592000
+    },
+    "destination": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9_-]{0,63}$"
+    },
+    "lifetime": {
+      "const": "until-revoked"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "ops",
+    "scope",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/delegate.disable.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/delegate.disable.json",
+  "title": "delegate.disable",
+  "description": "Administrator: turn the integration off and cancel grants.",
+  "since": "0.9.0",
+  "auth": "required",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/spec/protocol/v1/schema/delegate.enable.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/delegate.enable.json",
+  "title": "delegate.enable",
+  "description": "Administrator: turn the integration on.",
+  "since": "0.9.0",
+  "auth": "required",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/spec/protocol/v1/schema/delegate.list.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/delegate.list.json",
+  "title": "delegate.list",
+  "description": "List the caller's grants for this package.",
+  "since": "0.9.0",
+  "auth": "required",
+  "type": "object",
+  "properties": {},
+  "additionalProperties": false
+}

package/spec/protocol/v1/schema/delegate.revoke.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/delegate.revoke.json",
+  "title": "delegate.revoke",
+  "description": "Revoke a grant: with auth by its owner (or an administrator for time-limited grants), without auth by job_id.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id"
+  ]
+}

package/spec/protocol/v1/schema/files.cancelOperation.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.cancelOperation.json",
+  "title": "files.cancelOperation",
+  "description": "Cancel an asynchronous operation.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id"
+  ]
+}

package/spec/protocol/v1/schema/files.checkPermission.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.checkPermission.json",
+  "title": "files.checkPermission",
+  "description": "Check write permission for the delegated user.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/files.copy.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.copy.json",
+  "title": "files.copy",
+  "description": "Start a File Station copy task.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "dest_dir": {
+      "type": "string",
+      "pattern": "^/"
+    },
+    "conflict": {
+      "enum": [
+        "fail",
+        "overwrite",
+        "rename"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path",
+    "dest_dir"
+  ]
+}

package/spec/protocol/v1/schema/files.createFolder.json

@@ -0,0 +1,38 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.createFolder.json",
+  "title": "files.createFolder",
+  "description": "Create a folder; parents creates missing ancestors in scope.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "parents": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path",
+    "name"
+  ]
+}

package/spec/protocol/v1/schema/files.delete.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.delete.json",
+  "title": "files.delete",
+  "description": "Start a File Station delete task.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "recursive": {
+      "type": "boolean"
+    },
+    "permanent": {
+      "type": "boolean"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/files.info.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.info.json",
+  "title": "files.info",
+  "description": "Describe a path as the delegated user.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/files.list.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.list.json",
+  "title": "files.list",
+  "description": "List a folder as the delegated user.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/files.move.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.move.json",
+  "title": "files.move",
+  "description": "Start a File Station move task.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "dest_dir": {
+      "type": "string",
+      "pattern": "^/"
+    },
+    "conflict": {
+      "enum": [
+        "fail",
+        "overwrite",
+        "rename"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path",
+    "dest_dir"
+  ]
+}

package/spec/protocol/v1/schema/files.moveFromStaging.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.moveFromStaging.json",
+  "title": "files.moveFromStaging",
+  "description": "Admit an asynchronous move from staging into an until-revoked destination.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "staging": {
+      "type": "string",
+      "minLength": 1
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "size": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 17179869184
+    },
+    "conflict": {
+      "enum": [
+        "fail",
+        "overwrite",
+        "rename"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "staging",
+    "name",
+    "size"
+  ]
+}

package/spec/protocol/v1/schema/files.operationStatus.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.operationStatus.json",
+  "title": "files.operationStatus",
+  "description": "Read an asynchronous operation.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id"
+  ]
+}

package/spec/protocol/v1/schema/files.read.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.read.json",
+  "title": "files.read",
+  "description": "Copy a file into staging as the delegated user.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "max_bytes": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 67108864
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path"
+  ]
+}

package/spec/protocol/v1/schema/files.rename.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.rename.json",
+  "title": "files.rename",
+  "description": "Rename through File Station as the delegated user.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "path": {
+      "type": "string",
+      "pattern": "^/",
+      "maxLength": 4096
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "path",
+    "name"
+  ]
+}

package/spec/protocol/v1/schema/files.taskCancel.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.taskCancel.json",
+  "title": "files.taskCancel",
+  "description": "Cancel a copy, move or delete task.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "task_id": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "task_id"
+  ]
+}

package/spec/protocol/v1/schema/files.taskStatus.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.taskStatus.json",
+  "title": "files.taskStatus",
+  "description": "Status of a copy, move or delete task.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "task_id": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "task_id"
+  ]
+}

package/spec/protocol/v1/schema/files.write.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/files.write.json",
+  "title": "files.write",
+  "description": "Publish a staged file synchronously.",
+  "since": "0.9.0",
+  "auth": "optional",
+  "type": "object",
+  "properties": {
+    "delegation_id": {
+      "type": "string",
+      "pattern": "^[a-f0-9]{64}$"
+    },
+    "job_id": {
+      "type": "string",
+      "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$"
+    },
+    "staging": {
+      "type": "string",
+      "minLength": 1
+    },
+    "dest_dir": {
+      "type": "string",
+      "pattern": "^/"
+    },
+    "name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "conflict": {
+      "enum": [
+        "fail",
+        "overwrite",
+        "rename"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "delegation_id",
+    "job_id",
+    "staging",
+    "dest_dir",
+    "name"
+  ]
+}

package/spec/protocol/v1/schema/root.run.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/synopackageland/syno-pkg-land-sdk/spec/protocol/v1/schema/root.run.json",
+  "title": "root.run",
+  "description": "Administrator: run a root operation pinned by digest in the policy.",
+  "since": "0.9.0",
+  "auth": "required",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "additionalProperties": false,
+  "required": [
+    "name"
+  ]
+}