@twin.org/api-models 0.0.3-next.9 → 0.9.0-next.1

package/docs/reference/interfaces/IInformationComponent.md

@@ -8,7 +8,7 @@ The information component for the server.
 
 ## Methods
 
-### root()
+### root() {#root}
 
 > **root**(): `Promise`\<`string`\>
 
@@ -22,7 +22,7 @@ The root information.
 
 ***
 
-### info()
+### info() {#info}
 
 > **info**(): `Promise`\<[`IServerInfo`](IServerInfo.md)\>
 
@@ -36,7 +36,7 @@ The service information.
 
 ***
 
-### favicon()
+### favicon() {#favicon}
 
 > **favicon**(): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\> \| `undefined`\>
 
@@ -50,7 +50,7 @@ The favicon.
 
 ***
 
-### spec()
+### spec() {#spec}
 
 > **spec**(): `Promise`\<`unknown`\>
 
@@ -64,96 +64,28 @@ The OpenAPI spec.
 
 ***
 
-### livez()
+### livez() {#livez}
 
-> **livez**(): `Promise`\<`boolean`\>
+> **livez**(): `Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
 Is the server live.
 
 #### Returns
 
-`Promise`\<`boolean`\>
+`Promise`\<\{ `status`: `"alive"` \| `"dead"`; \}\>
 
-True if the server is live.
+The livez status of the server.
 
 ***
 
-### health()
+### readyz() {#readyz}
 
-> **health**(): `Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+> **readyz**(): `Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-Get the server health.
+Is the server ready.
 
 #### Returns
 
-`Promise`\<[`IHealthInfo`](IHealthInfo.md)\>
+`Promise`\<\{ `status`: `"ready"` \| `"not ready"`; \}\>
 
-The service health.
-
-***
-
-### setComponentHealth()
-
-> **setComponentHealth**(`name`, `status`, `details?`, `tenantId?`): `Promise`\<`void`\>
-
-Set the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### status
-
-[`HealthStatus`](../type-aliases/HealthStatus.md)
-
-The status of the component.
-
-##### details?
-
-`string`
-
-The details for the status.
-
-##### tenantId?
-
-`string`
-
-The tenant id, optional if the health status is not tenant specific.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
-
-***
-
-### removeComponentHealth()
-
-> **removeComponentHealth**(`name`, `tenantId?`): `Promise`\<`void`\>
-
-Remove the status of a component.
-
-#### Parameters
-
-##### name
-
-`string`
-
-The component name.
-
-##### tenantId?
-
-`string`
-
-The tenant id, optional if the health status is not tenant specific.
-
-#### Returns
-
-`Promise`\<`void`\>
-
-Nothing.
+The readyz status of the server.

package/docs/reference/interfaces/IInternalServerErrorResponse.md

@@ -4,7 +4,7 @@ The server has encountered a situation it does not know how to handle, see the c
 
 ## Properties
 
-### statusCode
+### statusCode {#statuscode}
 
 > **statusCode**: `500`
 
@@ -12,7 +12,7 @@ Response status code.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IError`
 

package/docs/reference/interfaces/IMimeTypeProcessor.md

@@ -8,7 +8,7 @@ The definition for a handler for a specific MIME type.
 
 ## Methods
 
-### getTypes()
+### getTypes() {#gettypes}
 
 > **getTypes**(): `string`[]
 
@@ -22,7 +22,7 @@ The MIME types that this handler can handle.
 
 ***
 
-### handle()
+### handle() {#handle}
 
 > **handle**(`body`): `Promise`\<`unknown`\>
 

package/docs/reference/interfaces/INoContentRequest.md

@@ -8,9 +8,9 @@ A REST request with no input parameters.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `undefined`
+> `optional` **headers?**: `undefined`
 
 Incoming Http Headers.
 
@@ -20,9 +20,9 @@ Incoming Http Headers.
 
 ***
 
-### pathParams?
+### pathParams? {#pathparams}
 
-> `optional` **pathParams**: `undefined`
+> `optional` **pathParams?**: `undefined`
 
 The path parameters.
 
@@ -32,9 +32,9 @@ The path parameters.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `undefined`
+> `optional` **query?**: `undefined`
 
 The query parameters.
 
@@ -44,9 +44,9 @@ The query parameters.
 
 ***
 
-### body?
+### body? {#body}
 
-> `optional` **body**: `undefined`
+> `optional` **body?**: `undefined`
 
 Data to return send as the body.
 

package/docs/reference/interfaces/INoContentResponse.md

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

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/IPlatformComponent.md

@@ -0,0 +1,65 @@
+# Interface: IPlatformComponent
+
+Interface for the platform component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### isMultiTenant() {#ismultitenant}
+
+> **isMultiTenant**(): `boolean`
+
+Indicates whether the component is running in a multi-tenant environment.
+
+#### Returns
+
+`boolean`
+
+True if the component is running in a multi-tenant environment, false otherwise.
+
+***
+
+### execute() {#execute}
+
+> **execute**(`method`): `Promise`\<`void`\>
+
+Execute a method, if single tenant will run once, if multi-tenant will run for each tenant.
+
+#### Parameters
+
+##### method
+
+() => `Promise`\<`void`\>
+
+The method to run for each tenant.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the method has been executed for all applicable tenants.
+
+***
+
+### getLocalOriginContext() {#getlocalorigincontext}
+
+> **getLocalOriginContext**(`url`): `Promise`\<`IContextIds` \| `undefined`\>
+
+Get the local origin context IDs for the given URL.
+
+#### Parameters
+
+##### url
+
+`string`
+
+The URL to check.
+
+#### Returns
+
+`Promise`\<`IContextIds` \| `undefined`\>
+
+A promise that resolves to the context IDs if the URL is a local origin, undefined otherwise.

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,21 @@ Skips the tenant requirement for this route.
 
 ***
 
-### processorFeatures?
+### requiredScope? {#requiredscope}
 
-> `optional` **processorFeatures**: `string`[]
+> `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.
 
@@ -78,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.
 
@@ -94,7 +106,7 @@ The data for additional processors to run for this route.
 
 ***
 
-### summary
+### summary {#summary}
 
 > **summary**: `string`
 
@@ -102,7 +114,7 @@ Summary of what task the operation performs.
 
 ***
 
-### tag
+### tag {#tag}
 
 > **tag**: `string`
 
@@ -110,7 +122,7 @@ Tag for the operation.
 
 ***
 
-### method
+### method {#method}
 
 > **method**: `HttpMethod`
 
@@ -118,7 +130,7 @@ The http method.
 
 ***
 
-### handler()
+### handler {#handler}
 
 > **handler**: (`httpRequestContext`, `request`) => `Promise`\<`U`\>
 
@@ -144,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.
 
@@ -158,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.
 
@@ -184,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,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.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`IRestRoute`](IRestRoute.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.
+[`IRestRoute`](IRestRoute.md)\<`any`, `any`\> \| `undefined`
 
-[`IRestRoute`](IRestRoute.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,9 +144,9 @@ Promise that resolves when the request is processed.
 
 ***
 
-### process()?
+### process()? {#process}
 
-> `optional` **process**(`request`, `response`, `route`, `processorState`, `loggingComponentType?`): `Promise`\<`void`\>
+> `optional` **process**(`request`, `response`, `route`, `processorState`, `componentTypes?`): `Promise`\<`void`\>
 
 Process the REST request for the specified route.
 
@@ -158,19 +166,23 @@ 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
 
 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
 

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`