Skip to content

Commit

Permalink
chore: fetch latest specs (#299)
Browse files Browse the repository at this point in the history
* chore: fetch latest specs

* chore: Generating enigma-go based on OPEN-RPC API for Qlik Associative Engine version 12.1595.0

---------

Co-authored-by: alex-almagro <[email protected]>
Co-authored-by: github-actions-bot <[email protected]>
Co-authored-by: Mattias Wennmo <[email protected]>
  • Loading branch information
4 people authored Mar 1, 2023
1 parent e2ed821 commit d62a11a
Show file tree
Hide file tree
Showing 3 changed files with 133 additions and 3 deletions.
54 changes: 54 additions & 0 deletions api-spec.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,20 @@
}
}
},
"AppScriptMeta": {
"x-qlik-stability": "experimental",
"type": "struct",
"entries": {
"IsLocked": {
"description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS.",
"type": "bool"
},
"Meta": {
"description": "Information about publishing and permissions.\nThis parameter is optional.",
"type": "#/definitions/NxMeta"
}
}
},
"ArrayOfNxValuePoint": {
"type": "slice",
"items": {
Expand Down Expand Up @@ -467,6 +481,10 @@
"BookmarkVariableItem": {
"type": "struct",
"entries": {
"Definition": {
"description": "The Reporting mode definition of the variable.",
"type": "string"
},
"Name": {
"description": "Name of the variable.",
"type": "string"
Expand Down Expand Up @@ -4442,6 +4460,42 @@
}
]
},
"GetScriptMeta": {
"description": "Gets script meta-data.",
"x-qlik-stability": "experimental",
"type": "method",
"params": [
{
"type": "https://golang.org/pkg/context/Context"
}
],
"returns": [
{
"type": "#/definitions/AppScriptMeta"
},
{
"type": "error"
}
]
},
"GetScriptMetaRaw": {
"description": "Gets script meta-data.",
"x-qlik-stability": "experimental",
"type": "method",
"params": [
{
"type": "https://golang.org/pkg/context/Context"
}
],
"returns": [
{
"type": "https://golang.org/pkg/encoding/json/RawMessage"
},
{
"type": "error"
}
]
},
"GetSetAnalysis": {
"description": "Returns a set analysis expression from active selections or from a saved bookmark. Fields on the fly and Calculated dimensions will not be included in the generated expressions, instead a message indicating 'missing fields' will provided within the expression.\n | | BookmarkId empty | BookmarkId set |\n |-----------------------|--------------------------------------|----------------------------------------------------|\n |StateName empty (or $) | Default selections state is returned.| Default state ($) in bookmark with id is returned. |\n |StateName set | State selections is returned. | State in bookmark with id is returned. |\n\nParameters:\n\n◾ stateName - Optional. The name of the state to get set analysis expression for. If left empty, the default state will be retrieved.\n\n◾ bookmarkId - Optional. The Id of the bookmark to get the set analysis expression for. If left empty, the current selection will be retrieved.",
"x-qlik-stability": "locked",
Expand Down
35 changes: 33 additions & 2 deletions qix_generated.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

47 changes: 46 additions & 1 deletion schema/engine-rpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"openrpc": "1.0.0",
"info": {
"title": "QIX",
"version": "12.1561.0",
"version": "12.1595.0",
"description": "The JSON-RPC API over websocket that enables you to interact with the Qlik Associative Engine."
},
"methods": [
Expand Down Expand Up @@ -9444,6 +9444,32 @@
],
"x-qlik-stability": "experimental"
},
{
"name": "Doc.GetScriptMeta",
"description": "Gets script meta-data.",
"params": [],
"result": {
"name": "Results for Doc.GetScriptMeta",
"schema": {
"type": "object",
"properties": {
"qMeta": {
"type": "object",
"$ref": "#/components/schemas/AppScriptMeta"
}
}
}
},
"errors": [
{
"$ref": "#/components/errors/GenericErrors"
}
],
"x-qlik-stability": "experimental",
"x-qlik-access-control": [
"read"
]
},
{
"name": "Doc.CommitScript",
"description": "Commits the current script version so that any future changes will be part of a new version.",
Expand Down Expand Up @@ -14404,6 +14430,10 @@
"type": "object",
"description": "Value of the variable.",
"$ref": "#/components/schemas/FieldValue"
},
"qDefinition": {
"type": "string",
"description": "The Reporting mode definition of the variable."
}
}
},
Expand Down Expand Up @@ -21150,6 +21180,21 @@
},
"x-qlik-stability": "experimental"
},
"AppScriptMeta": {
"type": "object",
"properties": {
"qMeta": {
"type": "object",
"description": "Information about publishing and permissions.\nThis parameter is optional.",
"$ref": "#/components/schemas/NxMeta"
},
"qIsLocked": {
"type": "boolean",
"description": "True if user is temporarily locked from modifying the script. Meta contains the ID of the last modifier. Only applicable to QCS."
}
},
"x-qlik-stability": "experimental"
},
"ProgressData": {
"type": "object",
"properties": {
Expand Down

0 comments on commit d62a11a

Please sign in to comment.