diff --git a/api/docs/public/cli.md b/api/docs/public/cli.md index edec10162..6011a17aa 100644 --- a/api/docs/public/cli.md +++ b/api/docs/public/cli.md @@ -8,7 +8,8 @@ unraid-api start [--log-level ] Starts the Unraid API service. -- `--log-level`: Optional. Set logging level (trace|debug|info|warn|error) +Options: +- `--log-level`: Set logging level (trace|debug|info|warn|error) ### Stop @@ -155,7 +156,7 @@ Generate a system report. ## Notes -1. Most commands that modify the system state will require appropriate permissions. -2. Some commands may require the API to be running or stopped depending on their function. -3. When using API keys, ensure you store them securely as they provide access to your system. -4. SSO configuration changes may require a service restart to take effect. +1. Most commands require appropriate permissions to modify system state +2. Some commands require the API to be running or stopped +3. Store API keys securely as they provide system access +4. SSO configuration changes may require a service restart diff --git a/api/docs/public/index.md b/api/docs/public/index.md index b297a7042..2dfa61af7 100644 --- a/api/docs/public/index.md +++ b/api/docs/public/index.md @@ -1,14 +1,14 @@ -# Unraid API Documentation +# Unraid API -The Unraid API provides a powerful GraphQL interface for interacting with your Unraid server programmatically. It enables automation, monitoring, and integration capabilities for your Unraid system. +The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities. ## Current Availability -The Unraid API is currently available exclusively through the **Unraid Connect Plugin**. To get started: +The API is available through the Unraid Connect Plugin: -1. Install the Unraid Connect Plugin from the Apps tab -2. Configure the plugin according to your needs -3. Access the API functionality through the plugin interface +1. Install Unraid Connect Plugin from Apps +2. Configure the plugin +3. Access API functionality through the plugin interface ## Future Availability @@ -26,10 +26,12 @@ The API will be integrated directly into the Unraid operating system in an upcom ## Key Features -- **GraphQL Interface**: Modern, flexible API design with strong typing -- **Authentication**: Secure access through API keys or session cookies -- **Comprehensive Coverage**: Access to system info, array management, Docker operations, and more -- **Developer Tools**: Built-in GraphQL sandbox for easy exploration and testing -- **Role-Based Access**: Granular control over API permissions and access levels +The API provides: -For detailed information about using the API, please refer to the [How to Use the API](./how-to-use-the-api.md) guide. +- GraphQL Interface: Modern, flexible API with strong typing +- Authentication: Secure access via API keys or session cookies +- Comprehensive Coverage: Access to system information, array management, and Docker operations +- Developer Tools: Built-in GraphQL sandbox for testing +- Role-Based Access: Granular permission control + +For detailed usage instructions, see [How to Use the API](./how-to-use-the-api.md). diff --git a/api/docs/public/upcoming-features.md b/api/docs/public/upcoming-features.md index afb3612c2..9b9801154 100644 --- a/api/docs/public/upcoming-features.md +++ b/api/docs/public/upcoming-features.md @@ -1,4 +1,6 @@ -# Unraid API Release Roadmap +# Upcoming Features + +Note: This roadmap outlines planned features and improvements for the Unraid API. Features and timelines may change based on development priorities and community feedback. ## Core Infrastructure @@ -66,4 +68,4 @@ | Notifications System | Done | v4.0.0 | | Notifications Interface | Done | v4.0.0 | -Note: This roadmap is subject to change based on development priorities and community feedback. Features marked as "Done" have been released in previous versions. The tag column indicates the version where a feature was first introduced. Features without tags are either planned or in development. +Features marked as "Done" are available in current releases. The tag column shows the version where a feature was first introduced.