Update docs

Joystream · Nov 18, 2024 · 88b97b0 · 88b97b0
1 parent 1980c90
commit 88b97b0
Show file tree

Hide file tree

Showing 7 changed files with 90 additions and 31 deletions.
diff --git a/.../definition-properties-public-api-configuration-properties-disablenewsignups.md b/.../definition-properties-public-api-configuration-properties-disablenewsignups.md
@@ -0,0 +1,3 @@
+## disableNewSignUps Type
+
+`boolean`
diff --git a/docs/config/definition-properties-public-api-configuration.md b/docs/config/definition-properties-public-api-configuration.md
@@ -4,10 +4,11 @@
 
 # httpApi Properties
 
-| Property              | Type     | Required | Nullable       | Defined by                                                                                                                                                                                            |
-| :-------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [port](#port)         | `number` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-port.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/port")         |
-| [ownerKey](#ownerkey) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-ownerkey.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/ownerKey") |
+| Property                                | Type      | Required | Nullable       | Defined by                                                                                                                                                                                                              |
+| :-------------------------------------- | :-------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [port](#port)                           | `number`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-port.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/port")                           |
+| [ownerKey](#ownerkey)                   | `string`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-ownerkey.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/ownerKey")                   |
+| [disableNewSignUps](#disablenewsignups) | `boolean` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-disablenewsignups.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/disableNewSignUps") |
 
 ## port
 
@@ -44,3 +45,21 @@
 ### ownerKey Type
 
 `string`
+
+## disableNewSignUps
+
+
+
+`disableNewSignUps`
+
+*   is optional
+
+*   Type: `boolean`
+
+*   cannot be null
+
+*   defined in: [Youtube Sync node configuration](definition-properties-public-api-configuration-properties-disablenewsignups.md "https://joystream.org/schemas/youtube-synch/config#/properties/httpApi/properties/disableNewSignUps")
+
+### disableNewSignUps Type
+
+`boolean`
diff --git a/...ration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls-items.md b/...ration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls-items.md
@@ -0,0 +1,3 @@
+## items Type
+
+`string`
diff --git a/...onfiguration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls.md b/...onfiguration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls.md
@@ -0,0 +1,7 @@
+## urls Type
+
+`string[]`
+
+## urls Constraints
+
+**minimum number of items**: the minimum number of items for this array is: `1`
diff --git a/...5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube.md b/...5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube.md
@@ -4,43 +4,28 @@
 
 # proxy Properties
 
-| Property                    | Type     | Required | Nullable       | Defined by                                                                                                                                                                                                                                                         |
-| :-------------------------- | :------- | :------- | :------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [url](#url)                 | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-url.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/url")                 |
-| [chiselProxy](#chiselproxy) | `object` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-chiselproxy.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/chiselProxy") |
+| Property      | Type    | Required | Nullable       | Defined by                                                                                                                                                                                                                                           |
+| :------------ | :------ | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [urls](#urls) | `array` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/urls") |
 
-## url
+## urls
 
-Proxy Client URL e.g. socks\://localhost:1080, socks\://user:password\@localhost:1080
+List of available socks5 proxy URLs
 
-`url`
+`urls`
 
 *   is optional
 
-*   Type: `string`
+*   Type: `string[]`
 
 *   cannot be null
 
-*   defined in: [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-url.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/url")
+*   defined in: [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-urls.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/urls")
 
-### url Type
+### urls Type
 
-`string`
+`string[]`
 
-## chiselProxy
+### urls Constraints
 
-Configuration option to manage Chisel Client & Server. Before enabling this option please refer to setup guide in `socks5-proxy/SETUP.md`
-
-`chiselProxy`
-
-*   is optional
-
-*   Type: `object` ([Details](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-chiselproxy.md))
-
-*   cannot be null
-
-*   defined in: [Youtube Sync node configuration](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-chiselproxy.md "https://joystream.org/schemas/youtube-synch/config#/properties/proxy/properties/chiselProxy")
-
-### chiselProxy Type
-
-`object` ([Details](definition-properties-socks5-proxy-client-configuration-used-by-yt-dlp-to-bypass-ip-blockage-by-youtube-properties-chiselproxy.md))
+**minimum number of items**: the minimum number of items for this array is: `1`
diff --git a/...onization-related-settings-properties-limits-properties-bandwidthperdownload.md b/...onization-related-settings-properties-limits-properties-bandwidthperdownload.md
@@ -0,0 +1,13 @@
+## bandwidthPerDownload Type
+
+`string`
+
+## bandwidthPerDownload Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+[1-9][0-9]*(K|M)
+```
+
+[try pattern](https://regexr.com/?expression=%5B1-9%5D%5B0-9%5D\*\(K%7CM\) "try regular expression with regexr.com")
diff --git a/...nition-properties-yt-synch-syncronization-related-settings-properties-limits.md b/...nition-properties-yt-synch-syncronization-related-settings-properties-limits.md
@@ -8,6 +8,7 @@
 | :------------------------------------------------------ | :-------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [dailyApiQuota](#dailyapiquota)                         | `object`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-specifies-daily-youtube-api-quota-rationing-scheme-for-youtube-partner-program.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/dailyApiQuota") |
 | [maxConcurrentDownloads](#maxconcurrentdownloads)       | `number`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-maxconcurrentdownloads.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/maxConcurrentDownloads")                                                |
+| [bandwidthPerDownload](#bandwidthperdownload)           | `string`  | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-bandwidthperdownload.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/bandwidthPerDownload")                                                    |
 | [createVideoTxBatchSize](#createvideotxbatchsize)       | `number`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-createvideotxbatchsize.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/createVideoTxBatchSize")                                                |
 | [maxConcurrentUploads](#maxconcurrentuploads)           | `number`  | Required | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-maxconcurrentuploads.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/maxConcurrentUploads")                                                    |
 | [pendingDownloadTimeoutSec](#pendingdownloadtimeoutsec) | `integer` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-pendingdownloadtimeoutsec.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/pendingDownloadTimeoutSec")                                          |
@@ -57,6 +58,34 @@ The default value is:
 50
 ```
 
+## bandwidthPerDownload
+
+Bandwidth limit per each individual video download (in bytes per second, e.g. 500K, 1M etc.)
+
+`bandwidthPerDownload`
+
+*   is optional
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Youtube Sync node configuration](definition-properties-yt-synch-syncronization-related-settings-properties-limits-properties-bandwidthperdownload.md "https://joystream.org/schemas/youtube-synch/config#/properties/sync/properties/limits/properties/bandwidthPerDownload")
+
+### bandwidthPerDownload Type
+
+`string`
+
+### bandwidthPerDownload Constraints
+
+**pattern**: the string must match the following regular expression: 
+
+```regexp
+[1-9][0-9]*(K|M)
+```
+
+[try pattern](https://regexr.com/?expression=%5B1-9%5D%5B0-9%5D\*\(K%7CM\) "try regular expression with regexr.com")
+
 ## createVideoTxBatchSize
 
 No. of videos that should be created in a batched 'create_video' tx