Skip to content

Commit

Permalink
chore: spec
Browse files Browse the repository at this point in the history
  • Loading branch information
Caele committed Dec 7, 2022
1 parent 5655075 commit afe4318
Show file tree
Hide file tree
Showing 2 changed files with 179 additions and 179 deletions.
272 changes: 136 additions & 136 deletions apis/stardust/api-spec/spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -1109,115 +1109,6 @@
}
}
},
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "string"
},
{
"type": "EngineAPI.INxDimension"
},
{
"type": "EngineAPI.INxMeasure"
},
{
"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": {
"optional": true,
"type": "string"
},
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"properties": {
"optional": true,
"type": "EngineAPI.IGenericObjectProperties"
}
}
},
"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 @@ -1415,48 +1306,112 @@
}
}
},
"LoadType": {
"kind": "interface",
"params": [
{
"name": "type",
"kind": "object",
"entries": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
],
"returns": {
"type": "Promise",
"generics": [
"Field": {
"kind": "alias",
"items": {
"kind": "union",
"items": [
{
"type": "#/definitions/Visualization"
"type": "string"
},
{
"type": "EngineAPI.INxDimension"
},
{
"type": "EngineAPI.INxMeasure"
},
{
"type": "#/definitions/LibraryField"
}
]
},
"entries": {}
}
},
"TypeInfo": {
"CreateConfig": {
"description": "Rendering configuration for creating and rendering a new object",
"extends": [
{
"type": "#/definitions/BaseConfig"
}
],
"kind": "interface",
"entries": {
"name": {
"type": {
"type": "string"
},
"version": {
"optional": true,
"type": "string"
},
"load": {
"type": "#/definitions/LoadType"
"fields": {
"optional": true,
"kind": "union",
"items": [
{
"kind": "array",
"items": {
"type": "#/definitions/Field"
}
}
]
},
"meta": {
"properties": {
"optional": true,
"type": "EngineAPI.IGenericObjectProperties"
}
}
},
"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'"
}
]
}
}
},
Expand Down Expand Up @@ -1487,6 +1442,51 @@
"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": [
{
"name": "type",
"kind": "object",
"entries": {
"name": {
"type": "string"
},
"version": {
"type": "string"
}
}
}
],
"returns": {
"type": "Promise",
"generics": [
{
"type": "#/definitions/Visualization"
}
]
},
"entries": {}
},
"TypeInfo": {
"kind": "interface",
"entries": {
"name": {
"type": "string"
},
"version": {
"optional": true,
"type": "string"
},
"load": {
"type": "#/definitions/LoadType"
},
"meta": {
"optional": true,
"type": "object"
}
}
},
"ActionToolbarElement": {
"availability": {
"since": "2.1.0"
Expand Down
Loading

0 comments on commit afe4318

Please sign in to comment.