diff --git a/permissions/autogenerated/reference.md b/permissions/autogenerated/reference.md index e46356b..6838e97 100644 --- a/permissions/autogenerated/reference.md +++ b/permissions/autogenerated/reference.md @@ -1,53 +1,673 @@ -| Permission | Description | -|------|-----| -|`allow-all`|This enables all permissions for system info plugin| -|`allow-all-sys-info`|Enables the all_sys_info command without any pre-configured scope.| -|`deny-all-sys-info`|Denies the all_sys_info command without any pre-configured scope.| -|`allow-batteries`|Enables the batteries command without any pre-configured scope.| -|`deny-batteries`|Denies the batteries command without any pre-configured scope.| -|`allow-components`|Enables the components command without any pre-configured scope.| -|`deny-components`|Denies the components command without any pre-configured scope.| -|`allow-cpu-count`|Enables the cpu_count command without any pre-configured scope.| -|`deny-cpu-count`|Denies the cpu_count command without any pre-configured scope.| -|`allow-cpu-info`|Enables the cpu_info command without any pre-configured scope.| -|`deny-cpu-info`|Denies the cpu_info command without any pre-configured scope.| -|`allow-cpus`|Enables the cpus command without any pre-configured scope.| -|`deny-cpus`|Denies the cpus command without any pre-configured scope.| -|`allow-disks`|Enables the disks command without any pre-configured scope.| -|`deny-disks`|Denies the disks command without any pre-configured scope.| -|`allow-execute`|Enables the execute command without any pre-configured scope.| -|`deny-execute`|Denies the execute command without any pre-configured scope.| -|`allow-hostname`|Enables the hostname command without any pre-configured scope.| -|`deny-hostname`|Denies the hostname command without any pre-configured scope.| -|`allow-kernel-version`|Enables the kernel_version command without any pre-configured scope.| -|`deny-kernel-version`|Denies the kernel_version command without any pre-configured scope.| -|`allow-memory-info`|Enables the memory_info command without any pre-configured scope.| -|`deny-memory-info`|Denies the memory_info command without any pre-configured scope.| -|`allow-name`|Enables the name command without any pre-configured scope.| -|`deny-name`|Denies the name command without any pre-configured scope.| -|`allow-networks`|Enables the networks command without any pre-configured scope.| -|`deny-networks`|Denies the networks command without any pre-configured scope.| -|`allow-os-version`|Enables the os_version command without any pre-configured scope.| -|`deny-os-version`|Denies the os_version command without any pre-configured scope.| -|`allow-ping`|Enables the ping command without any pre-configured scope.| -|`deny-ping`|Denies the ping command without any pre-configured scope.| -|`allow-processes`|Enables the processes command without any pre-configured scope.| -|`deny-processes`|Denies the processes command without any pre-configured scope.| -|`allow-refresh-all`|Enables the refresh_all command without any pre-configured scope.| -|`deny-refresh-all`|Denies the refresh_all command without any pre-configured scope.| -|`allow-refresh-cpu`|Enables the refresh_cpu command without any pre-configured scope.| -|`deny-refresh-cpu`|Denies the refresh_cpu command without any pre-configured scope.| -|`allow-refresh-memory`|Enables the refresh_memory command without any pre-configured scope.| -|`deny-refresh-memory`|Denies the refresh_memory command without any pre-configured scope.| -|`allow-refresh-processes`|Enables the refresh_processes command without any pre-configured scope.| -|`deny-refresh-processes`|Denies the refresh_processes command without any pre-configured scope.| -|`allow-static-info`|Enables the static_info command without any pre-configured scope.| -|`deny-static-info`|Denies the static_info command without any pre-configured scope.| -|`allow-total-memory`|Enables the total_memory command without any pre-configured scope.| -|`deny-total-memory`|Denies the total_memory command without any pre-configured scope.| -|`allow-total-swap`|Enables the total_swap command without any pre-configured scope.| -|`deny-total-swap`|Denies the total_swap command without any pre-configured scope.| -|`allow-used-memory`|Enables the used_memory command without any pre-configured scope.| -|`deny-used-memory`|Denies the used_memory command without any pre-configured scope.| -|`allow-used-swap`|Enables the used_swap command without any pre-configured scope.| -|`deny-used-swap`|Denies the used_swap command without any pre-configured scope.| + +### Permission Table + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
IdentifierDescription
+ +`system-info:allow-all` + + + +This enables all permissions for system info plugin + +
+ +`system-info:allow-all-sys-info` + + + +Enables the all_sys_info command without any pre-configured scope. + +
+ +`system-info:deny-all-sys-info` + + + +Denies the all_sys_info command without any pre-configured scope. + +
+ +`system-info:allow-batteries` + + + +Enables the batteries command without any pre-configured scope. + +
+ +`system-info:deny-batteries` + + + +Denies the batteries command without any pre-configured scope. + +
+ +`system-info:allow-components` + + + +Enables the components command without any pre-configured scope. + +
+ +`system-info:deny-components` + + + +Denies the components command without any pre-configured scope. + +
+ +`system-info:allow-cpu-count` + + + +Enables the cpu_count command without any pre-configured scope. + +
+ +`system-info:deny-cpu-count` + + + +Denies the cpu_count command without any pre-configured scope. + +
+ +`system-info:allow-cpu-info` + + + +Enables the cpu_info command without any pre-configured scope. + +
+ +`system-info:deny-cpu-info` + + + +Denies the cpu_info command without any pre-configured scope. + +
+ +`system-info:allow-cpus` + + + +Enables the cpus command without any pre-configured scope. + +
+ +`system-info:deny-cpus` + + + +Denies the cpus command without any pre-configured scope. + +
+ +`system-info:allow-disks` + + + +Enables the disks command without any pre-configured scope. + +
+ +`system-info:deny-disks` + + + +Denies the disks command without any pre-configured scope. + +
+ +`system-info:allow-execute` + + + +Enables the execute command without any pre-configured scope. + +
+ +`system-info:deny-execute` + + + +Denies the execute command without any pre-configured scope. + +
+ +`system-info:allow-hostname` + + + +Enables the hostname command without any pre-configured scope. + +
+ +`system-info:deny-hostname` + + + +Denies the hostname command without any pre-configured scope. + +
+ +`system-info:allow-kernel-version` + + + +Enables the kernel_version command without any pre-configured scope. + +
+ +`system-info:deny-kernel-version` + + + +Denies the kernel_version command without any pre-configured scope. + +
+ +`system-info:allow-memory-info` + + + +Enables the memory_info command without any pre-configured scope. + +
+ +`system-info:deny-memory-info` + + + +Denies the memory_info command without any pre-configured scope. + +
+ +`system-info:allow-name` + + + +Enables the name command without any pre-configured scope. + +
+ +`system-info:deny-name` + + + +Denies the name command without any pre-configured scope. + +
+ +`system-info:allow-networks` + + + +Enables the networks command without any pre-configured scope. + +
+ +`system-info:deny-networks` + + + +Denies the networks command without any pre-configured scope. + +
+ +`system-info:allow-os-version` + + + +Enables the os_version command without any pre-configured scope. + +
+ +`system-info:deny-os-version` + + + +Denies the os_version command without any pre-configured scope. + +
+ +`system-info:allow-ping` + + + +Enables the ping command without any pre-configured scope. + +
+ +`system-info:deny-ping` + + + +Denies the ping command without any pre-configured scope. + +
+ +`system-info:allow-processes` + + + +Enables the processes command without any pre-configured scope. + +
+ +`system-info:deny-processes` + + + +Denies the processes command without any pre-configured scope. + +
+ +`system-info:allow-refresh-all` + + + +Enables the refresh_all command without any pre-configured scope. + +
+ +`system-info:deny-refresh-all` + + + +Denies the refresh_all command without any pre-configured scope. + +
+ +`system-info:allow-refresh-cpu` + + + +Enables the refresh_cpu command without any pre-configured scope. + +
+ +`system-info:deny-refresh-cpu` + + + +Denies the refresh_cpu command without any pre-configured scope. + +
+ +`system-info:allow-refresh-memory` + + + +Enables the refresh_memory command without any pre-configured scope. + +
+ +`system-info:deny-refresh-memory` + + + +Denies the refresh_memory command without any pre-configured scope. + +
+ +`system-info:allow-refresh-processes` + + + +Enables the refresh_processes command without any pre-configured scope. + +
+ +`system-info:deny-refresh-processes` + + + +Denies the refresh_processes command without any pre-configured scope. + +
+ +`system-info:allow-static-info` + + + +Enables the static_info command without any pre-configured scope. + +
+ +`system-info:deny-static-info` + + + +Denies the static_info command without any pre-configured scope. + +
+ +`system-info:allow-total-memory` + + + +Enables the total_memory command without any pre-configured scope. + +
+ +`system-info:deny-total-memory` + + + +Denies the total_memory command without any pre-configured scope. + +
+ +`system-info:allow-total-swap` + + + +Enables the total_swap command without any pre-configured scope. + +
+ +`system-info:deny-total-swap` + + + +Denies the total_swap command without any pre-configured scope. + +
+ +`system-info:allow-used-memory` + + + +Enables the used_memory command without any pre-configured scope. + +
+ +`system-info:deny-used-memory` + + + +Denies the used_memory command without any pre-configured scope. + +
+ +`system-info:allow-used-swap` + + + +Enables the used_swap command without any pre-configured scope. + +
+ +`system-info:deny-used-swap` + + + +Denies the used_swap command without any pre-configured scope. + +
diff --git a/permissions/schemas/schema.json b/permissions/schemas/schema.json index a74e290..ca2ae9c 100644 --- a/permissions/schemas/schema.json +++ b/permissions/schemas/schema.json @@ -49,7 +49,7 @@ "minimum": 1.0 }, "description": { - "description": "Human-readable description of what the permission does.", + "description": "Human-readable description of what the permission does. Tauri convention is to use

headings in markdown content for Tauri documentation generation purposes.", "type": [ "string", "null" @@ -111,7 +111,7 @@ "type": "string" }, "description": { - "description": "Human-readable description of what the permission does.", + "description": "Human-readable description of what the permission does. Tauri internal convention is to use

headings in markdown content for Tauri documentation generation purposes.", "type": [ "string", "null" @@ -172,7 +172,7 @@ } }, "Scopes": { - "description": "A restriction of the command/endpoint functionality.\n\nIt can be of any serde serializable type and is used for allowing or preventing certain actions inside a Tauri command.\n\nThe scope is passed to the command and handled/enforced by the command itself.", + "description": "An argument for fine grained behavior control of Tauri commands.\n\nIt can be of any serde serializable type and is used to allow or prevent certain actions inside a Tauri command. The configured scope is passed to the command and will be enforced by the command implementation.\n\n## Example\n\n```json { \"allow\": [{ \"path\": \"$HOME/**\" }], \"deny\": [{ \"path\": \"$HOME/secret.txt\" }] } ```", "type": "object", "properties": { "allow": { @@ -186,7 +186,7 @@ } }, "deny": { - "description": "Data that defines what is denied by the scope.", + "description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.", "type": [ "array", "null"