@twin.org/api-models 0.0.3-next.21 → 0.0.3-next.22

package/docs/reference/interfaces/INotFoundResponse.md

@@ -4,7 +4,7 @@ The resource you tried to access does not exist, see the content for more detail
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `404`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError` & `object`
 
@@ -22,6 +22,6 @@ The body which contains the error.
 
 ##### notFoundId?
 
-> `optional` **notFoundId**: `string`
+> `optional` **notFoundId?**: `string`
 
 The id if the item that was not found.

package/docs/reference/interfaces/INotImplementedResponse.md

@@ -0,0 +1,19 @@
+# Interface: INotImplementedResponse
+
+The operation that you tried to perform is not implemented, see the content for more details.
+
+## Properties
+
+### statusCode {#statuscode}
+
+> **statusCode**: `501`
+
+Response status code.
+
+***
+
+### body {#body}
+
+> **body**: `IError`
+
+The body which contains the error.

package/docs/reference/interfaces/IOkResponse.md

@@ -4,7 +4,7 @@ The rest request ended in success with no data.
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `200`
 

package/docs/reference/interfaces/IRestRoute.md

@@ -18,7 +18,7 @@ Interface which defines a REST route.
 
 ## Properties
 
-### operationId
+### operationId {#operationid}
 
 > **operationId**: `string`
 
@@ -30,7 +30,7 @@ The id of the operation.
 
 ***
 
-### path
+### path {#path}
 
 > **path**: `string`
 
@@ -42,9 +42,9 @@ The path to use for routing.
 
 ***
 
-### skipAuth?
+### skipAuth? {#skipauth}
 
-> `optional` **skipAuth**: `boolean`
+> `optional` **skipAuth?**: `boolean`
 
 Skips the authentication requirement for this route.
 
@@ -54,9 +54,9 @@ Skips the authentication requirement for this route.
 
 ***
 
-### skipTenant?
+### skipTenant? {#skiptenant}
 
-> `optional` **skipTenant**: `boolean`
+> `optional` **skipTenant?**: `boolean`
 
 Skips the tenant requirement for this route.
 
@@ -66,9 +66,9 @@ Skips the tenant requirement for this route.
 
 ***
 
-### requiredScope?
+### requiredScope? {#requiredscope}
 
-> `optional` **requiredScope**: `string`[]
+> `optional` **requiredScope?**: `string`[]
 
 The user must have one of the specified scopes to access the route.
 
@@ -78,9 +78,9 @@ The user must have one of the specified scopes to access the route.
 
 ***
 
-### processorFeatures?
+### processorFeatures? {#processorfeatures}
 
-> `optional` **processorFeatures**: `string`[]
+> `optional` **processorFeatures?**: `string`[]
 
 The features supported by additional processors to run for this route.
 
@@ -90,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.
 
@@ -106,7 +106,7 @@ The data for additional processors to run for this route.
 
 ***
 
-### summary
+### summary {#summary}
 
 > **summary**: `string`
 
@@ -114,7 +114,7 @@ Summary of what task the operation performs.
 
 ***
 
-### tag
+### tag {#tag}
 
 > **tag**: `string`
 
@@ -122,7 +122,7 @@ Tag for the operation.
 
 ***
 
-### method
+### method {#method}
 
 > **method**: `HttpMethod`
 
@@ -130,7 +130,7 @@ The http method.
 
 ***
 
-### handler()
+### handler {#handler}
 
 > **handler**: (`httpRequestContext`, `request`) => `Promise`\<`U`\>
 
@@ -156,9 +156,9 @@ The request object, combined query param, path params and body.
 
 ***
 
-### requestType?
+### requestType? {#requesttype}
 
-> `optional` **requestType**: `object`
+> `optional` **requestType?**: `object`
 
 The type of the request object.
 
@@ -170,21 +170,21 @@ The object type for the request.
 
 #### mimeType?
 
-> `optional` **mimeType**: `string`
+> `optional` **mimeType?**: `string`
 
 The mime type of the request, defaults to "application/json" if there is a body.
 
 #### examples?
 
-> `optional` **examples**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
+> `optional` **examples?**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
 
 Example objects for the request.
 
 ***
 
-### responseType?
+### responseType? {#responsetype}
 
-> `optional` **responseType**: `object`[]
+> `optional` **responseType?**: `object`[]
 
 The type of the response object.
 
@@ -196,20 +196,20 @@ The object type of the response.
 
 #### mimeType?
 
-> `optional` **mimeType**: `string`
+> `optional` **mimeType?**: `string`
 
 The mime type of the response, defaults to "application/json" if there is a body.
 
 #### examples?
 
-> `optional` **examples**: [`IRestRouteResponseExample`](IRestRouteResponseExample.md)\<`U`\>[]
+> `optional` **examples?**: [`IRestRouteResponseExample`](IRestRouteResponseExample.md)\<`U`\>[]
 
 Example objects of the response.
 
 ***
 
-### excludeFromSpec?
+### excludeFromSpec? {#excludefromspec}
 
-> `optional` **excludeFromSpec**: `boolean`
+> `optional` **excludeFromSpec?**: `boolean`
 
 Exclude the route from being included in the spec file.

package/docs/reference/interfaces/IRestRouteExample.md

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

package/docs/reference/interfaces/IRestRouteProcessor.md

@@ -8,7 +8,7 @@ The definition for a processor for handling REST routes.
 
 ## Methods
 
-### features()?
+### features()? {#features}
 
 > `optional` **features**(): `string`[]
 
@@ -28,7 +28,7 @@ The features supported by this processor.
 
 ***
 
-### pre()?
+### pre()? {#pre}
 
 > `optional` **pre**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -50,9 +50,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -92,7 +92,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### post()?
+### post()? {#post}
 
 > `optional` **post**(`request`, `response`, `route`, `contextIds`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -114,9 +114,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### contextIds
 
@@ -156,7 +156,7 @@ Promise that resolves when the request is processed.
 
 ***
 
-### process()?
+### process()? {#process}
 
 > `optional` **process**(`request`, `response`, `route`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
@@ -178,9 +178,9 @@ The response data to send if any.
 
 ##### route
 
-The route being requested, if a matching one was found.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> | `undefined`
+The route being requested, if a matching one was found.
 
 ##### processorState
 

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -14,7 +14,7 @@ Interface which defines a REST route request 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.
 
 ***
 
-### request
+### request {#request}
 
 > **request**: `T`
 

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,7 +4,7 @@ The health of the server.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: [`IHealthInfo`](IHealthInfo.md)
 

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

@@ -4,7 +4,7 @@ The livez of the server.
 
 ## Properties
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -16,7 +16,7 @@ The headers for the response.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `"ok"` \| `"failed"`
 

package/docs/reference/interfaces/IServerRootResponse.md

@@ -4,7 +4,7 @@ The root text for the server.
 
 ## Properties
 
-### headers
+### headers {#headers}
 
 > **headers**: `object`
 
@@ -16,7 +16,7 @@ The headers for the response.
 
 ***
 
-### body
+### 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,9 +48,9 @@ Logging component type for the request.
 
 ***
 
-### hostingComponentType?
+### hostingComponentType? {#hostingcomponenttype}
 
-> `optional` **hostingComponentType**: `string`
+> `optional` **hostingComponentType?**: `string`
 
 Hosting component type for the request.
 
@@ -60,7 +60,7 @@ Hosting component type for the request.
 
 ***
 
-### socketId
+### socketId {#socketid}
 
 > **socketId**: `string`