doc: fix the doc of channel

Cap-go · Apr 5, 2024 · 1f22d47 · 1f22d47
1 parent 82290d3
commit 1f22d47
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 14 deletions.
diff --git a/src/content/docs/docs/plugin/debugging.mdx b/src/content/docs/docs/plugin/debugging.mdx
@@ -18,7 +18,7 @@ import { LinkCard, CardGrid } from '@astrojs/starlight/components';
 | **noNew**                                        | The device has the latest available version.                                                                                                                                |
 | **disablePlatformIos**                           | The device is on the iOS platform, but that is disabled in the channel settings.                                                                                            |
 | **disablePlatformAndroid**                       | The device is on the Android platform, but that is disabled in the channel settings.                                                                                        |
-| **disableAutoUpdateToMajor**                     | The device has version (`1.2.3`), and the channel has a major update (`2.0.0`) to send, but that is disabled in the channel settings.                                       |
+| **disableAutoUpdate**                            | "major" | "minor" | "version_number" | "none"                                       |
 | **disableAutoUpdateUnderNative**                 | The device has version (`1.2.3`), and the channel has an update (`1.2.2`) under the device version to send, but that is disabled in the channel settings.                   |
 | **disableDevBuild**                              | The device has a dev build, but that is disabled in the channel settings.                                                                                                   |
 | **disableEmulator**                              | The device is an emulator, but that is disabled in the channel settings.                                                                                                    |

diff --git a/src/content/docs/docs/tooling/api.md b/src/content/docs/docs/tooling/api.md
@@ -22,13 +22,14 @@ This endpoint allows you to check and modify all available Channels of your app
 Send this to create or update channel
 
 ```typescript
+type disable_update = "major" | "minor" | "version_number" | "none"
 interface ChannelSet {
   app_id: string
   channel: string
   version?: string
   public?: boolean
   disableAutoUpdateUnderNative?: boolean
-  disableAutoUpdateToMajor?: boolean
+  disableAutoUpdate?: disable_update
   ios?: boolean
   android?: boolean
   allow_device_self_set?: boolean
@@ -64,7 +65,7 @@ interface Channel {
     updated_at: string;
     public: boolean; // default or not
     disableAutoUpdateUnderNative: boolean;
-    disableAutoUpdateToMajor: boolean;
+    disableAutoUpdate: boolean;
     allow_emulator: boolean;
     allow_dev: boolean;
 }[]
@@ -86,7 +87,7 @@ interface Channel {
     updated_at: string;
     public: boolean; // default or not
     disableAutoUpdateUnderNative: boolean;
-    disableAutoUpdateToMajor: boolean;
+    disableAutoUpdate: boolean;
     allow_emulator: boolean;
     allow_dev: boolean;
 }
@@ -213,16 +214,22 @@ You can get the next one by sending `page=1`
 
 ```typescript
 interface Bundle {
-    id: number;
-    created_at: string;
-    name: string;
-    app_id: string;
-    version: number;
-    created_by: string;
-    updated_at: string;
-    public: boolean;
-    disableAutoUpdateUnderNative: boolean;
-    disableAutoUpdateToMajor: boolean;
+  app_id: string
+  bucket_id: string | null
+  checksum: string | null
+  created_at: string | null
+  deleted: boolean
+  external_url: string | null
+  id: number
+  minUpdateVersion: string | null
+  name: string
+  native_packages: Json[] | null
+  owner_org: string
+  r2_path: string | null
+  session_key: string | null
+  storage_provider: string
+  updated_at: string | null
+  user_id: string | null
 }[]
 ```