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

package/docs/reference/classes/NetUtils.md

@@ -6,7 +6,7 @@
 
 # Class: NetUtils
 
-Defined in: [src/NetUtils.ts:12](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NetUtils.ts#L12)
+Defined in: [src/NetUtils.ts:12](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L12)
 
 Provides common utilities and functions for working with networking related problems.
 
@@ -30,7 +30,7 @@ Jean-Philippe Steinmetz <rapidrests@gmail.com>
 
 > `static` **getIPAddress**(`urlOrRequest`, `trustedProxies?`): `string` \| `undefined`
 
-Defined in: [src/NetUtils.ts:57](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NetUtils.ts#L57)
+Defined in: [src/NetUtils.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L57)
 
 Extracts the IP address from a given url or HTTP request.
 
@@ -43,7 +43,7 @@ preventing clients from spoofing their IP in audit logs.
 
 ##### urlOrRequest
 
-`string` \| `HttpRequest`
+`string` \| [`HttpRequest`](../interfaces/HttpRequest.md)
 
 The url or HTTP request to extract the IP from.
 
@@ -65,7 +65,7 @@ A `string` containing the IP address if found, otherwise `undefined`.
 
 > `static` **lookupIPAddress**(`url`, `family?`): `Promise`\<`string` \| `undefined`\>
 
-Defined in: [src/NetUtils.ts:20](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NetUtils.ts#L20)
+Defined in: [src/NetUtils.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NetUtils.ts#L20)
 
 Performs DNS lookup of the IP address from a given url.
 

package/docs/reference/classes/NotificationUtils.md

@@ -6,7 +6,7 @@
 
 # Class: NotificationUtils
 
-Defined in: [src/NotificationUtils.ts:11](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NotificationUtils.ts#L11)
+Defined in: [src/NotificationUtils.ts:11](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L11)
 
 Utility functions for sending push notifications to registered clients.
 
@@ -20,7 +20,7 @@ Jean-Philippe Steinmetz
 
 > **new NotificationUtils**(`redis`): `NotificationUtils`
 
-Defined in: [src/NotificationUtils.ts:20](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NotificationUtils.ts#L20)
+Defined in: [src/NotificationUtils.ts:20](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L20)
 
 Initializes the utility using the given redis connection.
 
@@ -42,7 +42,7 @@ The redis connection to publish to.
 
 > **sendMessage**(`uids`, `type`, `action`, `data`): `void`
 
-Defined in: [src/NotificationUtils.ts:32](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/NotificationUtils.ts#L32)
+Defined in: [src/NotificationUtils.ts:32](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/NotificationUtils.ts#L32)
 
 Sends a given message to the room or user with the specified uid(s).
 

package/docs/reference/classes/ObjectFactory.md

@@ -6,7 +6,7 @@
 
 # Class: ObjectFactory
 
-Defined in: [src/ObjectFactory.ts:21](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L21)
+Defined in: [src/ObjectFactory.ts:21](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L21)
 
 The `ObjectFactory` is a manager for creating objects based on registered
 class types. This allows for the tracking of multiple instances of objects
@@ -26,7 +26,7 @@ Jean-Philippe Steinmetz
 
 > **new ObjectFactory**(`config?`, `logger?`): `ObjectFactory`
 
-Defined in: [src/ObjectFactory.ts:22](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L22)
+Defined in: [src/ObjectFactory.ts:22](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L22)
 
 #### Parameters
 
@@ -108,7 +108,7 @@ The application logging utility.
 
 > **clear**(): `void`
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:37
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:43
 
 Deletes all instantiated objects.
 
@@ -126,7 +126,7 @@ Deletes all instantiated objects.
 
 > **clearAll**(): `void`
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:41
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:47
 
 Deletes all instantiated objects and registered class types.
 
@@ -144,7 +144,7 @@ Deletes all instantiated objects and registered class types.
 
 > **destroy**(`objs?`): `Promise`\<`void`\>
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:33
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:39
 
 Destroys the specified objects. If `undefined` is passed in, all objects managed by the factory are destroyed.
 
@@ -168,7 +168,7 @@ Destroys the specified objects. If `undefined` is passed in, all objects managed
 
 > **getInitMethods**(`obj`): `Function`[]
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:53
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:59
 
 Searches an object for one or more functions that implement a `@Init` decorator.
 
@@ -196,7 +196,7 @@ The list of functions that implements the `@Init` decorator if found, otherwise
 
 > **getInstance**\<`T`\>(`nameOrType`): `T` \| `undefined`
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:61
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:67
 
 Returns the object instance with the given unique name. Unique names take the form `<ClassName>:<InstanceName>`.
 It is possible to only specifiy the `<ClassName>`, doing so will automatically look for the `<ClassName>:default`
@@ -232,7 +232,7 @@ The object instance associated with the given name if found, otherwise `undefine
 
 > **initialize**\<`T`\>(`obj`): `Promise`\<`T`\>
 
-Defined in: [src/ObjectFactory.ts:30](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/ObjectFactory.ts#L30)
+Defined in: [src/ObjectFactory.ts:30](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/ObjectFactory.ts#L30)
 
 Scans the given object for any properties with the
 
@@ -268,7 +268,7 @@ decorator and assigns the correct values.
 
 > **newInstance**\<`T`\>(`type`, `options?`): `T` \| `Promise`\<`T`\>
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:71
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:77
 
 Creates a new instance of the class specified with the provided unique name or type and constructor arguments. If an existing
 object has already been created with the given name, that instance is returned, otherwise a new instance is created
@@ -309,7 +309,7 @@ The options to use when instantiating the new class object.
 
 > **register**(`clazz`, `fqn?`): `void`
 
-Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:77
+Defined in: node\_modules/@rapidrest/core/dist/types/ObjectFactory.d.ts:83
 
 Registers the given class type for the provided fully qualified name.
 

package/docs/reference/classes/OpenAPIRoute.md

@@ -6,7 +6,7 @@
 
 # Class: OpenAPIRoute
 
-Defined in: [src/routes/OpenAPIRoute.ts:44](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L44)
+Defined in: [src/routes/OpenAPIRoute.ts:44](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L44)
 
 The `OpenAPIRoute` provides default routes to expose the service's OpenAPI specification.
 
@@ -34,7 +34,7 @@ Jean-Philippe Steinmetz
 
 > **getAPIDocs**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L63)
+Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L63)
 
 #### Returns
 
@@ -46,7 +46,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:63](https://github.com/rapidrest/service
 
 > **getHTML**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L54)
+Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L54)
 
 #### Returns
 
@@ -58,7 +58,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:54](https://github.com/rapidrest/service
 
 > **getJSON**(): `any`
 
-Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L71)
+Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L71)
 
 #### Returns
 
@@ -70,7 +70,7 @@ Defined in: [src/routes/OpenAPIRoute.ts:71](https://github.com/rapidrest/service
 
 > **getYAML**(): `string`
 
-Defined in: [src/routes/OpenAPIRoute.ts:80](https://github.com/rapidrest/service-core/blob/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/routes/OpenAPIRoute.ts#L80)
+Defined in: [src/routes/OpenAPIRoute.ts:80](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/routes/OpenAPIRoute.ts#L80)
 
 #### Returns
 

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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L19)
+Defined in: [src/OpenApiSpec.ts:19](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L25)
+Defined in: [src/OpenApiSpec.ts:25](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L29)
+Defined in: [src/OpenApiSpec.ts:29](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L33)
+Defined in: [src/OpenApiSpec.ts:33](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L53)
+Defined in: [src/OpenApiSpec.ts:53](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L65)
+Defined in: [src/OpenApiSpec.ts:65](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L41)
+Defined in: [src/OpenApiSpec.ts:41](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L37)
+Defined in: [src/OpenApiSpec.ts:37](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L49)
+Defined in: [src/OpenApiSpec.ts:49](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L57)
+Defined in: [src/OpenApiSpec.ts:57](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L45)
+Defined in: [src/OpenApiSpec.ts:45](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L61)
+Defined in: [src/OpenApiSpec.ts:61](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L69)
+Defined in: [src/OpenApiSpec.ts:69](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L264)
+Defined in: [src/OpenApiSpec.ts:264](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L189)
+Defined in: [src/OpenApiSpec.ts:189](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L204)
+Defined in: [src/OpenApiSpec.ts:204](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L239)
+Defined in: [src/OpenApiSpec.ts:239](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L279)
+Defined in: [src/OpenApiSpec.ts:279](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L249)
+Defined in: [src/OpenApiSpec.ts:249](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L184)
+Defined in: [src/OpenApiSpec.ts:184](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L194)
+Defined in: [src/OpenApiSpec.ts:194](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L259)
+Defined in: [src/OpenApiSpec.ts:259](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L295)
+Defined in: [src/OpenApiSpec.ts:295](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L179)
+Defined in: [src/OpenApiSpec.ts:179](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L234)
+Defined in: [src/OpenApiSpec.ts:234](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L219)
+Defined in: [src/OpenApiSpec.ts:219](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L244)
+Defined in: [src/OpenApiSpec.ts:244](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L229)
+Defined in: [src/OpenApiSpec.ts:229](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L311)
+Defined in: [src/OpenApiSpec.ts:311](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L224)
+Defined in: [src/OpenApiSpec.ts:224](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L254)
+Defined in: [src/OpenApiSpec.ts:254](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L269)
+Defined in: [src/OpenApiSpec.ts:269](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L274)
+Defined in: [src/OpenApiSpec.ts:274](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L209)
+Defined in: [src/OpenApiSpec.ts:209](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L199)
+Defined in: [src/OpenApiSpec.ts:199](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L214)
+Defined in: [src/OpenApiSpec.ts:214](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L284)
+Defined in: [src/OpenApiSpec.ts:284](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L590)
+Defined in: [src/OpenApiSpec.ts:590](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L685)
+Defined in: [src/OpenApiSpec.ts:685](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L781)
+Defined in: [src/OpenApiSpec.ts:781](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L797)
+Defined in: [src/OpenApiSpec.ts:797](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L167)
+Defined in: [src/OpenApiSpec.ts:167](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L171)
+Defined in: [src/OpenApiSpec.ts:171](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L175)
+Defined in: [src/OpenApiSpec.ts:175](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/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/c8974caa9b5d3eb225bcbcd93945f2e588fe2f0a/src/OpenApiSpec.ts#L811)
+Defined in: [src/OpenApiSpec.ts:811](https://github.com/rapidrest/service-core/blob/5cd5bc79b3569101eabf54dec613fd4745a69b2b/src/OpenApiSpec.ts#L811)
 
 Merges a provided OpenAPI specification with this specification.