feat: Implement JSON Schema Validation for User API Responses #17731
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Problem Solved: The Cal.com API v2 was exhibiting inconsistent behavior with response bodies changing unpredictably. This inconsistency was causing errors in applications relying on the API, leading to disruptions in functionality and user experience. The issue stemmed from a lack of a fixed and documented schema for API responses. Solution Implemented: Defined a JSON schema to establish a consistent structure for user-related API responses. Integrated the Ajv library into the UsersService to validate responses against the schema. Added validation logic in the getByUsernames method to ensure each user response adheres to the schema, throwing an error if it does not. Trade-offs or Limitations: The current implementation focuses on user-related responses. Extending schema validation to other modules may be necessary for comprehensive consistency. Future changes to the API response structure will require updates to the schema and potentially the validation logic. A versioning strategy and deprecation policy should be considered to manage future changes and maintain backward compatibility.
|
@AmpasTheodoros is attempting to deploy a commit to the cal Team on Vercel. A member of the Team first needs to authorize it. |
|
|
|
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: |
Graphite Automations"Add consumer team as reviewer" took an action on this PR • (11/19/24)1 reviewer was added to this PR based on Keith Williams's automation. "Add community label" took an action on this PR • (11/19/24)1 label was added to this PR based on Keith Williams's automation. "Add ready-for-e2e label" took an action on this PR • (11/21/24)1 label was added to this PR based on Keith Williams's automation. |
|
Hey @AmpasTheodoros please sign CLA |
Praashh
changed the title
Praashh
reviewed
Nov 19, 2024
|
Hey @Praashh thanks for fixing my title I just signed CLA |
E2E results are ready! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem Solved: The Cal.com API v2 was exhibiting inconsistent behavior with response bodies changing unpredictably. This inconsistency was causing errors in applications relying on the API, leading to disruptions in functionality and user experience. The issue stemmed from a lack of a fixed and documented schema for API responses
Solution Implemented:
Trade-offs or Limitations: