Skip to content

Commit

Permalink
chore: fix spec to 1.1.0 scriptappy
Browse files Browse the repository at this point in the history
  • Loading branch information
Caele committed Sep 15, 2021
1 parent 37e7044 commit 3f9d991
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 147 deletions.
272 changes: 136 additions & 136 deletions apis/stardust/api-spec/spec.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"scriptappy": "1.0.0",
"scriptappy": "1.1.0",
"info": {
"name": "@nebula.js/stardust",
"description": "Product and framework agnostic integration API for Qlik's Associative Engine",
Expand Down Expand Up @@ -869,6 +869,114 @@
}
}
},
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "string"
},
{
"type": "qae.NxDimension"
},
{
"type": "qae.NxMeasure"
},
{
"type": "#/definitions/LibraryField"
}
]
}
},
"CreateConfig": {
"description": "Rendering configuration for creating and rendering a new object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"properties": {
"optional": true,
"type": "qae.GenericObjectProperties"
}
}
},
"BaseConfig": {
"description": "Basic rendering configuration for rendering an object",
"kind": "interface",
"entries": {
"element": {
"type": "HTMLElement"
},
"options": {
"optional": true,
"type": "object"
},
"plugins": {
"optional": true,
"kind": "array",
"items": {
"type": "#/definitions/Plugin"
}
}
}
},
"GetConfig": {
"description": "Rendering configuration for rendering an existing object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"id": {
"type": "string"
}
}
},
"LibraryField": {
"kind": "interface",
"entries": {
"qLibraryId": {
"type": "string"
},
"type": {
"kind": "union",
"items": [
{
"kind": "literal",
"value": "'dimension'"
},
{
"kind": "literal",
"value": "'measure'"
}
]
}
}
},
"AppSelections": {
"kind": "class",
"constructor": {
Expand Down Expand Up @@ -1062,141 +1170,6 @@
}
}
},
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "string"
},
{
"type": "qae.NxDimension"
},
{
"type": "qae.NxMeasure"
},
{
"type": "#/definitions/LibraryField"
}
]
}
},
"CreateConfig": {
"description": "Rendering configuration for creating and rendering a new object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"type": {
"type": "string"
},
"version": {
"type": "string"
},
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"properties": {
"optional": true,
"type": "qae.GenericObjectProperties"
}
}
},
"BaseConfig": {
"description": "Basic rendering configuration for rendering an object",
"kind": "interface",
"entries": {
"element": {
"type": "HTMLElement"
},
"options": {
"optional": true,
"type": "object"
},
"plugins": {
"optional": true,
"kind": "array",
"items": {
"type": "#/definitions/Plugin"
}
}
}
},
"GetConfig": {
"description": "Rendering configuration for rendering an existing object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"id": {
"type": "string"
}
}
},
"LibraryField": {
"kind": "interface",
"entries": {
"qLibraryId": {
"type": "string"
},
"type": {
"kind": "union",
"items": [
{
"kind": "literal",
"value": "'dimension'"
},
{
"kind": "literal",
"value": "'measure'"
}
]
}
}
},
"Plugin": {
"description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
"stability": "experimental",
"availability": {
"since": "1.2.0"
},
"kind": "interface",
"entries": {
"info": {
"description": "Object that can hold various meta info about the plugin",
"kind": "object",
"entries": {
"name": {
"description": "The name of the plugin",
"type": "string"
}
}
},
"fn": {
"description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
"type": "function"
}
},
"examples": [
"const plugin = {\n info: {\n name: \"example-plugin\",\n type: \"meta-type\",\n },\n fn: () => {\n // Plugin implementation goes here\n }\n};"
]
},
"LoadType": {
"kind": "interface",
"params": [
Expand Down Expand Up @@ -1241,6 +1214,33 @@
}
}
},
"Plugin": {
"description": "An object literal containing meta information about the plugin and a function containing the plugin implementation.",
"stability": "experimental",
"availability": {
"since": "1.2.0"
},
"kind": "interface",
"entries": {
"info": {
"description": "Object that can hold various meta info about the plugin",
"kind": "object",
"entries": {
"name": {
"description": "The name of the plugin",
"type": "string"
}
}
},
"fn": {
"description": "The implementation of the plugin. Input and return value is up to the plugin implementation to decide based on its purpose.",
"type": "function"
}
},
"examples": [
"const plugin = {\n info: {\n name: \"example-plugin\",\n type: \"meta-type\",\n },\n fn: () => {\n // Plugin implementation goes here\n }\n};"
]
},
"ActionElement": {
"extends": [
{
Expand Down
11 changes: 0 additions & 11 deletions apis/stardust/scriptappy.json

This file was deleted.

0 comments on commit 3f9d991

Please sign in to comment.