diff --git a/docs/docs/endpoints.md b/docs/docs/endpoints.md deleted file mode 100644 index 2c87e6a9f..000000000 --- a/docs/docs/endpoints.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Endpoints - -The client and server components are generated from an OpenAPI spec. - -## RESTful API Endpoints for Linux System Configuration - -### User and Group Management - -- `/users` - Manage users. -- `/users/{username}` - Manage a specific user. -- `/groups` - Manage groups. -- `/groups/{groupname}` - Manage a specific group. - -### Package Management - -- `/packages` - List installed packages. -- `/packages/install` - Install a package. -- `/packages/remove` - Remove a package. -- `/packages/update` - Update a package or all packages. - -### Networking - -- Interfaces - - `/network/interfaces` - - `/network/interfaces/{interface-name}` -- DNS - - `/network/dns` - - `/network/dns/{dns-server}` -- Routes - - `/network/routes` - - `/network/routes/{route-id}` -- Firewall - - `/network/firewall/rules` - - `/network/firewall/rules/{rule-id}` - -### Storage Management - -- Disks - - `/storage/disks` - List disks. - - `/storage/disks/{disk-id}` - Manage a specific disk. -- Partitions - - `/storage/partitions` - List partitions. - - `/storage/partitions/{partition-id}` - Manage a specific partition. -- Mounts - - `/storage/mounts` - List mounted filesystems. - - `/storage/mounts/{mount-id}` - Manage a specific mount. -- File Systems - - `/storage/filesystems` - List file systems. - - `/storage/filesystems/{filesystem-id}` - Manage a specific file system. - -### Process Management - -- `/processes` - List running processes. -- `/processes/{pid}` - Manage a specific process (e.g., kill, nice). - -### Services and Daemons - -- `/services` - List running services. -- `/services/{service-name}` - Manage a specific service (start, stop, restart, - enable, disable). - -### NTP (Network Time Protocol) - -- `/ntp/servers` -- `/ntp/servers/{server-id}` -- `/ntp/config` -- `/ntp/peers` -- `/ntp/peers/{peer-id}` - -### Cron Jobs - -- `/cron/jobs` -- `/cron/jobs/{job-id}` - -### Security - -- SELinux/AppArmor - - `/security/selinux/status` - Get SELinux status. - - `/security/apparmor/status` - Get AppArmor status. -- Users and Groups - - `/security/users` - List users with security roles. - - `/security/groups` - List groups with security roles. -- SSH - - `/security/ssh/config` - Manage SSH configuration. - - `/security/ssh/keys` - Manage SSH keys. - -### Backup and Restore - -- `/backup` - Perform or schedule system backups. -- `/restore` - Restore from a backup. - -### Monitoring and Alerts - -- `/monitoring/metrics` - Access system metrics. -- `/monitoring/alerts` - Manage monitoring alerts and notifications. - -Core System Management: /system/info - Get system information (hostname, OS -version, uptime, etc.). /system/status - Get overall system status (load, memory -usage, etc.). /system/logs - Access system logs. Time Management (Standalone -Category): /ntp - Manage NTP settings. /ntp/sync - Synchronize time with NTP -servers. /time/zone - Manage time zone (or include in /ntp/ if related). Power -Management (Standalone Category): /power/shutdown - Shutdown the system. -/power/reboot - Reboot the system. /power/hibernate - Hibernate the system. -Localization (Keep Nested Under System): /system/localization/language - Manage -system language settings. /system/localization/locale - Manage system locale -settings. By breaking out NTP and power into their own top-level categories, you -keep the structure modular, scalable, and easy to understand, while still -nesting system-specific operations under /system/. diff --git a/docs/docs/sidebar/features/certificate-management.md b/docs/docs/sidebar/features/certificate-management.md index 884be7c62..555daae5b 100644 --- a/docs/docs/sidebar/features/certificate-management.md +++ b/docs/docs/sidebar/features/certificate-management.md @@ -135,7 +135,6 @@ included in the `admin` and `write` roles. - [CLI Reference](../usage/cli/client/node/certificate/certificate.md) -- certificate commands -- [SDK Reference](../sdk/client/management/certificate.md) -- Certificate - service +- [SDK Reference](../sdk/client/security/certificate.md) -- Certificate service - [Platform Detection](../sdk/platform/detection.md) -- OS family detection - [Configuration](../usage/configuration.md) -- full configuration reference diff --git a/docs/docs/sidebar/features/log-management.md b/docs/docs/sidebar/features/log-management.md index 39677aa9b..c81997205 100644 --- a/docs/docs/sidebar/features/log-management.md +++ b/docs/docs/sidebar/features/log-management.md @@ -111,6 +111,6 @@ Log querying requires `log:read`, included in all built-in roles (`admin`, ## Related - [CLI Reference](../usage/cli/client/node/log/log.md) -- log commands -- [SDK Reference](../sdk/client/operations/log.md) -- Log service +- [SDK Reference](../sdk/client/node/log.md) -- Log service - [Platform Detection](../sdk/platform/detection.md) -- OS family detection - [Configuration](../usage/configuration.md) -- full configuration reference diff --git a/docs/docs/sidebar/features/network-interface-management.md b/docs/docs/sidebar/features/network-interface-management.md index 5d12aad01..f0287584e 100644 --- a/docs/docs/sidebar/features/network-interface-management.md +++ b/docs/docs/sidebar/features/network-interface-management.md @@ -219,8 +219,8 @@ included in the `admin` and `write` roles. interface commands - [CLI Reference](../usage/cli/client/node/network/route/route.md) -- route commands -- [SDK Reference](../sdk/client/network/interface.md) -- Interface service -- [SDK Reference](../sdk/client/network/route.md) -- Route service +- [SDK Reference](../sdk/client/networking/interface.md) -- Interface service +- [SDK Reference](../sdk/client/networking/route.md) -- Route service - [Network Management](network-management.md) -- DNS and ping - [Platform Detection](../sdk/platform/detection.md) -- OS family detection - [Configuration](../usage/configuration.md) -- full configuration reference diff --git a/docs/docs/sidebar/features/process-management.md b/docs/docs/sidebar/features/process-management.md index fe7cd8f49..7752eebdb 100644 --- a/docs/docs/sidebar/features/process-management.md +++ b/docs/docs/sidebar/features/process-management.md @@ -104,6 +104,6 @@ role by default. - [CLI Reference](../usage/cli/client/node/process/process.md) -- process commands -- [SDK Reference](../sdk/client/operations/process.md) -- Process service +- [SDK Reference](../sdk/client/node/process.md) -- Process service - [Platform Detection](../sdk/platform/detection.md) -- OS family detection - [Configuration](../usage/configuration.md) -- full configuration reference diff --git a/docs/docs/sidebar/features/service-management.md b/docs/docs/sidebar/features/service-management.md index 5ad98499d..74a254e53 100644 --- a/docs/docs/sidebar/features/service-management.md +++ b/docs/docs/sidebar/features/service-management.md @@ -178,6 +178,6 @@ roles (`admin`, `write`, `read`). Mutation and action operations require - [CLI Reference](../usage/cli/client/node/service/service.md) -- service commands -- [SDK Reference](../sdk/client/operations/service.md) -- Service service +- [SDK Reference](../sdk/client/services/service.md) -- Service service - [Platform Detection](../sdk/platform/detection.md) -- OS family detection - [Configuration](../usage/configuration.md) -- full configuration reference diff --git a/docs/docs/sidebar/features/user-management.md b/docs/docs/sidebar/features/user-management.md index 3bd0ede5b..b521ae984 100644 --- a/docs/docs/sidebar/features/user-management.md +++ b/docs/docs/sidebar/features/user-management.md @@ -153,5 +153,5 @@ message. - [CLI Reference -- User](../usage/cli/client/node/user/user.md) - [CLI Reference -- SSH Key](../usage/cli/client/node/user/ssh-key.md) - [CLI Reference -- Group](../usage/cli/client/node/group/group.md) -- [SDK -- User](../sdk/client/management/user.md) -- [SDK -- Group](../sdk/client/management/group.md) +- [SDK -- User](../sdk/client/security/user.md) +- [SDK -- Group](../sdk/client/security/group.md) diff --git a/docs/docs/sidebar/sdk/client/agent/_category_.json b/docs/docs/sidebar/sdk/client/agent/_category_.json new file mode 100644 index 000000000..c7e236987 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/agent/_category_.json @@ -0,0 +1 @@ +{ "label": "Agent", "position": 14 } diff --git a/docs/docs/sidebar/sdk/client/management/agent.md b/docs/docs/sidebar/sdk/client/agent/agent.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/agent.md rename to docs/docs/sidebar/sdk/client/agent/agent.md diff --git a/docs/docs/sidebar/sdk/client/audit/_category_.json b/docs/docs/sidebar/sdk/client/audit/_category_.json new file mode 100644 index 000000000..0d2bfd205 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/audit/_category_.json @@ -0,0 +1 @@ +{ "label": "Audit", "position": 12 } diff --git a/docs/docs/sidebar/sdk/client/management/audit.md b/docs/docs/sidebar/sdk/client/audit/audit.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/audit.md rename to docs/docs/sidebar/sdk/client/audit/audit.md diff --git a/docs/docs/sidebar/sdk/client/client.md b/docs/docs/sidebar/sdk/client/client.md index 5c8817492..5f4eac2f2 100644 --- a/docs/docs/sidebar/sdk/client/client.md +++ b/docs/docs/sidebar/sdk/client/client.md @@ -19,52 +19,62 @@ resp, err := client.Hostname.Get(ctx, "_any") ## Services -### Node Info - -| Service | Description | -| --------------------------------- | ------------------------- | -| [Status](node-info/status.md) | Full node status | -| [Hostname](node-info/hostname.md) | Hostname query and update | -| [Disk](node-info/disk.md) | Disk usage | -| [Memory](node-info/memory.md) | Memory statistics | -| [Load](node-info/load.md) | Load averages | -| [Uptime](node-info/uptime.md) | System uptime | -| [OS](node-info/os.md) | Operating system info | - -### Network - -| Service | Description | -| --------------------------------- | ---------------------------------- | -| [DNS](network/dns.md) | DNS configuration query and update | -| [Ping](network/ping.md) | Network ping | -| [Interface](network/interface.md) | Network interface configuration | -| [Route](network/route.md) | Static route configuration | - -### System Config - -| Service | Description | -| ------------------------------------- | --------------------------- | -| [Sysctl](system-config/sysctl.md) | Kernel parameter management | -| [NTP](system-config/ntp.md) | NTP server configuration | -| [Timezone](system-config/timezone.md) | System timezone | -| [Package](system-config/package.md) | Package management | - -### Operations - -| Service | Description | -| -------------------------------- | -------------------------------------- | -| [Command](operations/command.md) | Command execution (exec, shell) | -| [Power](operations/power.md) | Power management (reboot, shutdown) | -| [Process](operations/process.md) | Process management (list, get, signal) | -| [Log](operations/log.md) | Log query (journal entries, by unit) | -| [Service](operations/service.md) | Service management (systemd lifecycle) | - -### Containers & Scheduling - -| Service | Description | -| ----------------------------------------- | ------------------------ | -| [Docker](containers-scheduling/docker.md) | Container lifecycle | -| [Cron](containers-scheduling/cron.md) | Cron schedule management | +### Services + +| Service | Description | +| ------------------------------ | ---------------------------- | +| [Service](services/service.md) | Service management (systemd) | +| [Cron](services/cron.md) | Cron schedule management | + +### Software + +| Service | Description | +| ------------------------------ | ------------------ | +| [Package](software/package.md) | Package management | + +### Config + +| Service | Description | +| ------------------------------ | --------------------------- | +| [Hostname](config/hostname.md) | Hostname query and update | +| [Sysctl](config/sysctl.md) | Kernel parameter management | +| [NTP](config/ntp.md) | NTP server configuration | +| [Timezone](config/timezone.md) | System timezone | + +### Node + +| Service | Description | +| -------------------------- | -------------------------------------- | +| [Power](node/power.md) | Power management (reboot, shutdown) | +| [Process](node/process.md) | Process management (list, get, signal) | +| [Log](node/log.md) | Log query (journal entries, by unit) | +| [Status](node/status.md) | Full node status | +| [Load](node/load.md) | Load averages | +| [Uptime](node/uptime.md) | System uptime | +| [OS](node/os.md) | Operating system info | + +### Networking + +| Service | Description | +| ------------------------------------ | ---------------------------------- | +| [DNS](networking/dns.md) | DNS configuration query and update | +| [Ping](networking/ping.md) | Network ping | +| [Interface](networking/interface.md) | Network interface configuration | +| [Route](networking/route.md) | Static route configuration | + +### Security + +| Service | Description | +| -------------------------------------- | ------------------------- | +| [User](security/user.md) | User account management | +| [Group](security/group.md) | Group management | +| [Certificate](security/certificate.md) | CA certificate management | + +### Containers + +| Service | Description | +| ------------------------------ | ------------------- | +| [Docker](containers/docker.md) | Container lifecycle | ### Files @@ -73,17 +83,42 @@ resp, err := client.Hostname.Get(ctx, "_any") | [File](files/file.md) | File management (Object Store) | | [FileDeploy](files/file_deploy.md) | File deployment to agents | -### Management - -| Service | Description | -| ---------------------------------------- | ------------------------------ | -| [Agent](management/agent.md) | Agent discovery, drain/undrain | -| [Job](management/job.md) | Async job queue operations | -| [Health](management/health.md) | Health check operations | -| [Audit](management/audit.md) | Audit log operations | -| [User](management/user.md) | User account management | -| [Group](management/group.md) | Group management | -| [Certificate](management/certificate.md) | CA certificate management | +### Command + +| Service | Description | +| ----------------------------- | ------------------------------- | +| [Command](command/command.md) | Command execution (exec, shell) | + +### Hardware + +| Service | Description | +| ---------------------------- | ----------------- | +| [Disk](hardware/disk.md) | Disk usage | +| [Memory](hardware/memory.md) | Memory statistics | + +### Audit + +| Service | Description | +| ----------------------- | -------------------- | +| [Audit](audit/audit.md) | Audit log operations | + +### Jobs + +| Service | Description | +| ------------------ | -------------------------- | +| [Job](jobs/job.md) | Async job queue operations | + +### Agent + +| Service | Description | +| ----------------------- | ------------------------------ | +| [Agent](agent/agent.md) | Agent discovery, drain/undrain | + +### Health + +| Service | Description | +| -------------------------- | ----------------------- | +| [Health](health/health.md) | Health check operations | ## Client Options diff --git a/docs/docs/sidebar/sdk/client/command/_category_.json b/docs/docs/sidebar/sdk/client/command/_category_.json new file mode 100644 index 000000000..f1776849b --- /dev/null +++ b/docs/docs/sidebar/sdk/client/command/_category_.json @@ -0,0 +1 @@ +{ "label": "Command", "position": 10 } diff --git a/docs/docs/sidebar/sdk/client/operations/command.md b/docs/docs/sidebar/sdk/client/command/command.md similarity index 100% rename from docs/docs/sidebar/sdk/client/operations/command.md rename to docs/docs/sidebar/sdk/client/command/command.md diff --git a/docs/docs/sidebar/sdk/client/config/_category_.json b/docs/docs/sidebar/sdk/client/config/_category_.json new file mode 100644 index 000000000..f4a83b9b4 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/config/_category_.json @@ -0,0 +1 @@ +{ "label": "Config", "position": 4 } diff --git a/docs/docs/sidebar/sdk/client/node-info/hostname.md b/docs/docs/sidebar/sdk/client/config/hostname.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/hostname.md rename to docs/docs/sidebar/sdk/client/config/hostname.md diff --git a/docs/docs/sidebar/sdk/client/system-config/ntp.md b/docs/docs/sidebar/sdk/client/config/ntp.md similarity index 100% rename from docs/docs/sidebar/sdk/client/system-config/ntp.md rename to docs/docs/sidebar/sdk/client/config/ntp.md diff --git a/docs/docs/sidebar/sdk/client/system-config/sysctl.md b/docs/docs/sidebar/sdk/client/config/sysctl.md similarity index 100% rename from docs/docs/sidebar/sdk/client/system-config/sysctl.md rename to docs/docs/sidebar/sdk/client/config/sysctl.md diff --git a/docs/docs/sidebar/sdk/client/system-config/timezone.md b/docs/docs/sidebar/sdk/client/config/timezone.md similarity index 100% rename from docs/docs/sidebar/sdk/client/system-config/timezone.md rename to docs/docs/sidebar/sdk/client/config/timezone.md diff --git a/docs/docs/sidebar/sdk/client/containers-scheduling/_category_.json b/docs/docs/sidebar/sdk/client/containers-scheduling/_category_.json deleted file mode 100644 index 94c9d768d..000000000 --- a/docs/docs/sidebar/sdk/client/containers-scheduling/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "Containers & Scheduling", "position": 6 } diff --git a/docs/docs/sidebar/sdk/client/containers/_category_.json b/docs/docs/sidebar/sdk/client/containers/_category_.json new file mode 100644 index 000000000..8bbb9165e --- /dev/null +++ b/docs/docs/sidebar/sdk/client/containers/_category_.json @@ -0,0 +1 @@ +{ "label": "Containers", "position": 8 } diff --git a/docs/docs/sidebar/sdk/client/containers-scheduling/docker.md b/docs/docs/sidebar/sdk/client/containers/docker.md similarity index 100% rename from docs/docs/sidebar/sdk/client/containers-scheduling/docker.md rename to docs/docs/sidebar/sdk/client/containers/docker.md diff --git a/docs/docs/sidebar/sdk/client/files/_category_.json b/docs/docs/sidebar/sdk/client/files/_category_.json index db98f28fc..563426213 100644 --- a/docs/docs/sidebar/sdk/client/files/_category_.json +++ b/docs/docs/sidebar/sdk/client/files/_category_.json @@ -1 +1 @@ -{ "label": "Files", "position": 7 } +{ "label": "Files", "position": 9 } diff --git a/docs/docs/sidebar/sdk/client/hardware/_category_.json b/docs/docs/sidebar/sdk/client/hardware/_category_.json new file mode 100644 index 000000000..d75afd49b --- /dev/null +++ b/docs/docs/sidebar/sdk/client/hardware/_category_.json @@ -0,0 +1 @@ +{ "label": "Hardware", "position": 11 } diff --git a/docs/docs/sidebar/sdk/client/node-info/disk.md b/docs/docs/sidebar/sdk/client/hardware/disk.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/disk.md rename to docs/docs/sidebar/sdk/client/hardware/disk.md diff --git a/docs/docs/sidebar/sdk/client/node-info/memory.md b/docs/docs/sidebar/sdk/client/hardware/memory.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/memory.md rename to docs/docs/sidebar/sdk/client/hardware/memory.md diff --git a/docs/docs/sidebar/sdk/client/health/_category_.json b/docs/docs/sidebar/sdk/client/health/_category_.json new file mode 100644 index 000000000..e8ed4b5d8 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/health/_category_.json @@ -0,0 +1 @@ +{ "label": "Health", "position": 15 } diff --git a/docs/docs/sidebar/sdk/client/management/health.md b/docs/docs/sidebar/sdk/client/health/health.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/health.md rename to docs/docs/sidebar/sdk/client/health/health.md diff --git a/docs/docs/sidebar/sdk/client/jobs/_category_.json b/docs/docs/sidebar/sdk/client/jobs/_category_.json new file mode 100644 index 000000000..8fdad6398 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/jobs/_category_.json @@ -0,0 +1 @@ +{ "label": "Jobs", "position": 13 } diff --git a/docs/docs/sidebar/sdk/client/management/job.md b/docs/docs/sidebar/sdk/client/jobs/job.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/job.md rename to docs/docs/sidebar/sdk/client/jobs/job.md diff --git a/docs/docs/sidebar/sdk/client/management/_category_.json b/docs/docs/sidebar/sdk/client/management/_category_.json deleted file mode 100644 index 94531c4ce..000000000 --- a/docs/docs/sidebar/sdk/client/management/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "Management", "position": 8 } diff --git a/docs/docs/sidebar/sdk/client/network/_category_.json b/docs/docs/sidebar/sdk/client/network/_category_.json deleted file mode 100644 index 41c0feed0..000000000 --- a/docs/docs/sidebar/sdk/client/network/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "Network", "position": 3 } diff --git a/docs/docs/sidebar/sdk/client/networking/_category_.json b/docs/docs/sidebar/sdk/client/networking/_category_.json new file mode 100644 index 000000000..a2e54418a --- /dev/null +++ b/docs/docs/sidebar/sdk/client/networking/_category_.json @@ -0,0 +1 @@ +{ "label": "Networking", "position": 6 } diff --git a/docs/docs/sidebar/sdk/client/network/dns.md b/docs/docs/sidebar/sdk/client/networking/dns.md similarity index 100% rename from docs/docs/sidebar/sdk/client/network/dns.md rename to docs/docs/sidebar/sdk/client/networking/dns.md diff --git a/docs/docs/sidebar/sdk/client/network/interface.md b/docs/docs/sidebar/sdk/client/networking/interface.md similarity index 100% rename from docs/docs/sidebar/sdk/client/network/interface.md rename to docs/docs/sidebar/sdk/client/networking/interface.md diff --git a/docs/docs/sidebar/sdk/client/network/ping.md b/docs/docs/sidebar/sdk/client/networking/ping.md similarity index 100% rename from docs/docs/sidebar/sdk/client/network/ping.md rename to docs/docs/sidebar/sdk/client/networking/ping.md diff --git a/docs/docs/sidebar/sdk/client/network/route.md b/docs/docs/sidebar/sdk/client/networking/route.md similarity index 100% rename from docs/docs/sidebar/sdk/client/network/route.md rename to docs/docs/sidebar/sdk/client/networking/route.md diff --git a/docs/docs/sidebar/sdk/client/node-info/_category_.json b/docs/docs/sidebar/sdk/client/node-info/_category_.json deleted file mode 100644 index 86d59d946..000000000 --- a/docs/docs/sidebar/sdk/client/node-info/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "Node Info", "position": 2 } diff --git a/docs/docs/sidebar/sdk/client/node/_category_.json b/docs/docs/sidebar/sdk/client/node/_category_.json new file mode 100644 index 000000000..9deb06eaf --- /dev/null +++ b/docs/docs/sidebar/sdk/client/node/_category_.json @@ -0,0 +1 @@ +{ "label": "Node", "position": 5 } diff --git a/docs/docs/sidebar/sdk/client/node-info/load.md b/docs/docs/sidebar/sdk/client/node/load.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/load.md rename to docs/docs/sidebar/sdk/client/node/load.md diff --git a/docs/docs/sidebar/sdk/client/operations/log.md b/docs/docs/sidebar/sdk/client/node/log.md similarity index 100% rename from docs/docs/sidebar/sdk/client/operations/log.md rename to docs/docs/sidebar/sdk/client/node/log.md diff --git a/docs/docs/sidebar/sdk/client/node-info/os.md b/docs/docs/sidebar/sdk/client/node/os.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/os.md rename to docs/docs/sidebar/sdk/client/node/os.md diff --git a/docs/docs/sidebar/sdk/client/operations/power.md b/docs/docs/sidebar/sdk/client/node/power.md similarity index 100% rename from docs/docs/sidebar/sdk/client/operations/power.md rename to docs/docs/sidebar/sdk/client/node/power.md diff --git a/docs/docs/sidebar/sdk/client/operations/process.md b/docs/docs/sidebar/sdk/client/node/process.md similarity index 100% rename from docs/docs/sidebar/sdk/client/operations/process.md rename to docs/docs/sidebar/sdk/client/node/process.md diff --git a/docs/docs/sidebar/sdk/client/node-info/status.md b/docs/docs/sidebar/sdk/client/node/status.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/status.md rename to docs/docs/sidebar/sdk/client/node/status.md diff --git a/docs/docs/sidebar/sdk/client/node-info/uptime.md b/docs/docs/sidebar/sdk/client/node/uptime.md similarity index 100% rename from docs/docs/sidebar/sdk/client/node-info/uptime.md rename to docs/docs/sidebar/sdk/client/node/uptime.md diff --git a/docs/docs/sidebar/sdk/client/operations/_category_.json b/docs/docs/sidebar/sdk/client/operations/_category_.json deleted file mode 100644 index 3375583a9..000000000 --- a/docs/docs/sidebar/sdk/client/operations/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "Operations", "position": 5 } diff --git a/docs/docs/sidebar/sdk/client/security/_category_.json b/docs/docs/sidebar/sdk/client/security/_category_.json new file mode 100644 index 000000000..1a4f69b1d --- /dev/null +++ b/docs/docs/sidebar/sdk/client/security/_category_.json @@ -0,0 +1 @@ +{ "label": "Security", "position": 7 } diff --git a/docs/docs/sidebar/sdk/client/management/certificate.md b/docs/docs/sidebar/sdk/client/security/certificate.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/certificate.md rename to docs/docs/sidebar/sdk/client/security/certificate.md diff --git a/docs/docs/sidebar/sdk/client/management/group.md b/docs/docs/sidebar/sdk/client/security/group.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/group.md rename to docs/docs/sidebar/sdk/client/security/group.md diff --git a/docs/docs/sidebar/sdk/client/management/user.md b/docs/docs/sidebar/sdk/client/security/user.md similarity index 100% rename from docs/docs/sidebar/sdk/client/management/user.md rename to docs/docs/sidebar/sdk/client/security/user.md diff --git a/docs/docs/sidebar/sdk/client/services/_category_.json b/docs/docs/sidebar/sdk/client/services/_category_.json new file mode 100644 index 000000000..b71511660 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/services/_category_.json @@ -0,0 +1 @@ +{ "label": "Services", "position": 2 } diff --git a/docs/docs/sidebar/sdk/client/containers-scheduling/cron.md b/docs/docs/sidebar/sdk/client/services/cron.md similarity index 100% rename from docs/docs/sidebar/sdk/client/containers-scheduling/cron.md rename to docs/docs/sidebar/sdk/client/services/cron.md diff --git a/docs/docs/sidebar/sdk/client/operations/service.md b/docs/docs/sidebar/sdk/client/services/service.md similarity index 100% rename from docs/docs/sidebar/sdk/client/operations/service.md rename to docs/docs/sidebar/sdk/client/services/service.md diff --git a/docs/docs/sidebar/sdk/client/software/_category_.json b/docs/docs/sidebar/sdk/client/software/_category_.json new file mode 100644 index 000000000..d3f659b08 --- /dev/null +++ b/docs/docs/sidebar/sdk/client/software/_category_.json @@ -0,0 +1 @@ +{ "label": "Software", "position": 3 } diff --git a/docs/docs/sidebar/sdk/client/system-config/package.md b/docs/docs/sidebar/sdk/client/software/package.md similarity index 100% rename from docs/docs/sidebar/sdk/client/system-config/package.md rename to docs/docs/sidebar/sdk/client/software/package.md diff --git a/docs/docs/sidebar/sdk/client/system-config/_category_.json b/docs/docs/sidebar/sdk/client/system-config/_category_.json deleted file mode 100644 index 9b365fb2a..000000000 --- a/docs/docs/sidebar/sdk/client/system-config/_category_.json +++ /dev/null @@ -1 +0,0 @@ -{ "label": "System Config", "position": 4 } diff --git a/docs/docs/system.md b/docs/docs/system.md deleted file mode 100644 index a5856ba76..000000000 --- a/docs/docs/system.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -sidebar_position: 1 ---- - -# System Endpoints - -### System Information and Management - -- Information - - `/system/info` - Get system information (hostname, OS version, uptime, - etc.). - - `/system/logs` - Access system logs. - - `/system/status` - Get overall system status (load, memory usage, etc.). -- Time and Localization - - `/system/time/zone` - Manage time zone. - - `/system/time/ntp` - Manage NTP settings. - - `/system/time/sync` - Synchronize time with NTP servers. - - `/system/localization/language` - Manage system language settings. - - `/system/localization/locale` - Manage system locale settings. -- Power Management - - `/system/power/shutdown` - Shutdown the system. - - `/system/power/reboot` - Reboot the system. - - `/system/power/hibernate` - Hibernate the system. -- Hostname - - `/system/hostname` diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 1b61da07e..6076962e5 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -241,142 +241,154 @@ const config: Config = { { type: 'html', value: - 'Node Info', + 'Services', className: 'dropdown-header' }, { type: 'doc', - label: 'Status', - docId: 'sidebar/sdk/client/node-info/status' + label: 'Service', + docId: 'sidebar/sdk/client/services/service' }, { type: 'doc', - label: 'Hostname', - docId: 'sidebar/sdk/client/node-info/hostname' + label: 'Cron', + docId: 'sidebar/sdk/client/services/cron' + }, + { + type: 'html', + value: + 'Software', + className: 'dropdown-header' }, { type: 'doc', - label: 'Disk', - docId: 'sidebar/sdk/client/node-info/disk' + label: 'Package', + docId: 'sidebar/sdk/client/software/package' + }, + { + type: 'html', + value: + 'Config', + className: 'dropdown-header' }, { type: 'doc', - label: 'Memory', - docId: 'sidebar/sdk/client/node-info/memory' + label: 'Hostname', + docId: 'sidebar/sdk/client/config/hostname' }, { type: 'doc', - label: 'Load', - docId: 'sidebar/sdk/client/node-info/load' + label: 'Sysctl', + docId: 'sidebar/sdk/client/config/sysctl' }, { type: 'doc', - label: 'Uptime', - docId: 'sidebar/sdk/client/node-info/uptime' + label: 'NTP', + docId: 'sidebar/sdk/client/config/ntp' }, { type: 'doc', - label: 'OS', - docId: 'sidebar/sdk/client/node-info/os' + label: 'Timezone', + docId: 'sidebar/sdk/client/config/timezone' }, { type: 'html', value: - 'Network', + 'Node', className: 'dropdown-header' }, { type: 'doc', - label: 'DNS', - docId: 'sidebar/sdk/client/network/dns' + label: 'Power', + docId: 'sidebar/sdk/client/node/power' }, { type: 'doc', - label: 'Ping', - docId: 'sidebar/sdk/client/network/ping' + label: 'Process', + docId: 'sidebar/sdk/client/node/process' }, { type: 'doc', - label: 'Interface', - docId: 'sidebar/sdk/client/network/interface' + label: 'Log', + docId: 'sidebar/sdk/client/node/log' }, { type: 'doc', - label: 'Route', - docId: 'sidebar/sdk/client/network/route' + label: 'Status', + docId: 'sidebar/sdk/client/node/status' + }, + { + type: 'doc', + label: 'Load', + docId: 'sidebar/sdk/client/node/load' + }, + { + type: 'doc', + label: 'Uptime', + docId: 'sidebar/sdk/client/node/uptime' + }, + { + type: 'doc', + label: 'OS', + docId: 'sidebar/sdk/client/node/os' }, { type: 'html', value: - 'System Config', + 'Networking', className: 'dropdown-header' }, { type: 'doc', - label: 'Sysctl', - docId: 'sidebar/sdk/client/system-config/sysctl' + label: 'DNS', + docId: 'sidebar/sdk/client/networking/dns' }, { type: 'doc', - label: 'NTP', - docId: 'sidebar/sdk/client/system-config/ntp' + label: 'Ping', + docId: 'sidebar/sdk/client/networking/ping' }, { type: 'doc', - label: 'Timezone', - docId: 'sidebar/sdk/client/system-config/timezone' + label: 'Interface', + docId: 'sidebar/sdk/client/networking/interface' }, { type: 'doc', - label: 'Package', - docId: 'sidebar/sdk/client/system-config/package' + label: 'Route', + docId: 'sidebar/sdk/client/networking/route' }, { type: 'html', value: - 'Operations', + 'Security', className: 'dropdown-header' }, { type: 'doc', - label: 'Command', - docId: 'sidebar/sdk/client/operations/command' - }, - { - type: 'doc', - label: 'Power', - docId: 'sidebar/sdk/client/operations/power' - }, - { - type: 'doc', - label: 'Process', - docId: 'sidebar/sdk/client/operations/process' + label: 'User', + docId: 'sidebar/sdk/client/security/user' }, { type: 'doc', - label: 'Log', - docId: 'sidebar/sdk/client/operations/log' + label: 'Group', + docId: 'sidebar/sdk/client/security/group' }, { type: 'doc', - label: 'Service', - docId: 'sidebar/sdk/client/operations/service' + label: 'Certificate', + docId: 'sidebar/sdk/client/security/certificate' }, { type: 'html', value: - 'Containers & Scheduling', + 'Containers', className: 'dropdown-header' }, { type: 'doc', label: 'Docker', - docId: 'sidebar/sdk/client/containers-scheduling/docker' - }, - { - type: 'doc', - label: 'Cron', - docId: 'sidebar/sdk/client/containers-scheduling/cron' + docId: 'sidebar/sdk/client/containers/docker' }, { type: 'html', @@ -397,43 +409,73 @@ const config: Config = { { type: 'html', value: - 'Management', + 'Command', className: 'dropdown-header' }, { type: 'doc', - label: 'Agent', - docId: 'sidebar/sdk/client/management/agent' + label: 'Command', + docId: 'sidebar/sdk/client/command/command' + }, + { + type: 'html', + value: + 'Hardware', + className: 'dropdown-header' }, { type: 'doc', - label: 'Job', - docId: 'sidebar/sdk/client/management/job' + label: 'Disk', + docId: 'sidebar/sdk/client/hardware/disk' }, { type: 'doc', - label: 'Health', - docId: 'sidebar/sdk/client/management/health' + label: 'Memory', + docId: 'sidebar/sdk/client/hardware/memory' + }, + { + type: 'html', + value: + 'Audit', + className: 'dropdown-header' }, { type: 'doc', label: 'Audit', - docId: 'sidebar/sdk/client/management/audit' + docId: 'sidebar/sdk/client/audit/audit' + }, + { + type: 'html', + value: + 'Jobs', + className: 'dropdown-header' }, { type: 'doc', - label: 'User', - docId: 'sidebar/sdk/client/management/user' + label: 'Job', + docId: 'sidebar/sdk/client/jobs/job' + }, + { + type: 'html', + value: + 'Agent', + className: 'dropdown-header' }, { type: 'doc', - label: 'Group', - docId: 'sidebar/sdk/client/management/group' + label: 'Agent', + docId: 'sidebar/sdk/client/agent/agent' + }, + { + type: 'html', + value: + 'Health', + className: 'dropdown-header' }, { type: 'doc', - label: 'Certificate', - docId: 'sidebar/sdk/client/management/certificate' + label: 'Health', + docId: 'sidebar/sdk/client/health/health' }, { type: 'html',