Skip to content

Commit

Permalink
add readme explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
TrishGillett committed Sep 19, 2024
1 parent a3a335e commit 24aa4ce
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ This tap accepts the following configuration options:
- `stream_maps_config`
- `rate_limit_buffer` - A buffer to avoid consuming all query points for the auth_token at hand. Defaults to 1000.
- `expiry_time_buffer` - A buffer used when determining when to refresh Github app tokens. Only relevant when authenticating as a GitHub app. Defaults to 10 minutes. Tokens generated by GitHub apps expire 1 hour after creation, and will be refreshed once fewer than `expiry_time_buffer` minutes remain until the anticipated expiry time.
- Stream specific:
- `milestones`: An object providing parameters to be used by the `milestones` stream.
- `state`: Valid settings are `open` (default), `closed`, `all`.

Note that modes 1-3 are `repository` modes and 4-5 are `user` modes and will not run the same set of streams.

Expand Down

0 comments on commit 24aa4ce

Please sign in to comment.