@gtsc/api-models
Advanced tools
Comparing version 0.0.5-next.6 to 0.0.5-next.7
@@ -6,5 +6,5 @@ /** | ||
/** | ||
* The identity of the system the request is being performed on. | ||
* The identity of the node the request is being performed on. | ||
*/ | ||
systemIdentity?: string; | ||
nodeIdentity?: string; | ||
/** | ||
@@ -11,0 +11,0 @@ * The identity of the requestor if there is an authenticated user. |
@@ -31,11 +31,11 @@ # Interface: IHttpRequestContext | ||
### systemIdentity? | ||
### nodeIdentity? | ||
> `optional` **systemIdentity**: `string` | ||
> `optional` **nodeIdentity**: `string` | ||
The identity of the system the request is being performed on. | ||
The identity of the node the request is being performed on. | ||
#### Inherited from | ||
[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`systemIdentity`](IHttpRequestIdentity.md#systemidentity) | ||
[`IHttpRequestIdentity`](IHttpRequestIdentity.md).[`nodeIdentity`](IHttpRequestIdentity.md#nodeidentity) | ||
@@ -42,0 +42,0 @@ *** |
@@ -11,7 +11,7 @@ # Interface: IHttpRequestIdentity | ||
### systemIdentity? | ||
### nodeIdentity? | ||
> `optional` **systemIdentity**: `string` | ||
> `optional` **nodeIdentity**: `string` | ||
The identity of the system the request is being performed on. | ||
The identity of the node the request is being performed on. | ||
@@ -18,0 +18,0 @@ *** |
@@ -25,3 +25,3 @@ # Interface: IHttpRestRouteProcessor | ||
> `optional` **bootstrap**(`systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
@@ -32,5 +32,5 @@ Bootstrap the service by creating and initializing any resources it needs. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -51,15 +51,15 @@ #### Returns | ||
> `optional` **start**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The service needs to be started when the application is initialized. | ||
The service needs to be started when the node is initialized. | ||
#### Parameters | ||
• **systemIdentity**: `string` | ||
• **nodeIdentity**: `string` | ||
The identity of the system. | ||
The identity of the node starting the service. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -80,15 +80,15 @@ #### Returns | ||
> `optional` **stop**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The service needs to be stopped when the application is closed. | ||
The service needs to be stopped when the node is closed. | ||
#### Parameters | ||
• **systemIdentity**: `string` | ||
• **nodeIdentity**: `string` | ||
The identity of the system. | ||
The identity of the node stopping the service. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -95,0 +95,0 @@ #### Returns |
@@ -25,3 +25,3 @@ # Interface: IInformation | ||
> `optional` **bootstrap**(`systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
@@ -32,5 +32,5 @@ Bootstrap the service by creating and initializing any resources it needs. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -51,15 +51,15 @@ #### Returns | ||
> `optional` **start**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **start**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The service needs to be started when the application is initialized. | ||
The service needs to be started when the node is initialized. | ||
#### Parameters | ||
• **systemIdentity**: `string` | ||
• **nodeIdentity**: `string` | ||
The identity of the system. | ||
The identity of the node starting the service. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -80,15 +80,15 @@ #### Returns | ||
> `optional` **stop**(`systemIdentity`, `systemLoggingConnectorType`?): `Promise`\<`void`\> | ||
> `optional` **stop**(`nodeIdentity`, `nodeLoggingConnectorType`?): `Promise`\<`void`\> | ||
The service needs to be stopped when the application is closed. | ||
The service needs to be stopped when the node is closed. | ||
#### Parameters | ||
• **systemIdentity**: `string` | ||
• **nodeIdentity**: `string` | ||
The identity of the system. | ||
The identity of the node stopping the service. | ||
• **systemLoggingConnectorType?**: `string` | ||
• **nodeLoggingConnectorType?**: `string` | ||
The system logging connector type, defaults to "system-logging". | ||
The node logging connector type, defaults to "node-logging". | ||
@@ -95,0 +95,0 @@ #### Returns |
{ | ||
"name": "@gtsc/api-models", | ||
"version": "0.0.5-next.6", | ||
"version": "0.0.5-next.7", | ||
"description": "Contains models and classes for use with APIs", | ||
@@ -5,0 +5,0 @@ "repository": { |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
69107