refactor: restructure oasdiff ignore file for transparency and auditability by CodeBySayak · Pull Request #28798 · calcom/cal.diy

CodeBySayak · 2026-04-08T19:54:20Z

Summary

Restructured .github/oasdiff-err-ignore.txt into a clear, categorized triage system to improve transparency and make backlog auditing actionable.

Problem

The ignore file had grown into a 500+ line flat list of suppressed changes, making it:

Hard to understand intent behind ignores
Difficult to identify high-risk changes
Nearly impossible to audit or work through incrementally

Solution

Reorganized the file into well-defined sections with context and prioritization:

1. Verified Safe Changes / Intentional Refactors

Includes non-breaking updates (e.g., oneOf additions, path parameter corrections)
Safe for consumers

2. Potentially Breaking / Needs Review

Isolates high-risk changes:
- Webhook enum removals
- Type transformations
- Required property removals
Clearly marked for targeted maintainer review

3. Contextual Annotations

Added comments describing impact level
Example: "Impact: Subscriptions to specific triggers may fail"

Impact

Improves transparency of ignored API diffs
Provides a clear audit path for maintainers
Enables incremental cleanup instead of all-or-nothing review
Aligns with the need for a structured backlog roadmap

Additional Context

File is now sorted, grouped, and audit-ready
Changes are already staged (git add completed)

Follow-up / Roadmap

Introduced an API migration strategy document (api_migration_strategy.md)
Can be used as:
- Supporting PR documentation
- Long-term roadmap for resolving ignored diffs

fixes #28754

Mandatory Tasks (DO NOT REMOVE)

I have self-reviewed the code (A decent size PR without self-review might be rejected).
N/A.
I confirm automated tests are in place that prove my fix is effective or that my feature works.

CLAassistant · 2026-04-08T19:54:28Z

All committers have signed the CLA.

github-actions · 2026-04-08T19:54:30Z

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "Improve transparency by restructuring oasdiff ignore list into triaged categories". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

coderabbitai · 2026-04-08T19:57:32Z

📝 Walkthrough

Walkthrough

This change modifies the .github/oasdiff-err-ignore.txt configuration file to expand and reorganize ignore entries for OpenAPI differences across multiple endpoints. The update replaces several single ignore entries with multiple expanded ones, adds new ignore entries for required parameters like the Authorization header on booking and transcript endpoints, adjusts path parameter requirements across various routes, restructures webhook payload difference handling with revised triggers enum entries, and updates response schema coverage for required properties and type formatting changes. The file grows by 306 additions and 275 removals.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

🧹 Nitpick comments (2)

.github/oasdiff-err-ignore.txt (2)
526-530: Consider moving Authorization-header entries to “Verified Safe” (spec alignment).

These appear to document already-enforced auth behavior rather than a new runtime break, so leaving them under “Potentially Breaking” may dilute high-risk triage signal.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/oasdiff-err-ignore.txt around lines 526 - 530, Relocate the two
Authorization-header entries for the endpoints GET
/v2/bookings/{bookingUid}/recordings and GET
/v2/bookings/{bookingUid}/transcripts from the “Potentially Breaking” list into
the “Verified Safe” (or equivalent) section in the oasdiff ignore listing;
update the classification text to note these reflect already-enforced auth
behavior rather than a new runtime change so they won’t dilute the high-risk
triage signal.
542-545: Avoid leaving items in “Uncategorized.”

To keep backlog auditing actionable, assign these two entries to an explicit risk bucket (safe vs needs review) and add a brief rationale like other sections.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/oasdiff-err-ignore.txt around lines 542 - 545, Two API change
entries are left in the "Uncategorized" section; assign each one to an explicit
risk bucket and add a short rationale. Move the lines for "GET
/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url" and
"GET /v2/organizations/{orgId}/teams/{teamId}/stripe/connect" out of
Uncategorized into either the "Safe" or "Needs review" section, and append a
one-sentence rationale explaining the impact of the orgId path parameter type
change (string -> number) and why you chose that risk level.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/oasdiff-err-ignore.txt:
- Around line 526-530: Relocate the two Authorization-header entries for the
endpoints GET /v2/bookings/{bookingUid}/recordings and GET
/v2/bookings/{bookingUid}/transcripts from the “Potentially Breaking” list into
the “Verified Safe” (or equivalent) section in the oasdiff ignore listing;
update the classification text to note these reflect already-enforced auth
behavior rather than a new runtime change so they won’t dilute the high-risk
triage signal.
- Around line 542-545: Two API change entries are left in the "Uncategorized"
section; assign each one to an explicit risk bucket and add a short rationale.
Move the lines for "GET
/v2/organizations/{orgId}/teams/{teamId}/conferencing/{app}/oauth/auth-url" and
"GET /v2/organizations/{orgId}/teams/{teamId}/stripe/connect" out of
Uncategorized into either the "Safe" or "Needs review" section, and append a
one-sentence rationale explaining the impact of the orgId path parameter type
change (string -> number) and why you chose that risk level.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 41899e53-b324-4f7e-bfbb-fd537e2ccdd1

📥 Commits

Reviewing files that changed from the base of the PR and between f3e07c5 and 8762b28.

📒 Files selected for processing (1)

.github/oasdiff-err-ignore.txt

CodeBySayak · 2026-04-08T19:59:56Z

Hi! All changes are ready and checks should pass.
Could you please add the run-ci label to trigger CI? Thanks!

github-actions · 2026-04-16T00:45:08Z

This PR has been marked as stale due to inactivity. If you're still working on it or need any help, please let us know or update the PR to keep it active.

fixed oasdif

8762b28

pull-request-size Bot added the size/XL label Apr 8, 2026

CodeBySayak changed the title ~~fixed oasdif~~ Improve transparency by restructuring oasdiff ignore list into triaged categories Apr 8, 2026

coderabbitai Bot reviewed Apr 8, 2026

View reviewed changes

CodeBySayak changed the title ~~Improve transparency by restructuring oasdiff ignore list into triaged categories~~ refactor: restructure oasdiff ignore file for transparency and auditability Apr 8, 2026

github-actions Bot added the Stale label Apr 16, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: restructure oasdiff ignore file for transparency and auditability#28798

refactor: restructure oasdiff ignore file for transparency and auditability#28798
CodeBySayak wants to merge 1 commit intocalcom:mainfrom
CodeBySayak:fix-oasdif

CodeBySayak commented Apr 8, 2026

Uh oh!

CLAassistant commented Apr 8, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 8, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 8, 2026

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Uh oh!

CodeBySayak commented Apr 8, 2026

Uh oh!

github-actions Bot commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

CodeBySayak commented Apr 8, 2026

Summary

Problem

Solution

1. Verified Safe Changes / Intentional Refactors

2. Potentially Breaking / Needs Review

3. Contextual Annotations

Impact

Additional Context

Follow-up / Roadmap

Mandatory Tasks (DO NOT REMOVE)

Uh oh!

CLAassistant commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Apr 8, 2026

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

CodeBySayak commented Apr 8, 2026

Uh oh!

github-actions Bot commented Apr 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

CLAassistant commented Apr 8, 2026 •

edited

Loading

github-actions Bot commented Apr 8, 2026 •

edited

Loading