update docs

Author: ewgenius

docs/data-sources/app.md

@@ -10,61 +10,53 @@ description: |-
 
 Retrieves details about an existing Spice.ai app by its ID.
 
-Use this data source to access information about an existing app that you need to reference in your configuration.
-
 ## Example Usage
 
-### Basic Usage
-
 ```terraform
+# Get details about an existing app by ID
 data "spiceai_app" "example" {
   id = "12345"
 }
 
+# Use data from an existing app
 output "app_name" {
   description = "The name of the app"
   value       = data.spiceai_app.example.name
 }
-```
 
-### Reference App from Resource
+output "app_visibility" {
+  description = "The visibility of the app"
+  value       = data.spiceai_app.example.visibility
+}
 
-```terraform
-resource "spiceai_app" "example" {
-  name        = "my-app"
-  description = "My Spice.ai app"
-  visibility  = "private"
+output "app_region" {
+  description = "The region where the app is deployed"
+  value       = data.spiceai_app.example.region
 }
 
+output "app_replicas" {
+  description = "The number of replicas configured for the app"
+  value       = data.spiceai_app.example.replicas
+}
+
+output "app_image_tag" {
+  description = "The runtime image tag for the app"
+  value       = data.spiceai_app.example.image_tag
+}
+
+# Reference an app created by another resource
 data "spiceai_app" "from_resource" {
   id = spiceai_app.example.id
 }
 
+# Use data source to get app API key for other configurations
 output "app_api_key" {
   description = "The API key for the app"
   value       = data.spiceai_app.from_resource.api_key
   sensitive   = true
 }
 ```
 
-### Access Runtime Configuration
-
-```terraform
-data "spiceai_app" "example" {
-  id = "12345"
-}
-
-output "app_config" {
-  description = "The app's runtime configuration"
-  value = {
-    name      = data.spiceai_app.example.name
-    region    = data.spiceai_app.example.region
-    replicas  = data.spiceai_app.example.replicas
-    image_tag = data.spiceai_app.example.image_tag
-  }
-}
-```
-
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -74,29 +66,16 @@ output "app_config" {
 
 ### Read-Only
 
-#### Identity
-
-- `name` (String) The name of the app.
-
-#### Basic Configuration
-
+- `api_key` (String, Sensitive) The API key for the app.
+- `cluster_id` (String) The Kubernetes cluster identifier where the app is deployed.
+- `created_at` (String) The timestamp when the app was created.
 - `description` (String) A description of the app.
-- `visibility` (String) The visibility of the app (`public` or `private`).
-- `production_branch` (String) The production branch for the app.
-
-#### Spicepod Configuration
-
-- `spicepod` (String) The spicepod configuration as a JSON string.
-
-#### Runtime Configuration
-
 - `image_tag` (String) The Spice.ai runtime image tag.
-- `replicas` (Number) The number of replicas.
+- `name` (String) The name of the app.
 - `node_group` (String) The node group for the app.
+- `production_branch` (String) The production branch for the app.
 - `region` (String) The region where the app is deployed.
+- `replicas` (Number) The number of replicas.
+- `spicepod` (String) The spicepod configuration as a JSON string.
 - `storage_claim_size_gb` (Number) The storage claim size in GB.
-
-#### Metadata
-
-- `created_at` (String) The timestamp when the app was created.
-- `api_key` (String, Sensitive) The API key for the app.
+- `visibility` (String) The visibility of the app (`public` or `private`).

docs/data-sources/apps.md

@@ -10,31 +10,31 @@ description: |-
 
 Retrieves a list of all Spice.ai apps in the authenticated organization.
 
-Use this data source to list all apps in your organization and access their configuration details.
-
 ## Example Usage
 
-### List All Apps
-
 ```terraform
+# List all apps in the organization
 data "spiceai_apps" "all" {}
 
+# Output the count of apps
 output "app_count" {
   description = "The total number of apps in the organization"
   value       = length(data.spiceai_apps.all.apps)
 }
 
+# Output all app names
 output "app_names" {
   description = "List of all app names"
   value       = [for app in data.spiceai_apps.all.apps : app.name]
 }
-```
 
-### Filter Apps by Visibility
-
-```terraform
-data "spiceai_apps" "all" {}
+# Output all app IDs
+output "app_ids" {
+  description = "List of all app IDs"
+  value       = [for app in data.spiceai_apps.all.apps : app.id]
+}
 
+# Filter apps by visibility
 output "public_apps" {
   description = "List of public app names"
   value       = [for app in data.spiceai_apps.all.apps : app.name if app.visibility == "public"]
@@ -44,31 +44,20 @@ output "private_apps" {
   description = "List of private app names"
   value       = [for app in data.spiceai_apps.all.apps : app.name if app.visibility == "private"]
 }
-```
-
-### Get Apps with Configuration Details
-
-```terraform
-data "spiceai_apps" "all" {}
 
+# Get apps with their configurations
 output "apps_with_config" {
-  description = "Map of app names to their configuration"
+  description = "Map of app names to their replica counts"
   value = {
     for app in data.spiceai_apps.all.apps : app.name => {
-      id        = app.id
       replicas  = app.replicas
       image_tag = app.image_tag
       region    = app.region
     }
   }
 }
-```
-
-### Find a Specific App by Name
-
-```terraform
-data "spiceai_apps" "all" {}
 
+# Find a specific app by name
 locals {
   target_app_name = "my-app"
   target_app = [
@@ -95,30 +84,17 @@ output "found_app_id" {
 
 Read-Only:
 
-#### Identity
-
-- `id` (String) The unique identifier of the app.
-- `name` (String) The name of the app.
-
-#### Basic Configuration
-
+- `api_key` (String, Sensitive) The API key for the app.
+- `cluster_id` (String) The Kubernetes cluster identifier where the app is deployed.
+- `created_at` (String) The timestamp when the app was created.
 - `description` (String) A description of the app.
-- `visibility` (String) The visibility of the app (`public` or `private`).
-- `production_branch` (String) The production branch for the app.
-
-#### Spicepod Configuration
-
-- `spicepod` (String) The spicepod configuration as a JSON string.
-
-#### Runtime Configuration
-
+- `id` (String) The unique identifier of the app.
 - `image_tag` (String) The Spice.ai runtime image tag.
-- `replicas` (Number) The number of replicas.
+- `name` (String) The name of the app.
 - `node_group` (String) The node group for the app.
+- `production_branch` (String) The production branch for the app.
 - `region` (String) The region where the app is deployed.
+- `replicas` (Number) The number of replicas.
+- `spicepod` (String) The spicepod configuration as a JSON string.
 - `storage_claim_size_gb` (Number) The storage claim size in GB.
-
-#### Metadata
-
-- `created_at` (String) The timestamp when the app was created.
-- `api_key` (String, Sensitive) The API key for the app.
+- `visibility` (String) The visibility of the app (`public` or `private`).

docs/index.md

@@ -1,28 +1,49 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "spiceai Provider"
-subcategory: ""
 description: |-
   The Spice.ai provider allows you to manage Spice.ai Cloud resources.
+  Authentication
+  The provider uses OAuth client credentials for authentication. You can obtain these from the Spice.ai Cloud portal.
+  Credentials can be provided via:
+  Provider configuration blockEnvironment variables (recommended for CI/CD)
+  Example Usage
+  
+  provider "spiceai" {
+    # Credentials can also be set via environment variables:
+    # SPICEAI_CLIENT_ID and SPICEAI_CLIENT_SECRET
+    client_id     = var.spiceai_client_id
+    client_secret = var.spiceai_client_secret
+  }
 ---
 
-# Spice.ai Provider
+# spiceai Provider
 
-The Spice.ai provider allows you to manage [Spice.ai Cloud](https://spice.ai) resources including apps and deployments.
+The Spice.ai provider allows you to manage Spice.ai Cloud resources.
 
 ## Authentication
 
-The provider uses OAuth client credentials for authentication. You can obtain these credentials from the [Spice.ai Cloud portal](https://spice.ai).
+The provider uses OAuth client credentials for authentication. You can obtain these from the Spice.ai Cloud portal.
 
 Credentials can be provided via:
 - Provider configuration block
 - Environment variables (recommended for CI/CD)
 
 ## Example Usage
 
-### Using Environment Variables (Recommended)
+```hcl
+provider "spiceai" {
+  # Credentials can also be set via environment variables:
+  # SPICEAI_CLIENT_ID and SPICEAI_CLIENT_SECRET
+  client_id     = var.spiceai_client_id
+  client_secret = var.spiceai_client_secret
+}
+```
+
+## Example Usage
 
 ```terraform
+# Configure the Spice.ai provider
 terraform {
   required_providers {
     spiceai = {
@@ -32,46 +53,25 @@ terraform {
   }
 }
 
-# Provider configuration using environment variables:
-# - SPICEAI_CLIENT_ID
-# - SPICEAI_CLIENT_SECRET
-provider "spiceai" {}
-
-# Create an app with configuration
-resource "spiceai_app" "example" {
-  name        = "my-terraform-app"
-  description = "Managed by Terraform"
-  visibility  = "private"
-
-  spicepod = <<-YAML
-    version: v1beta1
-    kind: Spicepod
-    name: my-terraform-app
-    datasets:
-      - name: taxi_trips
-        from: s3://spiceai-demo-datasets/taxi_trips/2024/
-        params:
-          file_format: parquet
-  YAML
-
-  image_tag = "latest"
-  replicas  = 1
-}
-
-# Deploy the app
-resource "spiceai_deployment" "example" {
-  app_id = spiceai_app.example.id
-}
-```
-
-### Using Variables
-
-```terraform
+# Provider configuration using variables
 provider "spiceai" {
+  # OAuth client credentials for authentication
+  # These can also be set via environment variables:
+  #   SPICEAI_CLIENT_ID
+  #   SPICEAI_CLIENT_SECRET
   client_id     = var.spiceai_client_id
   client_secret = var.spiceai_client_secret
+
+  # Optional: Custom API endpoint (defaults to https://api.spice.ai)
+  # api_endpoint = "https://api.spice.ai"
+  api_endpoint = "https://dev-api.spice.ai"
+
+  # Optional: Custom OAuth endpoint (defaults to https://spice.ai/api/oauth/token)
+  # oauth_endpoint = "https://spice.ai/api/oauth/token"
+  oauth_endpoint = "https://dev.spice.ai/api/oauth/token"
 }
 
+# Variables for credentials
 variable "spiceai_client_id" {
   description = "OAuth client ID for Spice.ai API authentication"
   type        = string
@@ -83,16 +83,14 @@ variable "spiceai_client_secret" {
   type        = string
   sensitive   = true
 }
-```
 
-## Environment Variables
-
-| Variable | Description |
-|----------|-------------|
-| `SPICEAI_CLIENT_ID` | OAuth client ID for authentication |
-| `SPICEAI_CLIENT_SECRET` | OAuth client secret for authentication |
-| `SPICEAI_API_ENDPOINT` | API endpoint (default: `https://api.spice.ai`) |
-| `SPICEAI_OAUTH_ENDPOINT` | OAuth token endpoint (default: `https://spice.ai/api/oauth/token`) |
+# Alternative: Provider configuration using environment variables only
+# provider "spiceai" {
+#   # Credentials are automatically read from:
+#   # - SPICEAI_CLIENT_ID
+#   # - SPICEAI_CLIENT_SECRET
+# }
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
@@ -103,13 +101,4 @@ variable "spiceai_client_secret" {
 - `client_id` (String) The OAuth client ID for Spice.ai API authentication. Can also be set via the `SPICEAI_CLIENT_ID` environment variable.
 - `client_secret` (String, Sensitive) The OAuth client secret for Spice.ai API authentication. Can also be set via the `SPICEAI_CLIENT_SECRET` environment variable.
 - `oauth_endpoint` (String) The Spice.ai OAuth token endpoint. Defaults to `https://spice.ai/api/oauth/token`. Can also be set via the `SPICEAI_OAUTH_ENDPOINT` environment variable.
-
-## Resources
-
-- [spiceai_app](resources/app.md) - Manages a Spice.ai app and its configuration
-- [spiceai_deployment](resources/deployment.md) - Creates a deployment for a Spice.ai app
-
-## Data Sources
-
-- [spiceai_app](data-sources/app.md) - Retrieves details about an existing app
-- [spiceai_apps](data-sources/apps.md) - Lists all apps in the organization
+- `vercel_protection_bypass` (String, Sensitive) Optional bypass token for Vercel deployment protection. When set, adds the `x-vercel-protection-bypass` header to API requests. Can also be set via the `SPICEAI_VERCEL_PROTECTION_BYPASS` environment variable.