@synapticon/motion-master-client 6.0.0-alpha.46 → 6.0.0-alpha.47

package/dist/generated/Api.d.ts

@@ -36,6 +36,14 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         /** @example "6.0.0" */
         version: string;
     }, any>>;
+    /**
+     * @description Returns this document — the OpenAPI specification embedded in the running binary — as YAML. Lets a client discover the exact API contract of the server it is talking to without a packaged file or a matching source checkout; the served spec always matches the running version.
+     *
+     * @name GetSwaggerYml
+     * @summary Get this OpenAPI specification
+     * @request GET:/api/swagger.yml
+     */
+    getSwaggerYml: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<string, any>>;
     /**
      * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
      *
@@ -323,7 +331,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         error: string;
     }>>;
     /**
-     * @description Transitions all slaves to INIT state, closes the network interface, and removes all Device objects. After this returns, POST /api/init and POST /api/scan may be called again.
+     * @description Tears down all master-side state — unpublishes the process image, frees the recorder, removes all Device objects, and closes the network interface (releasing the NIC). It does not command the slaves to any AL state; the master simply stops talking to the bus. After this returns, POST /api/init and POST /api/scan may be called again.
      *
      * @name Reset
      * @summary Reset the fieldbus driver and clear the device list

package/dist/generated/Api.js

@@ -37,6 +37,18 @@ export class Api extends HttpClient {
         format: "json",
         ...params,
     });
+    /**
+     * @description Returns this document — the OpenAPI specification embedded in the running binary — as YAML. Lets a client discover the exact API contract of the server it is talking to without a packaged file or a matching source checkout; the served spec always matches the running version.
+     *
+     * @name GetSwaggerYml
+     * @summary Get this OpenAPI specification
+     * @request GET:/api/swagger.yml
+     */
+    getSwaggerYml = (params = {}) => this.request({
+        path: `/api/swagger.yml`,
+        method: "GET",
+        ...params,
+    });
     /**
      * @description The effective configuration after merging the JSONC config file (if any) over the built-in defaults — the same `Config` the server booted with. Read-only; changing it requires editing the config file and restarting. The shape mirrors the config file (server, fieldbus, logLevel, tls, gameLoop, recorder, parameterCache, parameters).
      *
@@ -131,7 +143,7 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Transitions all slaves to INIT state, closes the network interface, and removes all Device objects. After this returns, POST /api/init and POST /api/scan may be called again.
+     * @description Tears down all master-side state — unpublishes the process image, frees the recorder, removes all Device objects, and closes the network interface (releasing the NIC). It does not command the slaves to any AL state; the master simply stops talking to the bus. After this returns, POST /api/init and POST /api/scan may be called again.
      *
      * @name Reset
      * @summary Reset the fieldbus driver and clear the device list

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synapticon/motion-master-client",
-  "version": "6.0.0-alpha.46",
+  "version": "6.0.0-alpha.47",
   "description": "Isomorphic TypeScript client for Motion Master: the generated HTTP API client, the WebSocket connection, and helpers.",
   "license": "MIT",
   "repository": {