Skip to content

1.0 Release

Compare
Choose a tag to compare
@blugavere blugavere released this 01 Dec 18:18
· 62 commits to master since this release
  • Added deep object & nested scalar / schema support.

This is technically a breaking change from 0.x versions since previously:

new Schema({
  foo: { bar: String },
})

would result in a swagger output of "foo.bar": { type: "string" } which is valid swagger, but technically incorrect. Now it will result in { foo: { properties: { bar: { type: "string" } } } } which is both valid swagger and has the desired output.

  • Added arbitrary meta field support - common ask was to add arbitrary props like "description" to mongoose schemas and have information propagate out through swagger schema.

  • Added better support for "required" fields.