Merge pull request #4 from FoxNoseTech/docs/fix-inconsistency

Docs/fix inconsistency

Author: loookashow

README.md

@@ -6,7 +6,7 @@
 [![codecov](https://codecov.io/gh/FoxNoseTech/foxnose-python/graph/badge.svg)](https://codecov.io/gh/FoxNoseTech/foxnose-python)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-[FoxNose](https://foxnose.net) is a managed knowledge layer for RAG and AI agents — auto-embeddings, hybrid search, and zero ETL pipelines to maintain.
+[FoxNose](https://foxnose.net?utm_source=github&utm_medium=repository&utm_campaign=foxnose-python) is a managed knowledge layer for RAG and AI agents — auto-embeddings, hybrid search, and zero ETL pipelines to maintain.
 
 This is the official Python SDK for FoxNose Management and Flux APIs.
 
@@ -22,10 +22,10 @@ This is the official Python SDK for FoxNose Management and Flux APIs.
 **SDK Documentation:** [foxnose-python.readthedocs.io](https://foxnose-python.readthedocs.io)
 
 **FoxNose Platform:**
-- [Product Documentation](https://foxnose.net/docs)
-- [Guides](https://foxnose.net/docs/guides)
-- [Management API Reference](https://foxnose.net/docs/management-api/v1/get-started)
-- [Flux API Reference](https://foxnose.net/docs/flux-api/v1/get-started)
+- [Product Documentation](https://foxnose.net/docs?utm_source=github&utm_medium=repository&utm_campaign=foxnose-python)
+- [Guides](https://foxnose.net/docs/guides?utm_source=github&utm_medium=repository&utm_campaign=foxnose-python)
+- [Management API Reference](https://foxnose.net/docs/management-api/v1/get-started?utm_source=github&utm_medium=repository&utm_campaign=foxnose-python)
+- [Flux API Reference](https://foxnose.net/docs/flux-api/v1/get-started?utm_source=github&utm_medium=repository&utm_campaign=foxnose-python)
 
 ## Installation
 

docs/authentication.md

@@ -99,8 +99,8 @@ client = ManagementClient(
 
 # Create a Flux API key
 flux_key = client.create_flux_api_key({
-    "name": "Frontend Key",
-    "roles": ["reader-role-key"],
+    "description": "Frontend Key",
+    "role": "reader-role-key",
 })
 
 print(f"Key created: {flux_key.key}")

docs/error-handling.md

@@ -224,8 +224,10 @@ When creating or updating resources, validation errors include field-level detai
 ```python
 try:
     resource = client.create_resource("folder-key", {
-        "title": "",  # Required field is empty
-        "email": "invalid-email",  # Invalid format
+        "data": {
+            "title": "",  # Required field is empty
+            "email": "invalid-email",  # Invalid format
+        },
     })
 except FoxnoseAPIError as e:
     if e.status_code in (400, 422):

docs/examples.md

@@ -76,10 +76,9 @@ folder = client.get_folder("blog-posts")
 resources = client.list_resources(folder)
 
 # Chain objects through a full workflow
-resource = client.create_resource(folder, {"title": "New Article"})
+resource = client.create_resource(folder, {"data": {"title": "New Article"}})
 revision = client.create_revision(folder, resource, {
-    "title": "Draft Content",
-    "body": "...",
+    "data": {"title": "Draft Content", "body": "..."},
 })
 client.publish_revision(folder, resource, revision)
 
@@ -104,15 +103,14 @@ Complete resource lifecycle management:
 ```python
 # Create a resource
 resource = client.create_resource("blog-posts", {
-    "title": "My First Post",
-    "content": "Hello, world!",
+    "data": {"title": "My First Post", "content": "Hello, world!"},
 })
 
 # Create a new revision
 revision = client.create_revision(
     "blog-posts",
     resource.key,
-    {"title": "Updated Title", "content": "Updated content"},
+    {"data": {"title": "Updated Title", "content": "Updated content"}},
 )
 
 # Publish the revision
@@ -136,9 +134,9 @@ version = client.create_folder_version("blog-posts", {"name": "v2.0"})
 
 # Add fields
 client.create_folder_field("blog-posts", version.key, {
-    "name": "author",
-    "alias": "author",
-    "field_type": "text",
+    "key": "author",
+    "name": "Author",
+    "type": "text",
     "required": True,
 })
 
@@ -166,17 +164,15 @@ role = client.create_management_role({
 
 # Add permissions
 client.upsert_management_role_permission(role.key, {
-    "content_type": "document",
-    "can_read": True,
-    "can_create": True,
-    "can_update": True,
-    "can_delete": False,
+    "content_type": "resources",
+    "actions": ["read", "create", "update"],
+    "all_objects": True,
 })
 
 # Create an API key with this role
 api_key = client.create_management_api_key({
-    "name": "Editor Key",
-    "roles": [role.key],
+    "description": "Editor Key",
+    "role": role.key,
 })
 ```
 
@@ -203,10 +199,10 @@ client = FluxClient(
 
 # Get published content
 resource = client.get_resource("blog-posts", "my-article")
-print(resource["title"])
+print(resource["data"]["title"])
 
 # Search for content
-results = client.search("blog-posts", body={"query": "python"})
+results = client.search("blog-posts", body={"find_text": {"query": "python"}})
 ```
 
 ## Running Examples

docs/flux-client.md

@@ -45,14 +45,11 @@ Fetch a list of published resources from a folder:
 ```python
 resources = client.list_resources(
     "blog-posts",  # folder path
-    params={
-        "limit": 10,
-        "offset": 0,
-    },
+    params={"limit": 10},
 )
 
 for resource in resources["results"]:
-    print(f"{resource['key']}: {resource['title']}")
+    print(f"{resource['_sys']['key']}: {resource['data']['title']}")
 ```
 
 ### Get Resource
@@ -61,8 +58,8 @@ Fetch a specific resource by key:
 
 ```python
 resource = client.get_resource("blog-posts", "my-first-post")
-print(resource["title"])
-print(resource["content"])
+print(resource["data"]["title"])
+print(resource["data"]["content"])
 ```
 
 ### Get Resource with Params
@@ -71,7 +68,7 @@ print(resource["content"])
 resource = client.get_resource(
     "blog-posts",
     "my-article",
-    params={"locale": "de-DE"},
+    params={"return_locales": "de"},
 )
 ```
 
@@ -83,13 +80,13 @@ Search for resources within a folder:
 results = client.search(
     "blog-posts",
     body={
-        "query": "python tutorial",
+        "find_text": {"query": "python tutorial"},
         "limit": 10,
     },
 )
 
-for hit in results["hits"]:
-    print(f"{hit['title']} (score: {hit['_score']})")
+for item in results["results"]:
+    print(item["data"]["title"])
 ```
 
 ## Query Parameters
@@ -100,8 +97,8 @@ for hit in results["hits"]:
 resources = client.list_resources(
     "products",
     params={
-        "filter[category]": "electronics",
-        "filter[in_stock]": "true",
+        "where__category__eq": "electronics",
+        "where__in_stock__eq": "true",
     },
 )
 ```
@@ -121,12 +118,13 @@ resources = client.list_resources(
 
 ```python
 # First page
-page1 = client.list_resources("posts", params={"limit": 10, "offset": 0})
+page1 = client.list_resources("posts", params={"limit": 10})
 
-# Second page
-page2 = client.list_resources("posts", params={"limit": 10, "offset": 10})
+# Next page (use the cursor from the previous response)
+if page1["next"]:
+    page2 = client.list_resources("posts", params={"limit": 10, "next": "<cursor>"})
 
-print(f"Total: {page1['count']}")
+print(f"Got {len(page1['results'])} items")
 ```
 
 ## Error Handling

docs/management-client.md

@@ -48,8 +48,8 @@ This works across all methods and supports chaining naturally:
 ```python
 # Create a resource and publish a revision in one flow
 folder = client.get_folder("blog-posts")
-resource = client.create_resource(folder, {"title": "New Post"})
-revision = client.create_revision(folder, resource, {"title": "Draft"})
+resource = client.create_resource(folder, {"data": {"title": "New Post"}})
+revision = client.create_revision(folder, resource, {"data": {"title": "Draft"}})
 client.publish_revision(folder, resource, revision)
 ```
 
@@ -157,8 +157,10 @@ resource = client.get_resource("folder-key", "resource-key")
 resource = client.create_resource(
     "folder-key",
     {
-        "title": "My Article",
-        "content": "Article content here...",
+        "data": {
+            "title": "My Article",
+            "content": "Article content here...",
+        },
     },
 )
 ```
@@ -169,10 +171,7 @@ resource = client.create_resource(
 resource = client.update_resource(
     "folder-key",
     "resource-key",
-    {
-        "title": "Updated Title",
-        "content": "Updated content...",
-    },
+    {"name": "Updated Resource Name"},
 )
 ```
 
@@ -203,8 +202,10 @@ revision = client.create_revision(
     "folder-key",
     "resource-key",
     {
-        "title": "New Title",
-        "content": "New content...",
+        "data": {
+            "title": "New Title",
+            "content": "New content...",
+        },
     },
 )
 ```
@@ -257,9 +258,9 @@ field = client.create_folder_field(
     "folder-key",
     "version-key",
     {
-        "name": "title",
-        "alias": "title",
-        "field_type": "text",
+        "key": "title",
+        "name": "Title",
+        "type": "text",
         "required": True,
     },
 )
@@ -295,11 +296,9 @@ role = client.create_management_role({
 client.upsert_management_role_permission(
     "role-key",
     {
-        "content_type": "document",
-        "can_read": True,
-        "can_create": True,
-        "can_update": True,
-        "can_delete": False,
+        "content_type": "resources",
+        "actions": ["read", "create", "update"],
+        "all_objects": True,
     },
 )
 ```
@@ -317,8 +316,9 @@ role = client.create_flux_role({
 client.upsert_flux_role_permission(
     "role-key",
     {
-        "content_type": "document",
-        "can_read": True,
+        "content_type": "flux-apis",
+        "actions": ["read"],
+        "all_objects": True,
     },
 )
 ```
@@ -328,14 +328,14 @@ client.upsert_flux_role_permission(
 ```python
 # Management API key
 mgmt_key = client.create_management_api_key({
-    "name": "CI/CD Key",
-    "roles": ["role-key-1", "role-key-2"],
+    "description": "CI/CD Key",
+    "role": "role-key-1",
 })
 
 # Flux API key
 flux_key = client.create_flux_api_key({
-    "name": "Frontend Key",
-    "roles": ["reader-role"],
+    "description": "Frontend Key",
+    "role": "reader-role",
 })
 ```
 

mkdocs.yml

@@ -1,5 +1,5 @@
 site_name: FoxNose Python SDK
-site_url: https://foxnosetech.github.io/foxnose-python/
+site_url: https://foxnose-python.readthedocs.io/en/latest/
 site_description: Official Python client for FoxNose Management and Flux APIs
 site_author: FoxNose
 
@@ -83,6 +83,6 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/FoxNoseTech/foxnose-python
     - icon: fontawesome/solid/globe
-      link: https://foxnose.net
+      link: https://foxnose.net?utm_source=readthedocs&utm_medium=documentation&utm_campaign=foxnose-python
 
 copyright: Copyright © 2024-2026 FoxNose

pyproject.toml

@@ -46,7 +46,7 @@ docs = [
 ]
 
 [project.urls]
-"Homepage" = "https://foxnose.net"
+"Homepage" = "https://foxnose.net?utm_source=pypi&utm_medium=repository&utm_campaign=foxnose-python"
 "Source" = "https://github.com/FoxNoseTech/foxnose-python"
 "Documentation" = "https://foxnose-python.readthedocs.io"