diff --git a/docs/config/definition-properties-joystream-properties-faucet-properties-captchabypasskey.md b/docs/config/definition-properties-joystream-properties-faucet-properties-captchabypasskey.md deleted file mode 100644 index c450d7b..0000000 --- a/docs/config/definition-properties-joystream-properties-faucet-properties-captchabypasskey.md +++ /dev/null @@ -1,3 +0,0 @@ -## captchaBypassKey Type - -`string` diff --git a/docs/config/definition-properties-joystream-properties-faucet-properties-endpoint.md b/docs/config/definition-properties-joystream-properties-faucet-properties-endpoint.md deleted file mode 100644 index 00e8b7f..0000000 --- a/docs/config/definition-properties-joystream-properties-faucet-properties-endpoint.md +++ /dev/null @@ -1,3 +0,0 @@ -## endpoint Type - -`string` diff --git a/docs/config/definition-properties-joystream-properties-faucet.md b/docs/config/definition-properties-joystream-properties-faucet.md deleted file mode 100644 index 3abaa79..0000000 --- a/docs/config/definition-properties-joystream-properties-faucet.md +++ /dev/null @@ -1,46 +0,0 @@ -## faucet Type - -`object` ([Details](definition-properties-joystream-properties-faucet.md)) - -# faucet Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------------------------ | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [endpoint](#endpoint) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-joystream-properties-faucet-properties-endpoint.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet/properties/endpoint") | -| [captchaBypassKey](#captchabypasskey) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-joystream-properties-faucet-properties-captchabypasskey.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet/properties/captchaBypassKey") | - -## endpoint - -Joystream's faucet URL - -`endpoint` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-joystream-properties-faucet-properties-endpoint.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet/properties/endpoint") - -### endpoint Type - -`string` - -## captchaBypassKey - -Bearer Authentication Key needed to bypass captcha verification on Faucet - -`captchaBypassKey` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-joystream-properties-faucet-properties-captchabypasskey.md "https://joystream.org/schemas/youtube-synch/config#/properties/joystream/properties/faucet/properties/captchaBypassKey") - -### captchaBypassKey Type - -`string` diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration-dependencies.md b/docs/config/definition-properties-youtube-oauth2-client-configuration-dependencies.md deleted file mode 100644 index 5fece31..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration-dependencies.md +++ /dev/null @@ -1,3 +0,0 @@ -## dependencies Type - -unknown diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md b/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md deleted file mode 100644 index b029962..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md +++ /dev/null @@ -1,3 +0,0 @@ -## adcKeyFilePath Type - -`string` diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientid.md b/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientid.md deleted file mode 100644 index a7b5d5f..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientid.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientId Type - -`string` diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md b/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md deleted file mode 100644 index 5345214..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientSecret Type - -`string` diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md b/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md deleted file mode 100644 index 7c69248..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md +++ /dev/null @@ -1,11 +0,0 @@ -## maxAllowedQuotaUsageInPercentage Type - -`number` - -## maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` diff --git a/docs/config/definition-properties-youtube-oauth2-client-configuration.md b/docs/config/definition-properties-youtube-oauth2-client-configuration.md deleted file mode 100644 index e7b6352..0000000 --- a/docs/config/definition-properties-youtube-oauth2-client-configuration.md +++ /dev/null @@ -1,92 +0,0 @@ -## youtube Type - -`object` ([Youtube Oauth2 Client configuration](definition-properties-youtube-oauth2-client-configuration.md)) - -# youtube Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------------------------------------------- | :------- | :------- | :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [clientId](#clientid) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientId") | -| [clientSecret](#clientsecret) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientSecret") | -| [maxAllowedQuotaUsageInPercentage](#maxallowedquotausageinpercentage) | `number` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/maxAllowedQuotaUsageInPercentage") | -| [adcKeyFilePath](#adckeyfilepath) | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/adcKeyFilePath") | - -## clientId - -Youtube Oauth2 Client Id - -`clientId` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientId") - -### clientId Type - -`string` - -## clientSecret - -Youtube Oauth2 Client Secret - -`clientSecret` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientSecret") - -### clientSecret Type - -`string` - -## maxAllowedQuotaUsageInPercentage - -Maximum percentage of daily Youtube API quota that can be used by the Periodic polling service. Once this limit is reached the service will stop polling for new videos until the next day(when Quota resets). All the remaining quota (100 - maxAllowedQuotaUsageInPercentage) will be used for potential channel's signups. - -`maxAllowedQuotaUsageInPercentage` - -* is optional - -* Type: `number` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/maxAllowedQuotaUsageInPercentage") - -### maxAllowedQuotaUsageInPercentage Type - -`number` - -### maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` - -## adcKeyFilePath - -Path to the Google Cloud's Application Default Credentials (ADC) key file. It is required to periodically monitor the Youtube API quota usage. - -`adcKeyFilePath` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-oauth2-client-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/adcKeyFilePath") - -### adcKeyFilePath Type - -`string` diff --git a/docs/config/definition-properties-youtube-related-configuration-if-properties-apimode.md b/docs/config/definition-properties-youtube-related-configuration-if-properties-apimode.md deleted file mode 100644 index 646e3cc..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-if-properties-apimode.md +++ /dev/null @@ -1,12 +0,0 @@ -## apiMode Type - -unknown - -## apiMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :------- | :---------- | -| `"api"` | | -| `"both"` | | diff --git a/docs/config/definition-properties-youtube-related-configuration-if-properties-signupmode.md b/docs/config/definition-properties-youtube-related-configuration-if-properties-signupmode.md deleted file mode 100644 index 4bd9105..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-if-properties-signupmode.md +++ /dev/null @@ -1,12 +0,0 @@ -## signupMode Type - -unknown - -## signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :------- | :---------- | -| `"api"` | | -| `"both"` | | diff --git a/docs/config/definition-properties-youtube-related-configuration-if-properties.md b/docs/config/definition-properties-youtube-related-configuration-if-properties.md deleted file mode 100644 index c89940c..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-if-properties.md +++ /dev/null @@ -1,3 +0,0 @@ -## properties Type - -unknown diff --git a/docs/config/definition-properties-youtube-related-configuration-if.md b/docs/config/definition-properties-youtube-related-configuration-if.md deleted file mode 100644 index 00a9a02..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-if.md +++ /dev/null @@ -1,36 +0,0 @@ -## if Type - -unknown - -# if Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [apiMode](#apimode) | Not specified | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-if-properties-apimode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/if/properties/apiMode") | - -## apiMode - - - -`apiMode` - -* is optional - -* Type: unknown - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-if-properties-apimode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/if/properties/apiMode") - -### apiMode Type - -unknown - -### apiMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :------- | :---------- | -| `"api"` | | -| `"both"` | | diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-apimode.md b/docs/config/definition-properties-youtube-related-configuration-properties-apimode.md deleted file mode 100644 index 06e5445..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-apimode.md +++ /dev/null @@ -1,21 +0,0 @@ -## apiMode Type - -`string` - -## apiMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :----------- | :---------- | -| `"api-free"` | | -| `"api"` | | -| `"both"` | | - -## apiMode Default Value - -The default value is: - -```json -"both" -``` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-signupmode.md b/docs/config/definition-properties-youtube-related-configuration-properties-signupmode.md deleted file mode 100644 index c053e30..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-signupmode.md +++ /dev/null @@ -1,21 +0,0 @@ -## signupMode Type - -`string` - -## signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :----------- | :---------- | -| `"api-free"` | | -| `"api"` | | -| `"both"` | | - -## signupMode Default Value - -The default value is: - -```json -"both" -``` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-dependencies.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-dependencies.md deleted file mode 100644 index 5fece31..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-dependencies.md +++ /dev/null @@ -1,3 +0,0 @@ -## dependencies Type - -unknown diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-adckeyfilepath.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-adckeyfilepath.md deleted file mode 100644 index b029962..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-adckeyfilepath.md +++ /dev/null @@ -1,3 +0,0 @@ -## adcKeyFilePath Type - -`string` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientid.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientid.md deleted file mode 100644 index a7b5d5f..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientid.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientId Type - -`string` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientsecret.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientsecret.md deleted file mode 100644 index 5345214..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientsecret.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientSecret Type - -`string` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-maxallowedquotausageinpercentage.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-maxallowedquotausageinpercentage.md deleted file mode 100644 index 7c69248..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-maxallowedquotausageinpercentage.md +++ /dev/null @@ -1,11 +0,0 @@ -## maxAllowedQuotaUsageInPercentage Type - -`number` - -## maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` diff --git a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration.md b/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration.md deleted file mode 100644 index 59a856b..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-properties-youtube-api-configuration.md +++ /dev/null @@ -1,92 +0,0 @@ -## api Type - -`object` ([Youtube API configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration.md)) - -# api Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------------------------------------------- | :------- | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [clientId](#clientid) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/clientId") | -| [clientSecret](#clientsecret) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/clientSecret") | -| [maxAllowedQuotaUsageInPercentage](#maxallowedquotausageinpercentage) | `number` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/maxAllowedQuotaUsageInPercentage") | -| [adcKeyFilePath](#adckeyfilepath) | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/adcKeyFilePath") | - -## clientId - -Youtube Oauth2 Client Id - -`clientId` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/clientId") - -### clientId Type - -`string` - -## clientSecret - -Youtube Oauth2 Client Secret - -`clientSecret` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/clientSecret") - -### clientSecret Type - -`string` - -## maxAllowedQuotaUsageInPercentage - -Maximum percentage of daily Youtube API quota that can be used by the Periodic polling service. Once this limit is reached the service will stop polling for new videos until the next day(when Quota resets). All the remaining quota (100 - maxAllowedQuotaUsageInPercentage) will be used for potential channel's signups. - -`maxAllowedQuotaUsageInPercentage` - -* is optional - -* Type: `number` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/maxAllowedQuotaUsageInPercentage") - -### maxAllowedQuotaUsageInPercentage Type - -`number` - -### maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` - -## adcKeyFilePath - -Path to the Google Cloud's Application Default Credentials (ADC) key file. It is required to periodically monitor the Youtube API quota usage. - -`adcKeyFilePath` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-related-configuration-properties-youtube-api-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/api/properties/adcKeyFilePath") - -### adcKeyFilePath Type - -`string` diff --git a/docs/config/definition-properties-youtube-related-configuration-then.md b/docs/config/definition-properties-youtube-related-configuration-then.md deleted file mode 100644 index 139b21d..0000000 --- a/docs/config/definition-properties-youtube-related-configuration-then.md +++ /dev/null @@ -1,3 +0,0 @@ -## then Type - -unknown diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-dependencies.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-dependencies.md deleted file mode 100644 index 5fece31..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-dependencies.md +++ /dev/null @@ -1,3 +0,0 @@ -## dependencies Type - -unknown diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties-signupmode.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties-signupmode.md deleted file mode 100644 index 4bd9105..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties-signupmode.md +++ /dev/null @@ -1,12 +0,0 @@ -## signupMode Type - -unknown - -## signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :------- | :---------- | -| `"api"` | | -| `"both"` | | diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties.md deleted file mode 100644 index c89940c..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if-properties.md +++ /dev/null @@ -1,3 +0,0 @@ -## properties Type - -unknown diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if.md deleted file mode 100644 index 9af0067..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-if.md +++ /dev/null @@ -1,36 +0,0 @@ -## if Type - -unknown - -# if Properties - -| Property | Type | Required | Nullable | Defined by | -| :------------------------ | :------------ | :------- | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [signupMode](#signupmode) | Not specified | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-if-properties-signupmode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/if/properties/signupMode") | - -## signupMode - - - -`signupMode` - -* is optional - -* Type: unknown - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-if-properties-signupmode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/if/properties/signupMode") - -### signupMode Type - -unknown - -### signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :------- | :---------- | -| `"api"` | | -| `"both"` | | diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-adckeyfilepath.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-adckeyfilepath.md deleted file mode 100644 index b029962..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-adckeyfilepath.md +++ /dev/null @@ -1,3 +0,0 @@ -## adcKeyFilePath Type - -`string` diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientid.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientid.md deleted file mode 100644 index a7b5d5f..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientid.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientId Type - -`string` diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientsecret.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientsecret.md deleted file mode 100644 index 5345214..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-clientsecret.md +++ /dev/null @@ -1,3 +0,0 @@ -## clientSecret Type - -`string` diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-maxallowedquotausageinpercentage.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-maxallowedquotausageinpercentage.md deleted file mode 100644 index 7c69248..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-maxallowedquotausageinpercentage.md +++ /dev/null @@ -1,11 +0,0 @@ -## maxAllowedQuotaUsageInPercentage Type - -`number` - -## maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-signupmode.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-signupmode.md deleted file mode 100644 index c053e30..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-properties-signupmode.md +++ /dev/null @@ -1,21 +0,0 @@ -## signupMode Type - -`string` - -## signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :----------- | :---------- | -| `"api-free"` | | -| `"api"` | | -| `"both"` | | - -## signupMode Default Value - -The default value is: - -```json -"both" -``` diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-then.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration-then.md deleted file mode 100644 index 139b21d..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration-then.md +++ /dev/null @@ -1,3 +0,0 @@ -## then Type - -unknown diff --git a/docs/config/definition-properties-youtube-signuponboarding-related-configuration.md b/docs/config/definition-properties-youtube-signuponboarding-related-configuration.md deleted file mode 100644 index 8f1778c..0000000 --- a/docs/config/definition-properties-youtube-signuponboarding-related-configuration.md +++ /dev/null @@ -1,129 +0,0 @@ -## youtube Type - -`object` ([Youtube Signup/Onboarding related configuration](definition-properties-youtube-signuponboarding-related-configuration.md)) - -# youtube Properties - -| Property | Type | Required | Nullable | Defined by | -| :-------------------------------------------------------------------- | :------- | :------- | :------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [signupMode](#signupmode) | `string` | Required | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-signupmode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/signupMode") | -| [clientId](#clientid) | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientId") | -| [clientSecret](#clientsecret) | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientSecret") | -| [maxAllowedQuotaUsageInPercentage](#maxallowedquotausageinpercentage) | `number` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/maxAllowedQuotaUsageInPercentage") | -| [adcKeyFilePath](#adckeyfilepath) | `string` | Optional | cannot be null | [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/adcKeyFilePath") | - -## signupMode - - - -`signupMode` - -* is required - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-signupmode.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/signupMode") - -### signupMode Type - -`string` - -### signupMode Constraints - -**enum**: the value of this property must be equal to one of the following values: - -| Value | Explanation | -| :----------- | :---------- | -| `"api-free"` | | -| `"api"` | | -| `"both"` | | - -### signupMode Default Value - -The default value is: - -```json -"both" -``` - -## clientId - -Youtube Oauth2 Client Id - -`clientId` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-clientid.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientId") - -### clientId Type - -`string` - -## clientSecret - -Youtube Oauth2 Client Secret - -`clientSecret` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-clientsecret.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/clientSecret") - -### clientSecret Type - -`string` - -## maxAllowedQuotaUsageInPercentage - -Maximum percentage of daily Youtube API quota that can be used by the Periodic polling service. Once this limit is reached the service will stop polling for new videos until the next day(when Quota resets). All the remaining quota (100 - maxAllowedQuotaUsageInPercentage) will be used for potential channel's signups. - -`maxAllowedQuotaUsageInPercentage` - -* is optional - -* Type: `number` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-maxallowedquotausageinpercentage.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/maxAllowedQuotaUsageInPercentage") - -### maxAllowedQuotaUsageInPercentage Type - -`number` - -### maxAllowedQuotaUsageInPercentage Default Value - -The default value is: - -```json -95 -``` - -## adcKeyFilePath - -Path to the Google Cloud's Application Default Credentials (ADC) key file. It is required to periodically monitor the Youtube API quota usage. - -`adcKeyFilePath` - -* is optional - -* Type: `string` - -* cannot be null - -* defined in: [Youtube Sync node configuration](definition-properties-youtube-signuponboarding-related-configuration-properties-adckeyfilepath.md "https://joystream.org/schemas/youtube-synch/config#/properties/youtube/properties/adcKeyFilePath") - -### adcKeyFilePath Type - -`string` diff --git a/package.json b/package.json index ae56fa8..61c35ab 100644 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "dynamodb:local:start": "npm run dynamodb:local:stop && export DEPLOYMENT_ENV=local && ./src/infrastructure/deploy.sh", "dynamodb:local:stop": "export DEPLOYMENT_ENV=local REMOVE_PULUMI_STACK=true && ./src/infrastructure/destroy.sh", "generate:docs:cli": "npx oclif-dev readme --multi --dir ./docs/cli", - "generate:docs:config": "npx ts-node ./src/schemas/scripts/generateConfigDoc.ts", + "generate:docs:config": "rm -rf ./docs/config && npx ts-node ./src/schemas/scripts/generateConfigDoc.ts", "generate:docs:all": "npm run generate:docs:cli && npm run generate:docs:config", "generate:types:all": "npm run generate:types:json-schema && npm run generate:types:graphql", "generate:types:graphql": "npx graphql-codegen --config ./src/services/query-node/codegen.yml",