@digitalroute/bagger - npm Package Compare versions

Comparing version 2.4.6 to 2.4.7

package.json

 {
   "name": "@digitalroute/bagger",
-  "version": "2.4.6",
+  "version": "2.4.7",
   "description": "🎒 A joi-compatible tool for building swagger definitions",
@@ -5,0 +5,0 @@ "main": "dist/bagger.umd.js",

README.md

@@ -15,2 +15,3 @@ # 🎒 Bagger
 - 🔎 **Intellisense:** Really nice intellisense suggestions, and TypeScript definitions.
+- 🔒 **Type safety:** Bagger always produces 100% valid Swagger documents. If you use TypeScript the compiler will enforce correctness in most cases, and otherwise Bagger will validate during compilation.
 
@@ -56,22 +57,10 @@ ## Example
   - [Working with multiple files](/docs/01-introduction.md#working-with-multiple-files)
-- [Adding requests](/docs/02-requests.md) 🚧 Under construction 🚧
-- [Creating resources](/docs/03-resources.md) 🚧 Under construction 🚧
-  - Response
-  - Content
-  - Request body
-- [Validating with joi](/docs/04-validation.md) 🚧 Under construction 🚧
-  - Adding parameters
-  - TODO: Adding body validation?
-  - Getting validation schemas
-- [Components](/docs/05-components.md) 🚧 Under construction 🚧
-  - Declaring components
-  - Referancing components
-- [API Reference](/docs/06-api_reference.md) 🚧 Under construction 🚧
-  - `bagger.configure()`
-  - `bagger.compile()`
-  - `bagger.addRequest(path, method)`
-  - `bagger.addComponent()`
-  - `bagger.response(httpCode)`
-  - `bagger.requestBody()`
-  - `bagger.parameter()`
-  - `bagger.getRequestSchema()`
+- [API Reference](/docs/02-api_reference.md)
+  - [`bagger.configure()`](/docs/02-api_reference.md#baggerconfigure)
+  - [`bagger.compile()`](/docs/02-api_reference.md#baggercompile)
+  - [`bagger.addRequest(path, method)`](/docs/02-api_reference.md#baggeraddrequestpath-method)
+  - [`bagger.addComponent()`](/docs/02-api_reference.md#baggeraddcomponent)
+  - [`bagger.response(httpCode)`](/docs/02-api_reference.md#baggerresponsehttpcode)
+  - [`bagger.requestBody()`](/docs/02-api_reference.md#baggerrequestbody)
+  - [`bagger.parameter().<type>(name)`](/docs/02-api_reference.md#baggerparametertypename)
+  - [`bagger.getRequestSchema()`](/docs/02-api_reference.md#baggergetrequestschema)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

265468

increased by0.04%

Worsened metrics

Number of lines in readme file

65

decreased by-14.47%

No dependency changes