Update OpenAPI definitions #2589

steven-tey · 2025-06-29T03:16:04Z

Summary by CodeRabbit

New Features
- Added support for specifying currency in sales tracking, with automatic conversion to lowercase and a default of "usd".
- Made several fields in the partner creation process optional or nullable, allowing greater flexibility when submitting partner details.
Improvements
- Enhanced and clarified descriptions for country, region, and city fields across analytics and partner schemas, including reference links and ISO code format explanations.
- Improved descriptions for event and metadata fields in sales and partner schemas for better guidance.
- Reordered fields in lead and sales tracking forms for improved usability.
- Partner creation now defaults the name to the partner's email if no name is provided.
- Updated example code for sale event tracking to improve property ordering.
- Updated test resource URL to a new domain.
Bug Fixes
- Relaxed validation for country fields, now accepting any 2-letter ISO code string instead of a fixed set.

vercel · 2025-06-29T03:16:09Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
dub	✅ Ready (Inspect)	Visit Preview	Jun 29, 2025 4:31am

coderabbitai · 2025-06-29T03:16:28Z

"""

Walkthrough

This update revises several Zod schemas by relaxing country code validation from enums to strings, updating and expanding field descriptions, reordering schema fields, and making some fields optional or nullable. The changes primarily impact analytics, leads, partners, and sales schemas, focusing on flexibility and clarity in data validation and documentation. Additionally, partner creation logic was adjusted to default the partner name to email if no name is provided.

Changes

File(s)	Change Summary
apps/web/lib/zod/schemas/analytics-response.ts	Replaced `z.enum(COUNTRY_CODES)` with `z.string()` for all `country` fields; updated descriptions; reordered `region`.
apps/web/lib/zod/schemas/analytics.ts	Expanded `country` field description in `analyticsQuerySchema` to specify ISO code and provide a reference URL.
apps/web/lib/zod/schemas/leads.ts	Moved `eventQuantity` field to a later position within `trackLeadRequestSchema`.
apps/web/lib/zod/schemas/partners.ts	Made several fields in `createPartnerSchema` optional or nullable; updated and expanded field descriptions; added `tenantId`.
apps/web/lib/zod/schemas/sales.ts	Added `currency` field with default and transformation; reordered fields; expanded descriptions in `trackSaleRequestSchema`.
apps/web/lib/api/partners/create-and-enroll-partner.ts	Updated partner creation logic to default `name` to `email` if `name` is not provided.
apps/web/lib/actions/partners/onboard-partner.ts	Modified partner onboarding to default `name` to email if no explicit name is provided.
apps/web/guides/manual-track-sale.md	Moved `currency: "usd"` property position in example code for tracking sale event.
apps/web/tests/utils/resource.ts	Updated URL value in `E2E_PROGRAM` constant from `"https://acme.com"` to `"https://acme.dub.sh"`.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant ZodSchema
    participant PartnerAPI

    Client->>ZodSchema: Submit data with country codes as strings
    ZodSchema-->>Client: Validate country fields as strings (no enum)
    Client->>PartnerAPI: Create or onboard partner with optional name
    PartnerAPI->>PartnerAPI: If name missing, set name = email
    PartnerAPI-->>Client: Partner created with guaranteed name

Possibly related PRs

Don't use composite analytics by default #2539: Adds a nullable country string field to the partner object in the analytics response schema, related to country field validation changes.

Poem

In fields of code where schemas grow,
The enums fade, and strings now flow.
Descriptions bloom with detail bright,
Optional paths bring data light.
A rabbit hops with schema cheer—
More flexible forms are welcomed here!
🐇✨
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b084614 and 5b98efd.

📒 Files selected for processing (3)

apps/web/guides/manual-track-sale.md (1 hunks)
apps/web/lib/zod/schemas/partners.ts (2 hunks)
apps/web/tests/utils/resource.ts (1 hunks)

✅ Files skipped from review due to trivial changes (2)

apps/web/guides/manual-track-sale.md
apps/web/tests/utils/resource.ts

🚧 Files skipped from review as they are similar to previous changes (1)

apps/web/lib/zod/schemas/partners.ts

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: build

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

steven-tey · 2025-06-29T05:39:26Z

@CodeRabbit final review

coderabbitai · 2025-06-29T05:40:38Z

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

I'll conduct a comprehensive final review of this PR. Let me examine the key schema changes and their implications.

🏁 Script executed:

#!/bin/bash
# Let's examine the key schema files to understand the changes better
echo "=== Analytics Response Schema ==="
cat apps/web/lib/zod/schemas/analytics-response.ts

echo -e "\n=== Analytics Query Schema ==="
cat apps/web/lib/zod/schemas/analytics.ts

echo -e "\n=== Partners Schema ==="
cat apps/web/lib/zod/schemas/partners.ts

Length of output: 41813

🏁 Script executed:

#!/bin/bash
# Let's examine the sales schema and partner-related files to complete the review
echo "=== Sales Schema ==="
cat apps/web/lib/zod/schemas/sales.ts

echo -e "\n=== Leads Schema ==="
cat apps/web/lib/zod/schemas/leads.ts

echo -e "\n=== Partner Creation Logic ==="
cat apps/web/lib/api/partners/create-and-enroll-partner.ts

Length of output: 16081

@steven-tey

Final Review Summary

This PR represents a significant OpenAPI flexibility and documentation improvement with some important considerations:

✅ Strong Improvements

Enhanced Documentation: Excellent expansion of field descriptions with ISO standards references and helpful URLs (https://d.to/geo)
Partner Schema Flexibility: Smart changes making fields optional with intelligent fallbacks:
```
// Good fallback logic
name: partner.name || partner.email
```
Currency Handling: Well-implemented currency field with proper defaults and transformations:
```
currency: z.string().default("usd").transform(val => val.toLowerCase())
```
Consistent Partner Creation: Proper handling of missing names across both creation and onboarding flows

⚠️ Key Concerns

Breaking Change - Country Code Validation:

Analytics Response: Changed from z.enum(COUNTRY_CODES) → z.string()
Analytics Query: Still uses z.enum(COUNTRY_CODES) (inconsistent)
Impact: This relaxes validation significantly and could allow invalid country codes in responses

🔍 Validation Inconsistency

// Query validation (strict)
country: z.enum(COUNTRY_CODES).optional()

// Response validation (loose) 
country: z.string().describe("2-letter ISO 3166-1 country code")

Recommendation

The changes are well-executed overall, but consider:

Document the breaking change in your changelog/migration guide
Monitor data quality after deployment to ensure invalid country codes don't creep in
Consider alignment between query and response validation approaches

This is a solid PR that improves API usability and documentation. The country code validation change appears intentional for flexibility, but ensure your downstream systems can handle the relaxed validation.

Overall Assessment: ✅ Approved - Well-implemented flexibility improvements with clear documentation enhancements.

steven-tey added 2 commits June 28, 2025 20:06

Update OpenAPI definitions

eb1246f

more changes

af4c93c

steven-tey added 2 commits June 28, 2025 20:19

final changes

a4783b8

Update onboard-partner.ts

b084614

vercel bot temporarily deployed to Preview June 29, 2025 03:25 Inactive

Merge branch 'main' into update-openapi

ef84ed4

vercel bot had a problem deploying to Preview June 29, 2025 03:32 Failure

fix build

fb8a45b

vercel bot deployed to Preview June 29, 2025 03:57 View deployment

fix test

5b98efd

vercel bot deployed to Preview June 29, 2025 04:31 View deployment

steven-tey merged commit 17941c2 into main Jun 29, 2025
8 checks passed

steven-tey deleted the update-openapi branch June 29, 2025 17:43

coderabbitai bot mentioned this pull request Aug 13, 2025

Remove COUNTRY_CODES from OpenAPI spec #2748

Merged

coderabbitai bot mentioned this pull request Aug 21, 2025

Add publishableKey support + /track/**/client #2737

Merged

coderabbitai bot mentioned this pull request Aug 30, 2025

Move link settings under partner groups #2774

Merged

coderabbitai bot mentioned this pull request Sep 24, 2025

Partner profile updates #2872

Merged

This was referenced Oct 26, 2025

Add changeHistoryLog #3010

Merged

Add groupBy top_folders, top_link_tags, and top_domains #3022

Merged

coderabbitai bot mentioned this pull request Nov 17, 2025

Add support for top_base_urls #3120

Merged

coderabbitai bot mentioned this pull request Nov 26, 2025

Add POST /partners/ban API #3156

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update OpenAPI definitions #2589

Update OpenAPI definitions #2589

Uh oh!

steven-tey commented Jun 29, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jun 29, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jun 29, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

steven-tey commented Jun 29, 2025

Uh oh!

coderabbitai bot commented Jun 29, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Update OpenAPI definitions #2589

Update OpenAPI definitions #2589

Uh oh!

Conversation

steven-tey commented Jun 29, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jun 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

steven-tey commented Jun 29, 2025

Uh oh!

coderabbitai bot commented Jun 29, 2025

Final Review Summary

✅ Strong Improvements

⚠️ Key Concerns

🔍 Validation Inconsistency

Recommendation

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

steven-tey commented Jun 29, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jun 29, 2025 •

edited

Loading

coderabbitai bot commented Jun 29, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)