Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

invalid serDes syntax in README.md #569

Open
code-surfer opened this issue Mar 25, 2021 · 0 comments
Open

invalid serDes syntax in README.md #569

code-surfer opened this issue Mar 25, 2021 · 0 comments

Comments

@code-surfer
Copy link

The syntax of serDes in the README.md looks invalid.

serDes: [{
    OpenApiValidator.serdes.dateTime,
    OpenApiValidator.serdes.date,
    {
      format: 'mongo-objectid',
      deserialize: (s) => new ObjectID(s),
      serialize: (o) => o.toString(),
    },
  }],

The keys are missing in the object.
In the code (dist/framework/base.serdes.js) it actually is

exports.defaultSerDes = [
    exports.date.serializer,
    exports.dateTime.serializer
];

I guess in the README.md, the serDes: [{ ... }] should be changed to serDes: [ ... ].

pilerou added a commit to pilerou/express-openapi-validator that referenced this issue Dec 20, 2021
cdimascio pushed a commit that referenced this issue Dec 21, 2021
* Try catch serdes serialize and deserialize in order to avoid Internal Server Error and return BadRequest errors #601

* Fix incorrect serDes example #569
cdimascio added a commit that referenced this issue Dec 26, 2021
…age (#684)

* Try catch serdes serialize and deserialize in order to avoid Internal Server Error and return BadRequest errors #601

* Fix incorrect serDes example #569

* fix the unit test and change message to a more human friendly description of the error #601

* Allow to get the generated request AJV object in order to use it out of an OpenAPI and express usage (websocket...)
#683

* Add documentation for OpenApiValidator.ajv function initialization usage
#683

* ResponseValidator's Ajv can be useful too.
So we return an object that contains both request ajv and response ajv :
```javascript
ajvs = {
  req : 'Ajv object'
  res : 'Ajv object'
}
```
#683

* fix the unit test and change message to a more human friendly description of the error #601

* Allow to get the generated request AJV object in order to use it out of an OpenAPI and express usage (websocket...)
#683

* Add documentation for OpenApiValidator.ajv function initialization usage
#683

* ResponseValidator's Ajv can be useful too.
So we return an object that contains both request ajv and response ajv :
```javascript
ajvs = {
  req : 'Ajv object'
  res : 'Ajv object'
}
```
#683

* Revert commits in order to push only bug fixes
#601

* Revert "ResponseValidator's Ajv can be useful too."

This reverts commit 677cacf.

* Revert "Add documentation for OpenApiValidator.ajv function initialization usage"

This reverts commit a727f2d.

* Revert "Allow to get the generated request AJV object in order to use it out of an OpenAPI and express usage (websocket...)"

This reverts commit ad3e785.

* Revert "ResponseValidator's Ajv can be useful too. So we return an object that contains both request ajv and response ajv : ```javascript ajvs = {   req : 'Ajv object'   res : 'Ajv object' } ``` #683"

This reverts commit 8fc7226

* Revert "Add documentation for OpenApiValidator.ajv function initialization usage"

This reverts commit ecb8424.

* Revert "Allow to get the generated request AJV object in order to use it out of an OpenAPI and express usage (websocket...)"

This reverts commit 52429c5.

Co-authored-by: Carmine DiMascio <cdimasci@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant