improved schema preprocessor and Date object handling (validation/serialization) for response bodies
#499
Conversation
This file contains hidden or 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
We can cast data from request to object or transform object to string (or other type) in response. Documentation modified and an example project created
…ion. We must add an unique ID field in schema description in order to have a specific schema description for each component + Test added coercecomponents.spec.ts + example modified in order to expose a date
- Fix function names serialize and deserialize => To be clear for everybody on which functions are executed on requests and responses, it's now `deserializeRequestComponent` and `serializeResponseComponent`
|
@cdimascio I didn't validate the code itself, but I did validate this branch in my project and it works #1, without any modification required on my side. Fantastic work!! |
|
This is the magical line, isn't it?
:-) |
cdimascio
changed the title
Date object handling (validation/serialization) for response bodies
cdimascio
added a commit
that referenced
this pull request
Mar 2, 2025
…erialization) for response bodies (#499) * CoerceComponents feature as expected in #353 We can cast data from request to object or transform object to string (or other type) in response. Documentation modified and an example project created * Issue on Typescript Options inheritance * Patch AJV cache integration issue. AJV has a cache by schema description. We must add an unique ID field in schema description in order to have a specific schema description for each component + Test added coercecomponents.spec.ts + example modified in order to expose a date * Change Test name to "coercecomponents". I missed to change from the example * - Changes `coerceComponents` to `schemaObjectMapper` - Fix function names serialize and deserialize => To be clear for everybody on which functions are executed on requests and responses, it's now `deserializeRequestComponent` and `serializeResponseComponent` * Move example resources `7-coerce-components` to `7-schema-object-mapper` * update naming and type declarations * doc: update documentation * traverse spec * update preprocessor * travserse via Node abstraction * traverse and update both schemas * finish one pass traversal to modified req and res schemas independently * doc: remove schemaObjectMapper from readme * doc: remove schemaObjectMapper from README * fix: update method name * cleanup * rename preprocessor * rename var * sample built-in date-time formatter * fix: types * feat: provide opt-in option responseValidation serialization * feat: handle date and date-time * doc: update README * fix: add example - Date serialization in responses * doc: update README * feat: add date serialization example * doc: update README * chore: remove commented code * feat: handle Date or date string automatically * add format metadata to Serializer Co-authored-by: Pierre Le Roux <[email protected]>
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.
see #493 for a detailed discussion on this topic
ObjectId. it does pave the way for a custom serializer for MongoDbObjectId