mrjsj · mrjsj · Dec 26, 2024 · Dec 26, 2024 · Dec 26, 2024 · Dec 26, 2024
diff --git a/README.md b/README.md
@@ -21,17 +21,22 @@ pip install msfabricutils
 
 
 
-### Fabric API
-- Create, update, delete workspaces, lakehouses, notebooks using the Fabric REST API.
+### Thin Fabric API wrapper
+Intregate functions to manage workspaces, lakehouses, notebooks, environments, libraries, etc.
+For more details, see the [Fabric API Reference](https://mrjsj.github.io/msfabricutils/core/fabric-api/)
 
-### Command Line Interface
-- Create, update, delete workspaces, lakehouses, notebooks using the built-in CLI.
+### Fabric API as CLI
+CLI for managing workspaces, lakehouses, notebooks, environments, libraries, etc.
 
 To get started, run:
 ```bash
 msfu --help
 ```
 
+![msfu CLI help](assets/images/cli-help.png)
+
+
+
 ### Fabric DuckDB Connection
 Seamless integration between DuckDB and Microsoft Fabric Lakehouses for data exploration and analysis.
 

diff --git a/assets/images/cli-help.png b/assets/images/cli-help.png
diff --git a/assets/images/cli-lakehouse-create.png b/assets/images/cli-lakehouse-create.png
diff --git a/docs/core/fabric-api/capacity.md b/docs/core/fabric-api/capacity.md
@@ -0,0 +1,9 @@
+# Capacity
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.capacity
+
diff --git a/docs/core/fabric-api/dashboard.md b/docs/core/fabric-api/dashboard.md
@@ -0,0 +1,9 @@
+# Dashboard
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.dashboard
+
diff --git a/docs/core/fabric-api/data_pipeline.md b/docs/core/fabric-api/data_pipeline.md
@@ -0,0 +1,9 @@
+# Data Pipeline
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.data_pipeline
+
diff --git a/docs/core/fabric-api/datamart.md b/docs/core/fabric-api/datamart.md
@@ -0,0 +1,9 @@
+# Datamart
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.datamart
+
diff --git a/docs/core/fabric-api/environment.md b/docs/core/fabric-api/environment.md
@@ -0,0 +1,9 @@
+# Environment
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.environment
+
diff --git a/docs/core/fabric-api/eventhouse.md b/docs/core/fabric-api/eventhouse.md
@@ -0,0 +1,9 @@
+# Eventhouse
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.eventhouse
+
diff --git a/docs/core/fabric-api/eventstream.md b/docs/core/fabric-api/eventstream.md
@@ -0,0 +1,9 @@
+# Eventstream
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.eventstream
+
diff --git a/docs/core/fabric-api/index.md b/docs/core/fabric-api/index.md
@@ -1,4 +1,14 @@
 # Fabric API
 
-A collection of functions to interact with the Fabric API. Automatically handles pagination and authentication.
-The functions can either be called with an `id` or `name` parameter, however it is recommended to use the `id` as using the name requires more API requests, and is thus slower.
+A collection of functions to interact with the Fabric API. I tried to mimic the API as closely as possible, however there are some differences, especially in relation to item defintions.
+
+While the APIs with item definitions takes multiple item parts as base64 encoded strings, these wrapper functions take a path to the folder containing the item parts, e.g.
+
+- `path/to/myReport.Report`
+- `path/to/mySemanticModel.SemanticModel`
+- `path/to/myNotebook.Notebook`.
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
diff --git a/docs/core/fabric-api/kql_dashboard.md b/docs/core/fabric-api/kql_dashboard.md
@@ -0,0 +1,9 @@
+# Kql Dashboard
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.kql_dashboard
+
diff --git a/docs/core/fabric-api/kql_database.md b/docs/core/fabric-api/kql_database.md
@@ -0,0 +1,9 @@
+# Kql Database
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.kql_database
+
diff --git a/docs/core/fabric-api/kql_queryset.md b/docs/core/fabric-api/kql_queryset.md
@@ -0,0 +1,9 @@
+# Kql Queryset
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.kql_queryset
+
diff --git a/docs/core/fabric-api/lakehouse.md b/docs/core/fabric-api/lakehouse.md
@@ -1,3 +1,9 @@
 # Lakehouse
 
-::: msfabricutils.core.lakehouse
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.lakehouse
+
diff --git a/docs/core/fabric-api/long_running_operation.md b/docs/core/fabric-api/long_running_operation.md
@@ -0,0 +1,9 @@
+# Long Running Operation
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.long_running_operation
+
diff --git a/docs/core/fabric-api/mirrored_database.md b/docs/core/fabric-api/mirrored_database.md
@@ -0,0 +1,9 @@
+# Mirrored Database
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.mirrored_database
+
diff --git a/docs/core/fabric-api/mirrored_warehouse.md b/docs/core/fabric-api/mirrored_warehouse.md
@@ -0,0 +1,9 @@
+# Mirrored Warehouse
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.mirrored_warehouse
+
diff --git a/docs/core/fabric-api/ml_experiment.md b/docs/core/fabric-api/ml_experiment.md
@@ -0,0 +1,9 @@
+# Ml Experiment
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.ml_experiment
+
diff --git a/docs/core/fabric-api/ml_model.md b/docs/core/fabric-api/ml_model.md
@@ -0,0 +1,9 @@
+# Ml Model
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.ml_model
+
diff --git a/docs/core/fabric-api/notebook.md b/docs/core/fabric-api/notebook.md
@@ -1,3 +1,9 @@
 # Notebook
 
-::: msfabricutils.core.notebook
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.notebook
+
diff --git a/docs/core/fabric-api/paginated_report.md b/docs/core/fabric-api/paginated_report.md
@@ -0,0 +1,9 @@
+# Paginated Report
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.paginated_report
+
diff --git a/docs/core/fabric-api/reflex.md b/docs/core/fabric-api/reflex.md
@@ -0,0 +1,9 @@
+# Reflex
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.reflex
+
diff --git a/docs/core/fabric-api/report.md b/docs/core/fabric-api/report.md
@@ -0,0 +1,9 @@
+# Report
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.report
+
diff --git a/docs/core/fabric-api/semantic_model.md b/docs/core/fabric-api/semantic_model.md
@@ -0,0 +1,9 @@
+# Semantic Model
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.semantic_model
+
diff --git a/docs/core/fabric-api/spark_job_definition.md b/docs/core/fabric-api/spark_job_definition.md
@@ -0,0 +1,9 @@
+# Spark Job Definition
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.spark_job_definition
+
diff --git a/docs/core/fabric-api/sql_endpoint.md b/docs/core/fabric-api/sql_endpoint.md
@@ -1,3 +1,9 @@
-# SQL Endpoint
+# Sql Endpoint
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.sql_endpoint
 
-::: msfabricutils.core.sql_endpoint
diff --git a/docs/core/fabric-api/warehouse.md b/docs/core/fabric-api/warehouse.md
@@ -0,0 +1,9 @@
+# Warehouse
+
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.warehouse
+
diff --git a/docs/core/fabric-api/workspace.md b/docs/core/fabric-api/workspace.md
@@ -1,3 +1,9 @@
 # Workspace
 
-::: msfabricutils.core.workspace
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
+
+::: msfabricutils.rest_api.workspace
+
diff --git a/docs/usage/cli.md b/docs/usage/cli.md
@@ -4,23 +4,15 @@ The CLI is a way to interact with the Microsoft Fabric REST API. It includes com
 
 For complete documentation, run `msfu --help`.
 
-## Examples
-
-### Workspace
+!!! warning
+    The functions are not fully tested yet.
+    Use with caution.
+    Please report any issues to the [GitHub repository](https://github.com/mrjsj/msfabricutils/issues).
 
-```bash
-msfu workspace create --name "My Workspace" --description "My workspace description"
-```
 
-### Lakehouse
-
-```bash
-msfu lakehouse create --name "My Lakehouse" --workspace-id "beefbeef-beef-beef-beef-beefbeefbeef" --enable-schemas
-```
+## Examples
 
-### Notebook
+![msfu CLI help](/assets/images/cli-help.png)
 
-```bash
-msfu notebook create --path "path/to/notebook.Notebook" --workspace-id "beefbeef-beef-beef-beef-beefbeefbeef"
-```
+![msfu CLI lakehouse create](/assets/images/cli-lakehouse-create.png)
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -34,6 +34,7 @@ theme:
 plugins:
   - search:
       lang: en
+  - include_dir_to_nav
   - gen-files:
       scripts:
         - docs/gen_ref_pages.py
@@ -67,12 +68,7 @@ nav:
   - API Reference:
     - Core:
       - core/authentication.md
-      - Fabric API:
-        - core/fabric-api/index.md
-        - core/fabric-api/workspace.md
-        - core/fabric-api/lakehouse.md
-        - core/fabric-api/notebook.md
-        - core/fabric-api/sql_endpoint.md
+      - Fabric API: core/fabric-api
     - ETL:
       - etl/index.md
       - etl/read.md

diff --git a/scripts/cli/commands/capacity.yaml b/scripts/cli/commands/capacity.yaml
@@ -0,0 +1,13 @@
+command: capacity
+subcommands:
+  list:
+    endpoint: capacities
+    method: get
+    description: List capacities for a workspace.
+    panel: Capacity
+    args:
+      - name: continuation-token
+        type: str
+        required: false
+        arg_type: query
+        description: A token for retrieving the next page of results.
diff --git a/scripts/cli/commands/dashboard.yaml b/scripts/cli/commands/dashboard.yaml
@@ -0,0 +1,18 @@
+command: dashboard
+subcommands:
+  list:
+    endpoint: workspaces/{workspace_id}/dashboards
+    method: get
+    description: List dashboards for a workspace.
+    panel: Dashboard
+    args:
+      - name: workspace-id
+        type: str
+        required: true
+        arg_type: path
+        description: The id of the workspace to list dashboards for.
+      - name: continuation-token
+        type: str
+        required: false
+        arg_type: query
+        description: A token for retrieving the next page of results.