DigicoolThings
diff --git a/‎.github/workflows/pr.yml‎
Lines changed: 36 additions & 0 deletions b/‎.github/workflows/pr.yml‎
Lines changed: 36 additions & 0 deletions
diff --git a/‎docs/API/cli.mdx‎
Lines changed: 8 additions & 0 deletions b/‎docs/API/cli.mdx‎
Lines changed: 8 additions & 0 deletions
diff --git a/‎docs/API/how-to-use-the-api.mdx‎
Lines changed: 12 additions & 0 deletions b/‎docs/API/how-to-use-the-api.mdx‎
Lines changed: 12 additions & 0 deletions
diff --git a/‎docs/API/index.mdx‎
Lines changed: 14 additions & 0 deletions b/‎docs/API/index.mdx‎
Lines changed: 14 additions & 0 deletions
diff --git a/‎docs/API/oidc-provider-setup.mdx‎
Lines changed: 15 additions & 0 deletions b/‎docs/API/oidc-provider-setup.mdx‎
Lines changed: 15 additions & 0 deletions
diff --git a/‎docs/API/programmatic-api-key-management.mdx‎
Lines changed: 8 additions & 0 deletions b/‎docs/API/programmatic-api-key-management.mdx‎
Lines changed: 8 additions & 0 deletions
@@ -14,10 +14,16 @@ concurrency:
 
 jobs:
   lint:
+    if: ${{ github.event.action != 'closed' }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: write
     steps:
       - name: Checkout
         uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+          ref: ${{ github.head_ref }}
 
       - name: Setup Node.js
         uses: actions/setup-node@v5
@@ -28,9 +34,39 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
+      - name: Run formatter autofix
+        run: npm run format
+
       - name: Run linter
         run: npm run lint -- --frail
 
+      - name: Check for lint changes
+        id: lint_changes
+        run: |
+          if [[ -n "$(git status --porcelain)" ]]; then
+            echo "has_changes=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "has_changes=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Notify forked PRs
+        if: steps.lint_changes.outputs.has_changes == 'true' && github.repository != github.event.pull_request.head.repo.full_name
+        run: |
+          echo "::warning::Format fixes were generated but cannot be pushed automatically for pull requests from forks. Please run 'npm run format' locally and push the changes."
+
+      - name: Commit lint fixes
+        if: steps.lint_changes.outputs.has_changes == 'true' && github.repository == github.event.pull_request.head.repo.full_name
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add -A
+          git commit -m "chore: apply lint and format fixes"
+
+      - name: Push lint fixes
+        if: steps.lint_changes.outputs.has_changes == 'true' && github.repository == github.event.pull_request.head.repo.full_name
+        run: |
+          git push origin HEAD:${{ github.head_ref }} || echo "Unable to push lint fixes (likely due to branch permissions)."
+
   deploy-preview:
     runs-on: ubuntu-latest
     permissions:
 
@@ -7,7 +7,9 @@ sidebar_position: 4
 # CLI Commands
 
 :::info[Command Structure]
+
 All commands follow the pattern: `unraid-api <command> [options]`
+
 :::
 
 ## 🚀 Service Management
@@ -91,7 +93,9 @@ Switch between production and staging environments.
 ### Developer Mode
 
 :::tip[Web GUI Management]
+
 You can also manage developer options through the web interface at **Settings** → **Management Access** → **Developer Options**
+
 :::
 
 ```bash
@@ -110,7 +114,9 @@ Configure developer features for the API:
 ## API Key Management
 
 :::tip[Web GUI Management]
+
 You can also manage API keys through the web interface at **Settings** → **Management Access** → **API Keys**
+
 :::
 
 ### API Key Commands
@@ -132,7 +138,9 @@ Options:
 ## SSO (Single Sign-On) Management
 
 :::info[OIDC Configuration]
+
 For OIDC/SSO provider configuration, see the web interface at **Settings** → **Management Access** → **API** → **OIDC** or refer to the [OIDC Provider Setup](./oidc-provider-setup.mdx) guide.
+
 :::
 
 ### SSO Base Command
 
@@ -12,7 +12,9 @@ import ManageApiKeysCli from './partials/manage-api-keys-cli.mdx';
 # Using the Unraid API
 
 :::tip[Quick Start]
+
 The Unraid API provides a powerful GraphQL interface for managing your server. This guide covers authentication, common queries, and best practices.
+
 :::
 
 The Unraid API provides a GraphQL interface that allows you to interact with your Unraid server. This guide will help you get started with exploring and using the API.
@@ -22,7 +24,9 @@ The Unraid API provides a GraphQL interface that allows you to interact with you
 ### Web GUI Method (Recommended)
 
 :::info[Preferred Method]
+
 Using the Web GUI is the easiest way to enable the GraphQL sandbox.
+
 :::
 
 1. Navigate to **Settings** → **Management Access** → **Developer Options**
@@ -50,7 +54,9 @@ unraid-api developer
 ## 🔑 Authentication
 
 :::warning[Required for Most Operations]
+
 Most queries and mutations require authentication. Always include appropriate credentials in your requests.
+
 :::
 
 You can authenticate using:
@@ -200,17 +206,21 @@ Available roles:
 ## ✨ Best Practices
 
 :::tip[Pro Tips]
+
 1. Use the Apollo Sandbox to explore the schema and test queries
 2. Start with small queries and gradually add fields as needed
 3. Monitor your query complexity to maintain performance
 4. Use appropriate roles and permissions for your API keys
 5. Keep your API keys secure and rotate them periodically
+
 :::
 
 ## ⏱️ Rate Limiting
 
 :::caution[Rate Limits]
+
 The API implements rate limiting to prevent abuse. Ensure your applications handle rate limit responses appropriately.
+
 :::
 
 ## 🚨 Error Handling
@@ -232,10 +242,12 @@ The API returns standard GraphQL errors in the following format:
 ## 📚 Additional Resources
 
 :::info[Learn More]
+
 - Use the Apollo Sandbox's schema explorer to browse all available types and fields
 - Check the documentation tab in Apollo Sandbox for detailed field descriptions
 - Monitor the API's health using `unraid-api status`
 - Generate reports using `unraid-api report` for troubleshooting
 
 For more information about specific commands and configuration options, refer to the [CLI documentation](cli.mdx) or run `unraid-api --help`.
+
 :::
@@ -13,7 +13,9 @@ import GetStartedPre72 from './partials/get-started-pre72.mdx';
 # Welcome to Unraid API
 
 :::tip[What's New]
+
 Starting with Unraid OS v7.2, the API comes built into the operating system - no plugin installation required!
+
 :::
 
 The Unraid API provides a GraphQL interface for programmatic interaction with your Unraid server. It enables automation, monitoring, and integration capabilities.
@@ -38,34 +40,45 @@ For Unraid versions prior to v7.2 or to access newer API features:
 3. Access API functionality through the [GraphQL Sandbox](./how-to-use-the-api.mdx)
 
 :::info[Important Notes]
+
 - The Unraid Connect plugin provides the API for pre-7.2 versions
 - You do NOT need to sign in to Unraid Connect to use the API locally
 - Installing the plugin on 7.2+ gives you access to newer API features before they're included in OS releases
+
 :::
 
 ## 📚 Documentation Sections
 
 <div style={{display: 'grid', gridTemplateColumns: 'repeat(auto-fit, minmax(250px, 1fr))', gap: '1rem'}}>
   <Card title="CLI Commands" icon="terminal" href="./cli">
+
     Complete reference for all CLI commands
+
   </Card>
 
   <Card title="Using the API" icon="code" href="./how-to-use-the-api">
+
     Learn how to interact with the GraphQL API
+
   </Card>
 
   <Card title="OIDC Setup" icon="shield" href="./oidc-provider-setup">
+
     Configure SSO authentication providers
+
   </Card>
 
   <Card title="Upcoming Features" icon="rocket" href="./upcoming-features">
+
     See what's coming next
+
   </Card>
 </div>
 
 ## 🌟 Key Features
 
 :::info[Core Capabilities]
+
 The API provides:
 
 - **GraphQL Interface**: Modern, flexible API with strong typing
@@ -74,6 +87,7 @@ The API provides:
 - **Developer Tools**: Built-in GraphQL sandbox configurable via web interface or CLI
 - **Role-Based Access**: Granular permission control
 - **Web Management**: Manage API keys and settings through the web interface
+
 :::
 
 ## 🚀 Get Started
 
@@ -7,7 +7,9 @@ sidebar_position: 3
 # OIDC Provider Setup
 
 :::info[What is OIDC?]
+
 OpenID Connect (OIDC) is an authentication protocol that allows users to sign in using their existing accounts from providers like Google, Microsoft, or your corporate identity provider. It enables Single Sign-On (SSO) for seamless and secure authentication.
+
 :::
 
 This guide walks you through configuring OIDC (OpenID Connect) providers for SSO authentication in the Unraid API using the web interface.
@@ -20,6 +22,7 @@ This guide walks you through configuring OIDC (OpenID Connect) providers for SSO
   1. Navigate to your Unraid server's web interface
   2. Go to **Settings** → **Management Access** → **API** → **OIDC**
   3. You'll see tabs for different providers - click the **+** button to add a new provider
+
 </details>
 
 ### OIDC Providers Interface Overview
@@ -69,6 +72,7 @@ Simple mode is the easiest way to configure authorization. You can:
   - You want to verify multiple claims (e.g., email domain AND verified status)
   - You have complex authorization requirements
   - You need fine-grained control over how rules are evaluated
+
 </details>
 
 ## Authorization Rules
@@ -149,6 +153,7 @@ In Simple Authorization:
      - Email must be verified
      - User must be in specific group
      - Account must have 2FA enabled (if claim available)
+
 </details>
 
 <details>
@@ -191,20 +196,25 @@ In Simple Authorization:
   - **Enable Developer Sandbox**: Toggle to enable GraphQL sandbox at `/graphql`
   - The interface uses a dark theme for better visibility
   - Field validation indicators help ensure correct configuration
+
 </details>
 
 ### Required Redirect URI
 
 :::caution[Important Configuration]
+
 All providers must be configured with this exact redirect URI format:
+
 :::
 
 ```bash
 http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback
 ```
 
 :::tip
+
 Replace `YOUR_UNRAID_IP` with your actual server IP address (e.g., `192.168.1.100` or `tower.local`).
+
 :::
 
 ### Issuer URL Format
@@ -306,7 +316,9 @@ The Unraid.net provider is built-in and pre-configured. You only need to configu
 - **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
 
 :::tip[Redirect URI Protocol]
+
 **Match the protocol to your server setup:** Use `http://` if accessing your Unraid server without SSL/TLS (typical for local network access). Use `https://` if you've configured SSL/TLS on your server. Some OIDC providers (like Google) require HTTPS and won't accept HTTP redirect URIs.
+
 :::
 
 Configure authorization rules using Simple Mode (allowed email domains/addresses) or Advanced Mode for complex requirements.
@@ -323,6 +335,7 @@ Configure authorization rules using Simple Mode (allowed email domains/addresses
   3. Choose **Web application** as the application type
   4. Add your redirect URI to **Authorized redirect URIs**
   5. Configure the OAuth consent screen if prompted
+
 </details>
 
 **Configuration:**
@@ -333,13 +346,15 @@ Configure authorization rules using Simple Mode (allowed email domains/addresses
 - **Redirect URI**: `http://YOUR_UNRAID_IP/graphql/api/auth/oidc/callback`
 
 :::warning[Google Domain Requirements]
+
 **Google requires valid domain names for OAuth redirect URIs.** Local IP addresses and `.local` domains are not accepted. To use Google OAuth with your Unraid server, you'll need:
 
 - **Option 1: Reverse Proxy** - Set up a reverse proxy (like NGINX Proxy Manager or Traefik) with a valid domain name pointing to your Unraid API
 - **Option 2: Tailscale** - Use Tailscale to get a valid `*.ts.net` domain that Google will accept
 - **Option 3: Dynamic DNS** - Use a DDNS service to get a public domain name for your server
 
 Remember to update your redirect URI in both Google Cloud Console and your Unraid OIDC configuration to use the valid domain.
+
 :::
 
 For Google Workspace domains, use Advanced Mode with the `hd` claim to restrict access to your organization's domain.
 
@@ -18,7 +18,9 @@ The `unraid-api apikey` command supports both interactive and non-interactive mo
 - Infrastructure as code workflows
 
 :::tip[Quick Start]
+
 Jump to the [Complete Workflow Example](#complete-workflow-example) to see everything in action.
+
 :::
 
 ## Creating API Keys Programmatically
@@ -60,7 +62,9 @@ unraid-api apikey --create --name "existing key" --roles ADMIN --overwrite --jso
 ```
 
 :::warning[Key Replacement]
+
 The `--overwrite` flag will permanently replace the existing key. The old key will be immediately invalidated.
+
 :::
 
 ## Deleting API Keys Programmatically
@@ -199,6 +203,7 @@ echo "Deployment completed successfully"
 ## Best Practices
 
 :::info[Security Best Practices]
+
 **Minimal Permissions**
 
 - Use specific permissions instead of ADMIN role when possible
@@ -209,6 +214,7 @@ echo "Deployment completed successfully"
 - Always clean up temporary keys after use
 - Store API keys securely (environment variables, secrets management)
 - Use descriptive names and descriptions for audit trails
+
 :::
 
 ### Error Handling
@@ -228,6 +234,7 @@ echo "Deployment completed successfully"
 ### Common Issues
 
 :::note[Common Error Messages]
+
 **"API key name must contain only letters, numbers, and spaces"**
 
 - **Solution:** Remove special characters like hyphens, underscores, or symbols
@@ -239,6 +246,7 @@ echo "Deployment completed successfully"
 **"Please add at least one role or permission to the key"**
 
 - **Solution:** Specify either `--roles` or `--permissions` (or both)
+
 :::
 
 ### Debug Mode