8e9eaa8b66
* New source: punkapi * chore: Added docs, fix: Streams, Test: Pass * chore: Add doc URL * All comments resolved * Resolve Merge conflicts * Resolve Merge conflicts * feat: Added paginator, Introduced request params * feat: fixed paginator * add punk api to source def * update sample file * rebase * auto-bump connector version Co-authored-by: btkcodedev <btk.codedev@gmail.com> Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
2.2 KiB
2.2 KiB
Punk-API
This page contains the setup guide and reference information for the Punk-API source connector.
Prerequisites
Api key is not required for this connector to work,But a dummy key need to be passed to enhance in next versions. Example:123
Setup guide
Step 1: Set up Punk-API connection
- Pass a dummy API key (Example: 12345)
- Params (Optional ID)
Step 2: Set up the Punk-API connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- On the Set up the source page, enter the name for the Punk-API connector and select Punk-API from the Source type dropdown.
- Enter your dummy
api_key. - Enter the params configuration if needed: ID (Optional)
- Click Set up source.
For Airbyte OSS:
- Navigate to the Airbyte Open Source dashboard.
- Set the name for your source.
- Enter your dummy
api_key. - Enter the params configuration if needed: ID (Optional)
- Click Set up source.
Supported sync modes
The Punk-API source connector supports the following sync modes:
| Feature | Supported? |
|---|---|
| Full Refresh Sync | Yes |
| Incremental Sync | No |
| Replicate Incremental Deletes | No |
| SSL connection | Yes |
| Namespaces | No |
Supported Streams
- Beers
- Beers_with_ID
API method example
GET https://api.punkapi.com/v2/beers
Performance considerations
Punk API's API reference has v2 at present and v1 as depricated. The connector as default uses v2.
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 0.1.0 | 2022-10-31 | Init | Initial commit |