npm - @wandelbots/nova-api - Versions diffs - 25.7.0-dev.4 → 25.7.0-dev.5 - Mend

@wandelbots/nova-api 25.7.0-dev.4 → 25.7.0-dev.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@wandelbots/nova-api",
-  "version": "25.7.0-dev.4",
+  "version": "25.7.0-dev.5",
   "description": "API Client to interact with Wandelbots Public API.",
   "files": [
     "*",

package/v1/api.d.ts CHANGED Viewed

@@ -7277,7 +7277,7 @@ export interface VersionNumber {
     'string_version'?: string;
 }
 /**
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
  * @export
  * @interface VirtualController
  */
@@ -7301,7 +7301,7 @@ export interface VirtualController {
      */
     'type'?: VirtualControllerTypes;
     /**
-     *
+     * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](getVirtualRobotConfiguration). If this field is provided, the `type` field should not be used.
      * @type {string}
      * @memberof VirtualController
      */
@@ -8041,7 +8041,7 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
      */
     getSupportedModes: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8179,7 +8179,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
      */
     getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ControllerCapabilities>>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8317,7 +8317,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
      */
     getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<ControllerCapabilities>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -8464,7 +8464,7 @@ export declare class ControllerApi extends BaseAPI {
      */
     getSupportedModes(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ControllerCapabilities, any>>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.

package/v1/api.js CHANGED Viewed

@@ -1824,7 +1824,7 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2225,7 +2225,7 @@ export const ControllerApiFp = function (configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2415,7 +2415,7 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getSupportedModes(cell, controller, options).then((request) => request(axios, basePath));
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2591,7 +2591,7 @@ export class ControllerApi extends BaseAPI {
         return ControllerApiFp(this.configuration).getSupportedModes(cell, controller, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.

package/v1/api.ts CHANGED Viewed

@@ -7444,7 +7444,7 @@ export interface VersionNumber {
     'string_version'?: string;
 }
 /**
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
  * @export
  * @interface VirtualController
  */
@@ -7468,7 +7468,7 @@ export interface VirtualController {
      */
     'type'?: VirtualControllerTypes;
     /**
-     *
+     * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](getVirtualRobotConfiguration). If this field is provided, the `type` field should not be used.
      * @type {string}
      * @memberof VirtualController
      */
@@ -9095,7 +9095,7 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9551,7 +9551,7 @@ export const ControllerApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9742,7 +9742,7 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
             return localVarFp.getSupportedModes(cell, controller, options).then((request) => request(axios, basePath));
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -9926,7 +9926,7 @@ export class ControllerApi extends BaseAPI {
     }
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.

package/v2/api.d.ts CHANGED Viewed

@@ -4306,7 +4306,7 @@ export interface ValidationError {
  */
 export type ValidationErrorLocInner = number | string;
 /**
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
  * @export
  * @interface VirtualController
  */
@@ -4330,7 +4330,7 @@ export interface VirtualController {
      */
     'type'?: VirtualControllerTypes;
     /**
-     *
+     * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](getVirtualRobotConfiguration). If provided, the `type` field should not be used.
      * @type {string}
      * @memberof VirtualController
      */
@@ -5154,7 +5154,7 @@ export declare const ControllerApiAxiosParamCreator: (configuration?: Configurat
      */
     getRobotController: (cell: string, controller: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5304,7 +5304,7 @@ export declare const ControllerApiFp: (configuration?: Configuration) => {
      */
     getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RobotController>>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5454,7 +5454,7 @@ export declare const ControllerApiFactory: (configuration?: Configuration, baseP
      */
     getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): AxiosPromise<RobotController>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.
@@ -5614,7 +5614,7 @@ export declare class ControllerApi extends BaseAPI {
      */
     getRobotController(cell: string, controller: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RobotController, any>>;
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.

package/v2/api.js CHANGED Viewed

@@ -1981,7 +1981,7 @@ export const ControllerApiAxiosParamCreator = function (configuration) {
             };
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2402,7 +2402,7 @@ export const ControllerApiFp = function (configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2606,7 +2606,7 @@ export const ControllerApiFactory = function (configuration, basePath, axios) {
             return localVarFp.getRobotController(cell, controller, options).then((request) => request(axios, basePath));
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -2797,7 +2797,7 @@ export class ControllerApi extends BaseAPI {
         return ControllerApiFp(this.configuration).getRobotController(cell, controller, options).then((request) => request(this.axios, this.basePath));
     }
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.

package/v2/api.ts CHANGED Viewed

@@ -4543,7 +4543,7 @@ export interface ValidationError {
 export type ValidationErrorLocInner = number | string;
 /**
- * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a type or the full JSON configuration. The JSON config of a physical controller can be obtained via `/cells/{cell}/controllers/{controller}/virtual-robot-configuration`
+ * The configuration of a virtual robot controller has to contain the manufacturer string, an optional joint position string array and either a preset `type` **or** the complete JSON configuration.
  * @export
  * @interface VirtualController
  */
@@ -4567,7 +4567,7 @@ export interface VirtualController {
      */
     'type'?: VirtualControllerTypes;
     /**
-     *
+     * Complete JSON configuration of the virtual robot controller. Can be obtained from the physical controller\'s configuration via [getVirtualRobotConfiguration](getVirtualRobotConfiguration). If provided, the `type` field should not be used.
      * @type {string}
      * @memberof VirtualController
      */
@@ -6377,7 +6377,7 @@ export const ControllerApiAxiosParamCreator = function (configuration?: Configur
             };
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -6854,7 +6854,7 @@ export const ControllerApiFp = function(configuration?: Configuration) {
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7059,7 +7059,7 @@ export const ControllerApiFactory = function (configuration?: Configuration, bas
             return localVarFp.getRobotController(cell, controller, options).then((request) => request(axios, basePath));
         },
         /**
-         * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+         * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
          * @summary Virtual Robot Configuration
          * @param {string} cell Unique identifier addressing a cell in all API calls.
          * @param {string} controller Unique identifier to address a controller in the cell.
@@ -7259,7 +7259,7 @@ export class ControllerApi extends BaseAPI {
     }
     /**
-     * Receive the configuration for a virtual robot controller. Used to configure a virtual robot controller via [addRobotController](addRobotController).  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
+     * Receive data to configure a virtual robot controller based on another controller. This can be used to create a virtual clone of a specific physical robot.  When adding a virtual controller, use the Virtual configuration variant of [addRobotController](addRobotController) and pass the content string from this endpoint as the `json` field. Omit the `type` field that selects a preset configuration which is not required when providing a complete configuration.  > **NOTE** > > The output generated by this endpoint can be too large for the site to handle, and may produce an error or incorrect output. > Use `curl` in combination with `> output.json` to capture the output, or use an API client like Postman.
      * @summary Virtual Robot Configuration
      * @param {string} cell Unique identifier addressing a cell in all API calls.
      * @param {string} controller Unique identifier to address a controller in the cell.