Skip to content

[CLEAN] Synthetic Benchmark PR #26951 - fix(api): add @ApiExtraModels for location types in OpenAPI spec#563

Open
ofir-frd wants to merge 1 commit intobase_pr_26951_20260120_4139from
clean_pr_26951_20260120_4139
Open

[CLEAN] Synthetic Benchmark PR #26951 - fix(api): add @ApiExtraModels for location types in OpenAPI spec#563
ofir-frd wants to merge 1 commit intobase_pr_26951_20260120_4139from
clean_pr_26951_20260120_4139

Conversation

@ofir-frd
Copy link

Benchmark PR calcom#26951

Type: Clean (correct implementation)

Original PR Title: fix(api): add @ApiExtraModels for location types in OpenAPI spec
Original PR Description: ## What does this PR do?

Fixes a pre-existing bug where location type schemas were referenced in the OpenAPI spec but their definitions were missing. This was causing the "Check API v2 breaking changes" CI check to fail with:

Error: failed to load base spec: map key "UpdateInputAddressLocation_2024_08_13" not found

The UpdateBookingLocationInput_2024_08_13 class uses getSchemaPath() to reference location types in its @ApiPropertyOptional decorator, but NestJS Swagger requires classes used with getSchemaPath() to be registered with @ApiExtraModels() for them to be included in the generated OpenAPI spec.

Changes:

  • Added @ApiExtraModels decorator to BookingLocationController_2024_08_13 to register all location types
  • Regenerated openapi.json which now includes the missing schema definitions

Mandatory Tasks (DO NOT REMOVE)

  • I have self-reviewed the code (A decent size PR without self-review might be rejected).
  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. N/A - this is an auto-generated OpenAPI spec fix.
  • I confirm automated tests are in place that prove my fix is effective or that my feature works. N/A - the "Check API v2 breaking changes" CI check will verify this fix.

How should this be tested?

  1. The "Check API v2 breaking changes" CI check should now pass
  2. Verify that docs/api-reference/v2/openapi.json contains schema definitions for:
    • UpdateInputAddressLocation_2024_08_13
    • UpdateBookingInputAttendeeAddressLocation_2024_08_13
    • UpdateBookingInputAttendeeDefinedLocation_2024_08_13
    • UpdateBookingInputAttendeePhoneLocation_2024_08_13
    • UpdateBookingInputLinkLocation_2024_08_13
    • UpdateBookingInputPhoneLocation_2024_08_13

Checklist

  • My code follows the style guidelines of this project
  • I have checked if my changes generate no new warnings

Reviewer Note: The large diff in openapi.json is mostly formatting changes from regeneration (moving example inside schema objects). The meaningful changes are the ~108 lines of new schema definitions added around line 33818.

Original PR URL: calcom#26951

@github-actions
Copy link

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 "[CLEAN] Synthetic Benchmark PR #26951 - fix(api): add @ApiExtraModels for location types in OpenAPI spec". 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

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

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.

@github-actions github-actions bot added the Stale label Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant