GitHubLoader
Description: Loads files from a GitHub repository. Note that you will likely hit rate limits on all but the smallest repositories unless a TOKEN is provided
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - implementation | No | const | No | - | GitHubLoader |
| + owner | No | string | No | - | Owner |
| + repo | No | string | No | - | Repo |
| - client_args | No | object | No | - | Client Args |
| - root_path | No | string | No | - | Root Path |
| - pattern | No | Combination | No | - | Pattern |
| - exclude | No | Combination | No | - | Exclude |
| - token | No | string | No | - | Token |
1. Property implementation
| Type | const |
| Required | No |
Description: GitHubLoader
Specific value: "GitHubLoader"
2. Property owner
Title: Owner
| Type | string |
| Required | Yes |
3. Property repo
Title: Repo
| Type | string |
| Required | Yes |
4. Property client_args
Title: Client Args
| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Default | {} |
5. Property root_path
Title: Root Path
| Type | string |
| Required | No |
| Default | null |
6. Property pattern
Title: Pattern
| Type | combining |
| Required | No |
| Additional properties | [Any type: allowed] |
| Default | "**" |
6.1. Property item 0
| Type | string |
| Required | No |
6.2. Property item 1
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| item 1 items | - |
6.2.1. item 1 items
| Type | string |
| Required | No |
7. Property exclude
Title: Exclude
| Type | combining |
| Required | No |
| Additional properties | [Any type: allowed] |
| Default | [] |
7.1. Property item 0
| Type | string |
| Required | No |
7.2. Property item 1
| Type | array of string |
| Required | No |
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| item 1 items | - |
7.2.1. item 1 items
| Type | string |
| Required | No |
8. Property token
Title: Token
| Type | string |
| Required | No |
Description: Github token, can also be set via envar ‘GITHUB_TOKEN’