-
Notifications
You must be signed in to change notification settings - Fork 293
tier-1/batch-4: refactor API versioning to use versioning-info module #3474
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request refactors API versioning across five destinations to use a centralized versioning-info.ts module pattern. This is part of a larger effort (tier-1/batch-4) to standardize how API versions are managed across all destination integrations. The changes extract hardcoded API version strings into dedicated versioning info files with descriptive constant names and API reference documentation.
Key Changes
- Centralized API version management by creating
versioning-info.tsfiles for each destination - Removed inline API version constants and replaced them with imports from versioning-info modules
- Added descriptive JSDoc comments with API reference links for each version constant
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
packages/destination-actions/src/destinations/the-trade-desk-crm/versioning-info.ts |
Creates new versioning module with THE_TRADE_DESK_CRM_API_VERSION constant (v3) |
packages/destination-actions/src/destinations/the-trade-desk-crm/index.ts |
Imports and uses THE_TRADE_DESK_CRM_API_VERSION, removes inline API_VERSION constant |
packages/destination-actions/src/destinations/the-trade-desk-crm/functions.ts |
Imports and uses THE_TRADE_DESK_CRM_API_VERSION, removes local API_VERSION constant |
packages/destination-actions/src/destinations/reddit-audiences/versioning-info.ts |
Creates versioning module with separate constants for auth API (v1) and ads API (v3) |
packages/destination-actions/src/destinations/reddit-audiences/syncAudience/functions.ts |
Uses REDDIT_AUDIENCES_ADS_API_VERSION for audience update endpoint |
packages/destination-actions/src/destinations/reddit-audiences/index.ts |
Uses REDDIT_AUDIENCES_AUTH_API_VERSION for OAuth token refresh endpoint |
packages/destination-actions/src/destinations/linkedin-conversions/versioning-info.ts |
Creates versioning module with date-based version (202505) |
packages/destination-actions/src/destinations/linkedin-conversions/constants.ts |
Imports LINKEDIN_CONVERSIONS_API_VERSION and assigns to existing LINKEDIN_API_VERSION export |
packages/destination-actions/src/destinations/display-video-360/versioning-info.ts |
Creates versioning module for Google Audience Partner API (v2) |
packages/destination-actions/src/destinations/display-video-360/constants.ts |
Replaces GOOGLE_API_VERSION with DISPLAY_VIDEO_360_AUDIENCE_PARTNER_API_VERSION |
packages/destination-actions/src/destinations/amazon-amc/versioning-info.ts |
Creates versioning module with separate constants for AMC API (v1) and auth API (v2) |
packages/destination-actions/src/destinations/amazon-amc/index.ts |
Uses AMAZON_AMC_AUTH_API_VERSION for profiles endpoint |
packages/destination-actions/src/destinations/amazon-amc/function.ts |
Uses AMAZON_AMC_API_VERSION in Content-Type header for audience records |
packages/destination-actions/src/destinations/linkedin-conversions/versioning-info.ts
Outdated
Show resolved
Hide resolved
packages/destination-actions/src/destinations/amazon-amc/versioning-info.ts
Outdated
Show resolved
Hide resolved
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3474 +/- ##
==========================================
+ Coverage 80.02% 80.04% +0.01%
==========================================
Files 1226 1231 +5
Lines 22769 22781 +12
Branches 4525 4525
==========================================
+ Hits 18222 18234 +12
Misses 3711 3711
Partials 836 836 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
A summary of your pull request, including the what change you're making and why.
Testing
Include any additional information about the testing you have completed to
ensure your changes behave as expected. For a speedy review, please check
any of the tasks you completed below during your testing.
Security Review
Please ensure sensitive data is properly protected in your integration.
type: 'password'