@twin.org/api-models 0.0.1-next.7 → 0.0.1-next.8

package/dist/types/index.d.ts

@@ -27,7 +27,10 @@ export * from "./models/responses/success/IOkResponse";
 export * from "./models/routes/IBaseRoute";
 export * from "./models/routes/IRestRoute";
 export * from "./models/routes/IRestRouteEntryPoint";
+export * from "./models/routes/IRestRouteExample";
+export * from "./models/routes/IRestRouteRequestExample";
 export * from "./models/routes/IRestRouteResponseAttachmentOptions";
+export * from "./models/routes/IRestRouteResponseExample";
 export * from "./models/routes/IRestRouteResponseOptions";
 export * from "./models/routes/ISocketRoute";
 export * from "./models/routes/ITag";

package/dist/types/models/routes/IRestRoute.d.ts

@@ -1,5 +1,7 @@
 import type { HttpMethod } from "@twin.org/web";
 import type { IBaseRoute } from "./IBaseRoute";
+import type { IRestRouteRequestExample } from "./IRestRouteRequestExample";
+import type { IRestRouteResponseExample } from "./IRestRouteResponseExample";
 import type { IRestRouteResponseOptions } from "./IRestRouteResponseOptions";
 import type { IHttpRequest } from "../protocol/IHttpRequest";
 import type { IHttpRequestContext } from "../protocol/IHttpRequestContext";
@@ -47,11 +49,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects for the request.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            request: T;
-        }[];
+        examples?: IRestRouteRequestExample<T>[];
     };
     /**
      * The type of the response object.
@@ -68,11 +66,7 @@ export interface IRestRoute<T extends IHttpRequest = any, U extends IHttpRespons
         /**
          * Example objects of the response.
          */
-        examples?: {
-            id: string;
-            description?: string;
-            response: U;
-        }[];
+        examples?: IRestRouteResponseExample<U>[];
     }[];
     /**
      * Exclude the route from being included in the spec file.

package/dist/types/models/routes/IRestRouteExample.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface which defines a REST route example.
+ */
+export interface IRestRouteExample {
+    /**
+     * Example objects for the request.
+     */
+    id: string;
+    /**
+     * Description of the example.
+     */
+    description?: string;
+}

package/dist/types/models/routes/IRestRouteRequestExample.d.ts

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route request example.
+ */
+export interface IRestRouteRequestExample<T> extends IRestRouteExample {
+    /**
+     * The example request object.
+     */
+    request: T;
+}

package/dist/types/models/routes/IRestRouteResponseExample.d.ts

@@ -0,0 +1,10 @@
+import type { IRestRouteExample } from "./IRestRouteExample";
+/**
+ * Interface which defines a REST route response example.
+ */
+export interface IRestRouteResponseExample<T> extends IRestRouteExample {
+    /**
+     * The example response object.
+     */
+    response: T;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/api-models - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.8
 
 - Initial Release

package/docs/reference/index.md

@@ -34,7 +34,10 @@
 - [IBaseRoute](interfaces/IBaseRoute.md)
 - [IRestRoute](interfaces/IRestRoute.md)
 - [IRestRouteEntryPoint](interfaces/IRestRouteEntryPoint.md)
+- [IRestRouteExample](interfaces/IRestRouteExample.md)
+- [IRestRouteRequestExample](interfaces/IRestRouteRequestExample.md)
 - [IRestRouteResponseAttachmentOptions](interfaces/IRestRouteResponseAttachmentOptions.md)
+- [IRestRouteResponseExample](interfaces/IRestRouteResponseExample.md)
 - [IRestRouteResponseOptions](interfaces/IRestRouteResponseOptions.md)
 - [ISocketRoute](interfaces/ISocketRoute.md)
 - [ITag](interfaces/ITag.md)

package/docs/reference/interfaces/IRestRoute.md

@@ -116,7 +116,7 @@ The mime type of the request, defaults to "application/json" if there is a body.
 
 #### examples?
 
-> `optional` **examples**: `object`[]
+> `optional` **examples**: [`IRestRouteRequestExample`](IRestRouteRequestExample.md)\<`T`\>[]
 
 Example objects for the request.
 

package/docs/reference/interfaces/IRestRouteExample.md

@@ -0,0 +1,24 @@
+# Interface: IRestRouteExample
+
+Interface which defines a REST route example.
+
+## Extended by
+
+- [`IRestRouteRequestExample`](IRestRouteRequestExample.md)
+- [`IRestRouteResponseExample`](IRestRouteResponseExample.md)
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.

package/docs/reference/interfaces/IRestRouteRequestExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteRequestExample\<T\>
+
+Interface which defines a REST route request example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### request
+
+> **request**: `T`
+
+The example request object.

package/docs/reference/interfaces/IRestRouteResponseExample.md

@@ -0,0 +1,43 @@
+# Interface: IRestRouteResponseExample\<T\>
+
+Interface which defines a REST route response example.
+
+## Extends
+
+- [`IRestRouteExample`](IRestRouteExample.md)
+
+## Type Parameters
+
+• **T**
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+Example objects for the request.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`id`](IRestRouteExample.md#id)
+
+***
+
+### description?
+
+> `optional` **description**: `string`
+
+Description of the example.
+
+#### Inherited from
+
+[`IRestRouteExample`](IRestRouteExample.md).[`description`](IRestRouteExample.md#description)
+
+***
+
+### response
+
+> **response**: `T`
+
+The example response object.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/api-models",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.8",
 	"description": "Contains models and classes for use with APIs",
 	"repository": {
 		"type": "git",