chore: tweak spec

qlik-oss · Jan 20, 2021 · 60bb3ab · 60bb3ab
1 parent 734a397
commit 60bb3ab
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 14 deletions.
diff --git a/apis/conversion/src/index.js b/apis/conversion/src/index.js
@@ -84,7 +84,8 @@ export const convertTo = async ({ halo, model, cellRef, newType }) => {
  */
 
 /**
- * @module conversion
+ * @interface
+ * @alias Conversion
  * @experimental
  * @description Provides conversion functionality to extensions
  * @example
@@ -102,7 +103,7 @@ export const convertTo = async ({ halo, model, cellRef, newType }) => {
  * }
  *
  */
-const conversion = /** @lends conversion */ {
+const conversion = {
   /**
    * @type {hyperCubeConversion}
    * @experimental

diff --git a/apis/stardust/api-spec/spec.json b/apis/stardust/api-spec/spec.json
@@ -48,15 +48,6 @@
         }
       }
     },
-    "conversion": {
-      "description": "Provides conversion functionality to extensions",
-      "stability": "experimental",
-      "kind": "module",
-      "entries": {},
-      "examples": [
-        "import { conversion } from '@nebula.js/stardust';\n\nexport default function() {\n  return {\n    qae: {\n      ...\n      importProperties: ( exportFormat, initialProperties ) =>  conversion.hyperCube.importProperties(exportFormat, initialProperties),\n      exportProperties: ( fullPropertyTree ) => conversion.hyperCube.exportProperties(fullPropertyTree)\n    },\n    ...\n  };\n}"
-      ]
-    },
     "onTakeSnapshot": {
       "description": "Registers a callback that is called when a snapshot is taken.",
       "kind": "function",
@@ -578,10 +569,21 @@
         }
       }
     },
-    "conversion.hypercube": {
-      "description": "Provides conversion functionality for extensions with hyperCubes",
+    "Conversion": {
+      "description": "Provides conversion functionality to extensions",
       "stability": "experimental",
-      "type": "#/definitions/hyperCubeConversion"
+      "kind": "interface",
+      "params": [],
+      "entries": {
+        "hypercube": {
+          "description": "Provides conversion functionality for extensions with hyperCubes",
+          "stability": "experimental",
+          "type": "#/definitions/hyperCubeConversion"
+        }
+      },
+      "examples": [
+        "import { conversion } from '@nebula.js/stardust';\n\nexport default function() {\n  return {\n    qae: {\n      ...\n      importProperties: ( exportFormat, initialProperties ) =>  conversion.hyperCube.importProperties(exportFormat, initialProperties),\n      exportProperties: ( fullPropertyTree ) => conversion.hyperCube.exportProperties(fullPropertyTree)\n    },\n    ...\n  };\n}"
+      ]
     },
     "ConversionType": {
       "stability": "experimental",