@twin.org/api-models 0.0.3-next.5 → 0.0.3-next.51

package/docs/reference/interfaces/IRestRouteResponseAttachmentOptions.md

@@ -4,24 +4,24 @@ Interface which defines a REST route response for attachments.
 
 ## Properties
 
-### mimeType?
+### mimeType? {#mimetype}
 
-> `optional` **mimeType**: `string`
+> `optional` **mimeType?**: `string`
 
 The content type to use in the response.
 
 ***
 
-### filename?
+### filename? {#filename}
 
-> `optional` **filename**: `string`
+> `optional` **filename?**: `string`
 
 The filename to use in content disposition.
 
 ***
 
-### inline?
+### inline? {#inline}
 
-> `optional` **inline**: `boolean`
+> `optional` **inline?**: `boolean`
 
 Whether to inline the content.

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -14,7 +14,7 @@ Interface which defines a REST route response example.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -26,9 +26,9 @@ Example objects for the request.
 
 ***
 
-### description?
+### description? {#description}
 
-> `optional` **description**: `string`
+> `optional` **description?**: `string`
 
 Description of the example.
 
@@ -38,7 +38,7 @@ Description of the example.
 
 ***
 
-### response
+### response {#response}
 
 > **response**: `T`
 

package/docs/reference/interfaces/IRestRouteResponseOptions.md

@@ -4,8 +4,8 @@ Interface which defines a REST route response.
 
 ## Properties
 
-### attachment?
+### attachment? {#attachment}
 
-> `optional` **attachment**: [`IRestRouteResponseAttachmentOptions`](IRestRouteResponseAttachmentOptions.md)
+> `optional` **attachment?**: [`IRestRouteResponseAttachmentOptions`](IRestRouteResponseAttachmentOptions.md)
 
 Additional options that can be used to control the response.

package/docs/reference/interfaces/IServerFavIconResponse.md

@@ -4,30 +4,30 @@ The favicon for the server.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 Additional response headers.
 
 #### content-type?
 
-> `optional` **content-type**: `string`
+> `optional` **content-type?**: `string`
 
 The content type for the response.
 
 ***
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `Uint8Array`\<`ArrayBufferLike`\>
+> `optional` **body?**: `Uint8Array`\<`ArrayBufferLike`\>
 
 The favicon for the server.

package/docs/reference/interfaces/IServerHealthResponse.md

@@ -4,8 +4,16 @@ The health of the server.
 
 ## Properties
 
-### body
+### body {#body}
 
-> **body**: [`IHealthInfo`](IHealthInfo.md)
+> **body**: `object`
 
-The information for the server.
+The health for the server.
+
+#### status
+
+> **status**: `HealthStatus`
+
+#### components
+
+> **components**: `IHealth`[]

package/docs/reference/interfaces/IServerInfo.md

@@ -4,7 +4,7 @@ The information about the server.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -12,7 +12,7 @@ The application name.
 
 ***
 
-### version
+### version {#version}
 
 > **version**: `string`
 

package/docs/reference/interfaces/IServerInfoResponse.md

@@ -4,7 +4,7 @@ The information about the server.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: [`IServerInfo`](IServerInfo.md)
 

package/docs/reference/interfaces/IServerLivezResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerLivezResponse
+
+The livez of the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `"alive"` \| `"dead"`
+
+The livez information for the server.

package/docs/reference/interfaces/IServerReadyzResponse.md

@@ -0,0 +1,23 @@
+# Interface: IServerReadyzResponse
+
+The readyz of the server.
+
+## Properties
+
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
+
+> **body**: `"ready"` \| `"not ready"`
+
+The readyz information for the server.

package/docs/reference/interfaces/IServerRootResponse.md

@@ -4,7 +4,19 @@ The root text for the server.
 
 ## Properties
 
-### body
+### headers {#headers}
+
+> **headers**: `object`
+
+The headers for the response.
+
+#### content-type
+
+> **content-type**: `"text/plain"`
+
+***
+
+### body {#body}
 
 > **body**: `string`
 

package/docs/reference/interfaces/IServerSpecResponse.md

@@ -4,16 +4,16 @@ The OpenAPI spec for the endpoints.
 
 ## Properties
 
-### statusCode?
+### statusCode? {#statuscode}
 
-> `optional` **statusCode**: `HttpStatusCode`
+> `optional` **statusCode?**: `HttpStatusCode`
 
 Response status code.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `unknown`
+> `optional` **body?**: `unknown`
 
 The spec for the server.

package/docs/reference/interfaces/ISocketRequestContext.md

@@ -8,7 +8,7 @@ Context data from the socket request.
 
 ## Properties
 
-### serverRequest
+### serverRequest {#serverrequest}
 
 > **serverRequest**: [`IHttpServerRequest`](IHttpServerRequest.md)
 
@@ -20,7 +20,7 @@ The raw HTTP request.
 
 ***
 
-### processorState
+### processorState {#processorstate}
 
 > **processorState**: `object`
 
@@ -36,9 +36,9 @@ The state handed through the processors.
 
 ***
 
-### loggingComponentType?
+### loggingComponentType? {#loggingcomponenttype}
 
-> `optional` **loggingComponentType**: `string`
+> `optional` **loggingComponentType?**: `string`
 
 Logging component type for the request.
 
@@ -48,7 +48,7 @@ Logging component type for the request.
 
 ***
 
-### socketId
+### socketId {#socketid}
 
 > **socketId**: `string`
 

package/docs/reference/interfaces/ISocketRoute.md

@@ -18,7 +18,7 @@ Interface which defines a socket route.
 
 ## Properties
 
-### operationId
+### operationId {#operationid}
 
 > **operationId**: `string`
 
@@ -30,7 +30,7 @@ The id of the operation.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -42,11 +42,11 @@ The path to use for routing.
 
 ***
 
-### skipAuth?
+### skipAuth? {#skipauth}
 
-> `optional` **skipAuth**: `boolean`
+> `optional` **skipAuth?**: `boolean`
 
-Skips the authentication for this route.
+Skips the authentication requirement for this route.
 
 #### Inherited from
 
@@ -54,9 +54,33 @@ Skips the authentication for this route.
 
 ***
 
-### processorFeatures?
+### skipTenant? {#skiptenant}
 
-> `optional` **processorFeatures**: `string`[]
+> `optional` **skipTenant?**: `boolean`
+
+Skips the tenant requirement for this route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`skipTenant`](IBaseRoute.md#skiptenant)
+
+***
+
+### requiredScope? {#requiredscope}
+
+> `optional` **requiredScope?**: `string`[]
+
+The user must have one of the specified scopes to access the route.
+
+#### Inherited from
+
+[`IBaseRoute`](IBaseRoute.md).[`requiredScope`](IBaseRoute.md#requiredscope)
+
+***
+
+### processorFeatures? {#processorfeatures}
+
+> `optional` **processorFeatures?**: `string`[]
 
 The features supported by additional processors to run for this route.
 
@@ -66,9 +90,9 @@ The features supported by additional processors to run for this route.
 
 ***
 
-### processorData?
+### processorData? {#processordata}
 
-> `optional` **processorData**: `object`
+> `optional` **processorData?**: `object`
 
 The data for additional processors to run for this route.
 
@@ -82,7 +106,7 @@ The data for additional processors to run for this route.
 
 ***
 
-### handler()
+### handler {#handler}
 
 > **handler**: (`socketRequestContext`, `request`, `emit`) => `void`
 
@@ -114,9 +138,9 @@ The function to emit an event.
 
 ***
 
-### connected()?
+### connected? {#connected}
 
-> `optional` **connected**: (`socketRequestContext`) => `void`
+> `optional` **connected?**: (`socketRequestContext`) => `void`
 
 The connected handler.
 
@@ -134,9 +158,9 @@ The request context.
 
 ***
 
-### disconnected()?
+### disconnected? {#disconnected}
 
-> `optional` **disconnected**: (`socketRequestContext`) => `void`
+> `optional` **disconnected?**: (`socketRequestContext`) => `void`
 
 The disconnected handler.
 

package/docs/reference/interfaces/ISocketRouteProcessor.md

@@ -8,7 +8,7 @@ The definition for a processor for handling socket routes.
 
 ## Methods
 
-### features()?
+### features()? {#features}
 
 > `optional` **features**(): `string`[]
 
@@ -28,9 +28,9 @@ The features supported by this processor.
 
 ***
 
-### pre()?
+### pre()? {#pre}
 
-> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Pre process the REST request for the specified route.
 
@@ -50,9 +50,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -64,11 +64,15 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
 
 `string`
 
-The logging component type for the request.
+The logging component type.
 
 #### Returns
 
@@ -82,9 +86,9 @@ Promise that resolves when the request is processed.
 
 ***
 
-### post()?
+### post()? {#post}
 
-> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Post process the REST request for the specified route.
 
@@ -104,9 +108,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -118,11 +122,15 @@ The context IDs of the request.
 
 The state handed through the processors.
 
-##### loggingComponentType?
+##### componentTypes?
+
+The component types for the request.
+
+###### loggingComponentType?
 
 `string`
 
-The logging component type for the request.
+The logging component type.
 
 #### Returns
 
@@ -136,7 +144,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### connected()?
+### connected()? {#connected}
 
 > `optional` **connected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -152,9 +160,9 @@ The server request object containing the socket id and other parameters.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### loggingComponentType?
 
@@ -170,7 +178,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### disconnected()?
+### disconnected()? {#disconnected}
 
 > `optional` **disconnected**(`request`, `route`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -186,9 +194,9 @@ The server request object containing the socket id and other parameters.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### loggingComponentType?
 
@@ -204,7 +212,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### process()?
+### process()? {#process}
 
 > `optional` **process**(`request`, `response`, `route`, `processorState`, `responseEmitter`, `loggingComponentType?`): `Promise`\<`void`\>
 
@@ -226,9 +234,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`ISocketRoute`](ISocketRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### processorState
 

package/docs/reference/interfaces/ISocketServerRequest.md

@@ -14,9 +14,9 @@ Model for the standard parameters for an http request.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `IHttpHeaders`
+> `optional` **headers?**: `IHttpHeaders`
 
 Incoming Http Headers.
 
@@ -26,9 +26,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
+> `optional` **pathParams?**: [`IHttpRequestPathParams`](IHttpRequestPathParams.md)
 
 The path parameters.
 
@@ -38,9 +38,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
+> `optional` **query?**: [`IHttpRequestQuery`](IHttpRequestQuery.md)
 
 The query parameters.
 
@@ -50,9 +50,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `T`
+> `optional` **body?**: `T`
 
 Data to return send as the body.
 
@@ -62,31 +62,31 @@ Data to return send as the body.
 
 ***
 
-### method?
+### url {#url}
 
-> `optional` **method**: `HttpMethod`
+> **url**: `string`
 
-The request method.
+The request url.
 
 #### Inherited from
 
-[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
+[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
 
 ***
 
-### url?
+### method? {#method}
 
-> `optional` **url**: `string`
+> `optional` **method?**: `HttpMethod`
 
-The request url.
+The request method.
 
 #### Inherited from
 
-[`IHttpServerRequest`](IHttpServerRequest.md).[`url`](IHttpServerRequest.md#url)
+[`IHttpServerRequest`](IHttpServerRequest.md).[`method`](IHttpServerRequest.md#method)
 
 ***
 
-### socketId
+### socketId {#socketid}
 
 > **socketId**: `string`
 

package/docs/reference/interfaces/ITag.md

@@ -4,7 +4,7 @@ Tag for routes used to generate OpenAPI information.
 
 ## Properties
 
-### name
+### name {#name}
 
 > **name**: `string`
 
@@ -12,7 +12,7 @@ The name of the tag.
 
 ***
 
-### description
+### description {#description}
 
 > **description**: `string`