@rapidrest/service-core 1.0.0-beta.2 → 1.0.0-beta.4

package/docs/reference/classes/OpenApiSpec.md

@@ -6,7 +6,7 @@
 
 # Class: OpenApiSpec
 
-Defined in: [src/OpenApiSpec.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L19)
+Defined in: [src/OpenApiSpec.ts:19](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L19)
 
 `OpenApiSpec` is a container for an OpenAPI specification.
 
@@ -23,7 +23,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new OpenApiSpec**(`spec?`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L25)
+Defined in: [src/OpenApiSpec.ts:25](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L25)
 
 #### Parameters
 
@@ -43,7 +43,7 @@ Defined in: [src/OpenApiSpec.ts:25](https://github.com/rapidrest/service-core/bl
 
 > **get** **builder**(): `OpenApiBuilder`
 
-Defined in: [src/OpenApiSpec.ts:29](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L29)
+Defined in: [src/OpenApiSpec.ts:29](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L29)
 
 ##### Returns
 
@@ -53,7 +53,7 @@ Defined in: [src/OpenApiSpec.ts:29](https://github.com/rapidrest/service-core/bl
 
 > **set** **builder**(`value`): `void`
 
-Defined in: [src/OpenApiSpec.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L33)
+Defined in: [src/OpenApiSpec.ts:33](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L33)
 
 ##### Parameters
 
@@ -73,7 +73,7 @@ Defined in: [src/OpenApiSpec.ts:33](https://github.com/rapidrest/service-core/bl
 
 > **get** **components**(): `ComponentsObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:53](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L53)
+Defined in: [src/OpenApiSpec.ts:53](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L53)
 
 ##### Returns
 
@@ -87,7 +87,7 @@ Defined in: [src/OpenApiSpec.ts:53](https://github.com/rapidrest/service-core/bl
 
 > **get** **externalDocs**(): `ExternalDocumentationObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:65](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L65)
+Defined in: [src/OpenApiSpec.ts:65](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L65)
 
 ##### Returns
 
@@ -101,7 +101,7 @@ Defined in: [src/OpenApiSpec.ts:65](https://github.com/rapidrest/service-core/bl
 
 > **get** **info**(): `InfoObject`
 
-Defined in: [src/OpenApiSpec.ts:41](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L41)
+Defined in: [src/OpenApiSpec.ts:41](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L41)
 
 ##### Returns
 
@@ -115,7 +115,7 @@ Defined in: [src/OpenApiSpec.ts:41](https://github.com/rapidrest/service-core/bl
 
 > **get** **openapi**(): `string`
 
-Defined in: [src/OpenApiSpec.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L37)
+Defined in: [src/OpenApiSpec.ts:37](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L37)
 
 ##### Returns
 
@@ -129,7 +129,7 @@ Defined in: [src/OpenApiSpec.ts:37](https://github.com/rapidrest/service-core/bl
 
 > **get** **paths**(): `PathsObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:49](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L49)
+Defined in: [src/OpenApiSpec.ts:49](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L49)
 
 ##### Returns
 
@@ -143,7 +143,7 @@ Defined in: [src/OpenApiSpec.ts:49](https://github.com/rapidrest/service-core/bl
 
 > **get** **security**(): `SecurityRequirementObject`[] \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L57)
+Defined in: [src/OpenApiSpec.ts:57](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L57)
 
 ##### Returns
 
@@ -157,7 +157,7 @@ Defined in: [src/OpenApiSpec.ts:57](https://github.com/rapidrest/service-core/bl
 
 > **get** **servers**(): `ServerObject`[] \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L45)
+Defined in: [src/OpenApiSpec.ts:45](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L45)
 
 ##### Returns
 
@@ -171,7 +171,7 @@ Defined in: [src/OpenApiSpec.ts:45](https://github.com/rapidrest/service-core/bl
 
 > **get** **tags**(): `TagObject`[] \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:61](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L61)
+Defined in: [src/OpenApiSpec.ts:61](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L61)
 
 ##### Returns
 
@@ -185,7 +185,7 @@ Defined in: [src/OpenApiSpec.ts:61](https://github.com/rapidrest/service-core/bl
 
 > **get** **webhooks**(): `PathsObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L69)
+Defined in: [src/OpenApiSpec.ts:69](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L69)
 
 ##### Returns
 
@@ -197,7 +197,7 @@ Defined in: [src/OpenApiSpec.ts:69](https://github.com/rapidrest/service-core/bl
 
 > **addCallback**(`name`, `callback`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:264](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L264)
+Defined in: [src/OpenApiSpec.ts:264](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L264)
 
 #### Parameters
 
@@ -219,7 +219,7 @@ Defined in: [src/OpenApiSpec.ts:264](https://github.com/rapidrest/service-core/b
 
 > **addContact**(`contact`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:189](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L189)
+Defined in: [src/OpenApiSpec.ts:189](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L189)
 
 #### Parameters
 
@@ -237,7 +237,7 @@ Defined in: [src/OpenApiSpec.ts:189](https://github.com/rapidrest/service-core/b
 
 > **addDescription**(`description`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:204](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L204)
+Defined in: [src/OpenApiSpec.ts:204](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L204)
 
 #### Parameters
 
@@ -255,7 +255,7 @@ Defined in: [src/OpenApiSpec.ts:204](https://github.com/rapidrest/service-core/b
 
 > **addExample**(`name`, `example`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:239](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L239)
+Defined in: [src/OpenApiSpec.ts:239](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L239)
 
 #### Parameters
 
@@ -277,7 +277,7 @@ Defined in: [src/OpenApiSpec.ts:239](https://github.com/rapidrest/service-core/b
 
 > **addExternalDocs**(`extDoc`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:279](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L279)
+Defined in: [src/OpenApiSpec.ts:279](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L279)
 
 #### Parameters
 
@@ -295,7 +295,7 @@ Defined in: [src/OpenApiSpec.ts:279](https://github.com/rapidrest/service-core/b
 
 > **addHeader**(`name`, `header`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:249](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L249)
+Defined in: [src/OpenApiSpec.ts:249](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L249)
 
 #### Parameters
 
@@ -317,7 +317,7 @@ Defined in: [src/OpenApiSpec.ts:249](https://github.com/rapidrest/service-core/b
 
 > **addInfo**(`info`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:184](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L184)
+Defined in: [src/OpenApiSpec.ts:184](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L184)
 
 #### Parameters
 
@@ -335,7 +335,7 @@ Defined in: [src/OpenApiSpec.ts:184](https://github.com/rapidrest/service-core/b
 
 > **addLicense**(`license`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:194](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L194)
+Defined in: [src/OpenApiSpec.ts:194](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L194)
 
 #### Parameters
 
@@ -353,7 +353,7 @@ Defined in: [src/OpenApiSpec.ts:194](https://github.com/rapidrest/service-core/b
 
 > **addLink**(`name`, `link`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:259](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L259)
+Defined in: [src/OpenApiSpec.ts:259](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L259)
 
 #### Parameters
 
@@ -375,7 +375,7 @@ Defined in: [src/OpenApiSpec.ts:259](https://github.com/rapidrest/service-core/b
 
 > **addModel**(`name`, `clazz`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:295](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L295)
+Defined in: [src/OpenApiSpec.ts:295](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L295)
 
 Adds a RapidREST model class to the OpenAPI specification as a schema.
 
@@ -403,7 +403,7 @@ The class prototype to build the schema from.
 
 > **addOpenApiVersion**(`openApiVersion`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:179](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L179)
+Defined in: [src/OpenApiSpec.ts:179](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L179)
 
 #### Parameters
 
@@ -421,7 +421,7 @@ Defined in: [src/OpenApiSpec.ts:179](https://github.com/rapidrest/service-core/b
 
 > **addParameter**(`name`, `parameter`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:234](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L234)
+Defined in: [src/OpenApiSpec.ts:234](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L234)
 
 #### Parameters
 
@@ -443,7 +443,7 @@ Defined in: [src/OpenApiSpec.ts:234](https://github.com/rapidrest/service-core/b
 
 > **addPath**(`path`, `pathItem`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:219](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L219)
+Defined in: [src/OpenApiSpec.ts:219](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L219)
 
 #### Parameters
 
@@ -465,7 +465,7 @@ Defined in: [src/OpenApiSpec.ts:219](https://github.com/rapidrest/service-core/b
 
 > **addRequestBody**(`name`, `reqBody`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:244](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L244)
+Defined in: [src/OpenApiSpec.ts:244](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L244)
 
 #### Parameters
 
@@ -487,7 +487,7 @@ Defined in: [src/OpenApiSpec.ts:244](https://github.com/rapidrest/service-core/b
 
 > **addResponse**(`name`, `response`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:229](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L229)
+Defined in: [src/OpenApiSpec.ts:229](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L229)
 
 #### Parameters
 
@@ -509,7 +509,7 @@ Defined in: [src/OpenApiSpec.ts:229](https://github.com/rapidrest/service-core/b
 
 > **addRoute**(`name`, `path`, `method`, `metadata`, `docs`, `routeClass`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:311](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L311)
+Defined in: [src/OpenApiSpec.ts:311](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L311)
 
 Adds a RapidREST route handler to the OpenAPI specification.
 
@@ -561,7 +561,7 @@ The parent route class that the route handler belongs to.
 
 > **addSchema**(`name`, `schema`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:224](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L224)
+Defined in: [src/OpenApiSpec.ts:224](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L224)
 
 #### Parameters
 
@@ -583,7 +583,7 @@ Defined in: [src/OpenApiSpec.ts:224](https://github.com/rapidrest/service-core/b
 
 > **addSecurityScheme**(`name`, `secScheme`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:254](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L254)
+Defined in: [src/OpenApiSpec.ts:254](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L254)
 
 #### Parameters
 
@@ -605,7 +605,7 @@ Defined in: [src/OpenApiSpec.ts:254](https://github.com/rapidrest/service-core/b
 
 > **addServer**(`server`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:269](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L269)
+Defined in: [src/OpenApiSpec.ts:269](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L269)
 
 #### Parameters
 
@@ -623,7 +623,7 @@ Defined in: [src/OpenApiSpec.ts:269](https://github.com/rapidrest/service-core/b
 
 > **addTag**(`tag`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:274](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L274)
+Defined in: [src/OpenApiSpec.ts:274](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L274)
 
 #### Parameters
 
@@ -641,7 +641,7 @@ Defined in: [src/OpenApiSpec.ts:274](https://github.com/rapidrest/service-core/b
 
 > **addTermsOfService**(`termsOfService`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:209](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L209)
+Defined in: [src/OpenApiSpec.ts:209](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L209)
 
 #### Parameters
 
@@ -659,7 +659,7 @@ Defined in: [src/OpenApiSpec.ts:209](https://github.com/rapidrest/service-core/b
 
 > **addTitle**(`title`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:199](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L199)
+Defined in: [src/OpenApiSpec.ts:199](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L199)
 
 #### Parameters
 
@@ -677,7 +677,7 @@ Defined in: [src/OpenApiSpec.ts:199](https://github.com/rapidrest/service-core/b
 
 > **addVersion**(`version`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:214](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L214)
+Defined in: [src/OpenApiSpec.ts:214](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L214)
 
 #### Parameters
 
@@ -695,7 +695,7 @@ Defined in: [src/OpenApiSpec.ts:214](https://github.com/rapidrest/service-core/b
 
 > **addWebhook**(`webhook`, `webhookItem`): `OpenApiSpec`
 
-Defined in: [src/OpenApiSpec.ts:284](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L284)
+Defined in: [src/OpenApiSpec.ts:284](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L284)
 
 #### Parameters
 
@@ -717,7 +717,7 @@ Defined in: [src/OpenApiSpec.ts:284](https://github.com/rapidrest/service-core/b
 
 > **createSchemaClass**(`clazz`): `SchemaObject`
 
-Defined in: [src/OpenApiSpec.ts:590](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L590)
+Defined in: [src/OpenApiSpec.ts:590](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L590)
 
 Creates a new SchemaObject given the specified class prototype.
 
@@ -741,7 +741,7 @@ The schema object with all information derived from the given class prototype.
 
 > **createSchemaObject**(`typeInfo`, `defaultValue?`, `description?`, `example?`, `format?`, `identifier?`): `SchemaObject` \| `ReferenceObject`
 
-Defined in: [src/OpenApiSpec.ts:685](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L685)
+Defined in: [src/OpenApiSpec.ts:685](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L685)
 
 Creates a schema object for the given type.
 
@@ -781,7 +781,7 @@ Creates a schema object for the given type.
 
 > **getParameterReference**(`name`): `ReferenceObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:781](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L781)
+Defined in: [src/OpenApiSpec.ts:781](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L781)
 
 Returns a reference to an existing parameter defined in the OpenAPI specification for the given name.
 
@@ -805,7 +805,7 @@ The reference to the parameter with the given name, otherwise `undefined`.
 
 > **getSchemaReference**(`name`): `ReferenceObject` \| `undefined`
 
-Defined in: [src/OpenApiSpec.ts:797](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L797)
+Defined in: [src/OpenApiSpec.ts:797](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L797)
 
 Returns a reference to an existing schema defined in the OpenAPI specification for the given name.
 
@@ -829,7 +829,7 @@ The reference to the schema with the given name, otherwise `undefined`.
 
 > **getSpec**(): `OpenAPIObject`
 
-Defined in: [src/OpenApiSpec.ts:167](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L167)
+Defined in: [src/OpenApiSpec.ts:167](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L167)
 
 #### Returns
 
@@ -841,7 +841,7 @@ Defined in: [src/OpenApiSpec.ts:167](https://github.com/rapidrest/service-core/b
 
 > **getSpecAsJson**(`replacer?`, `space?`): `string`
 
-Defined in: [src/OpenApiSpec.ts:171](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L171)
+Defined in: [src/OpenApiSpec.ts:171](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L171)
 
 #### Parameters
 
@@ -863,7 +863,7 @@ Defined in: [src/OpenApiSpec.ts:171](https://github.com/rapidrest/service-core/b
 
 > **getSpecAsYaml**(): `string`
 
-Defined in: [src/OpenApiSpec.ts:175](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L175)
+Defined in: [src/OpenApiSpec.ts:175](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L175)
 
 #### Returns
 
@@ -875,7 +875,7 @@ Defined in: [src/OpenApiSpec.ts:175](https://github.com/rapidrest/service-core/b
 
 > **merge**(`other`): `void`
 
-Defined in: [src/OpenApiSpec.ts:811](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L811)
+Defined in: [src/OpenApiSpec.ts:811](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/OpenApiSpec.ts#L811)
 
 Merges a provided OpenAPI specification with this specification.
 

package/docs/reference/classes/RecoverableBaseEntity.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: RecoverableBaseEntity
 
-Defined in: [src/models/RecoverableBaseEntity.ts:15](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseEntity.ts#L15)
+Defined in: [src/models/RecoverableBaseEntity.ts:15](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseEntity.ts#L15)
 
 The `RecoverableBaseEntity` provides an entity base class for those classes wishing to implement
 soft delete capability. A soft delete means that a delete operation does not remove the entity
@@ -31,7 +31,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new RecoverableBaseEntity**(`other?`): `RecoverableBaseEntity`
 
-Defined in: [src/models/RecoverableBaseEntity.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseEntity.ts#L22)
+Defined in: [src/models/RecoverableBaseEntity.ts:22](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseEntity.ts#L22)
 
 #### Parameters
 
@@ -53,7 +53,7 @@ Defined in: [src/models/RecoverableBaseEntity.ts:22](https://github.com/rapidres
 
 > **dateCreated**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L35)
 
 The date and time that the entity was created.
 
@@ -67,7 +67,7 @@ The date and time that the entity was created.
 
 > **dateModified**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L43)
 
 The date and time that the entity was last modified.
 
@@ -81,7 +81,7 @@ The date and time that the entity was last modified.
 
 > **deleted**: `boolean` = `false`
 
-Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseEntity.ts#L20)
+Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseEntity.ts#L20)
 
 Indicates if the document has been soft deleted.
 
@@ -91,7 +91,7 @@ Indicates if the document has been soft deleted.
 
 > **uid**: `string`
 
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L27)
 
 The universally unique identifier of the entity.
 
@@ -105,7 +105,7 @@ The universally unique identifier of the entity.
 
 > **version**: `number` = `0`
 
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L50)
 
 The optimistic lock version.
 

package/docs/reference/classes/RecoverableBaseMongoEntity.md

@@ -6,7 +6,7 @@
 
 # Abstract Class: RecoverableBaseMongoEntity
 
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:16](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseMongoEntity.ts#L16)
+Defined in: [src/models/RecoverableBaseMongoEntity.ts:16](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseMongoEntity.ts#L16)
 
 The `RecoverableBaseMongoEntity` provides an entity base class for those classes wishing to implement
 soft delete capability. A soft delete means that a delete operation does not remove the entity
@@ -27,7 +27,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > **new RecoverableBaseMongoEntity**(`other?`): `RecoverableBaseMongoEntity`
 
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseMongoEntity.ts#L23)
+Defined in: [src/models/RecoverableBaseMongoEntity.ts:23](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseMongoEntity.ts#L23)
 
 #### Parameters
 
@@ -49,7 +49,7 @@ Defined in: [src/models/RecoverableBaseMongoEntity.ts:23](https://github.com/rap
 
 > `optional` **\_id?**: `any`
 
-Defined in: [src/models/RecoverableBaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseMongoEntity.ts#L21)
+Defined in: [src/models/RecoverableBaseMongoEntity.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseMongoEntity.ts#L21)
 
 The internal unique identifier used by MongoDB.
 
@@ -59,7 +59,7 @@ The internal unique identifier used by MongoDB.
 
 > **dateCreated**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L35)
+Defined in: [src/models/BaseEntity.ts:35](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L35)
 
 The date and time that the entity was created.
 
@@ -73,7 +73,7 @@ The date and time that the entity was created.
 
 > **dateModified**: `Date`
 
-Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L43)
+Defined in: [src/models/BaseEntity.ts:43](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L43)
 
 The date and time that the entity was last modified.
 
@@ -87,7 +87,7 @@ The date and time that the entity was last modified.
 
 > **deleted**: `boolean` = `false`
 
-Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/RecoverableBaseEntity.ts#L20)
+Defined in: [src/models/RecoverableBaseEntity.ts:20](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/RecoverableBaseEntity.ts#L20)
 
 Indicates if the document has been soft deleted.
 
@@ -101,7 +101,7 @@ Indicates if the document has been soft deleted.
 
 > **uid**: `string`
 
-Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L27)
+Defined in: [src/models/BaseEntity.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L27)
 
 The universally unique identifier of the entity.
 
@@ -115,7 +115,7 @@ The universally unique identifier of the entity.
 
 > **version**: `number` = `0`
 
-Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/models/BaseEntity.ts#L50)
+Defined in: [src/models/BaseEntity.ts:50](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/models/BaseEntity.ts#L50)
 
 The optimistic lock version.
 

package/docs/reference/classes/RedisTransport.md

@@ -6,7 +6,7 @@
 
 # Class: RedisTransport
 
-Defined in: [src/routes/AdminRoute.ts:17](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L17)
+Defined in: [src/routes/AdminRoute.ts:17](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L17)
 
 Implements a Winston transport that pipes incoming log messages to a configured redis pubsub channel.
 
@@ -20,7 +20,7 @@ Implements a Winston transport that pipes incoming log messages to a configured
 
 > **new RedisTransport**(`opts`): `RedisTransport`
 
-Defined in: [src/routes/AdminRoute.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L21)
+Defined in: [src/routes/AdminRoute.ts:21](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L21)
 
 #### Parameters
 
@@ -595,7 +595,7 @@ Defined in: node\_modules/@types/node/stream.d.ts:1020
 
 > **close**(): `void`
 
-Defined in: [src/routes/AdminRoute.ts:27](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L27)
+Defined in: [src/routes/AdminRoute.ts:27](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L27)
 
 #### Returns
 
@@ -1110,7 +1110,7 @@ Defined in: node\_modules/@types/node/stream.d.ts:1029
 
 > **log**(`info`, `next`): `any`
 
-Defined in: [src/routes/AdminRoute.ts:31](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/AdminRoute.ts#L31)
+Defined in: [src/routes/AdminRoute.ts:31](https://github.com/rapidrest/service-core/blob/ab54834688bebfbea1d8258c626822205861b919/src/routes/AdminRoute.ts#L31)
 
 #### Parameters