@qlik/api 0.0.9 → 0.0.10

package/data-connections.js

@@ -1,60 +1,60 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-connections.ts
-var getDataConnections = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var getDataConnections = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "get",
   pathTemplate: "/api/v1/data-connections",
   query,
   options
 });
-var createDataConnection = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var createDataConnection = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataConnections = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var deleteDataConnections = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/delete",
   body,
   contentType: "application/json",
   options
 });
-var duplicateDataAConnection = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var duplicateDataAConnection = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/duplicate",
   body,
   contentType: "application/json",
   options
 });
-var updateDataConnections = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var updateDataConnections = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "post",
   pathTemplate: "/api/v1/data-connections/actions/update",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataConnection = async (qID, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var deleteDataConnection = async (qID, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "delete",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var getDataConnection = async (qID, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var getDataConnection = async (qID, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "get",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var patchDataConnection = async (qID, query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var patchDataConnection = async (qID, query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "patch",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
@@ -63,7 +63,7 @@ var patchDataConnection = async (qID, query, body, options) => _EL2GSPZZjs.invok
   contentType: "application/json",
   options
 });
-var updateDataConnection = async (qID, query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-connections", {
+var updateDataConnection = async (qID, query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-connections", {
   method: "put",
   pathTemplate: "/api/v1/data-connections/{qID}",
   pathVariables: { qID },
@@ -73,7 +73,7 @@ var updateDataConnection = async (qID, query, body, options) => _EL2GSPZZjs.invo
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "data-connections");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "data-connections");
 }
 var dataConnectionsExport = {
   getDataConnections,

package/data-connections.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-connections.ts

package/data-credentials.d.mts

@@ -2,6 +2,8 @@ import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
 type Credential = {
+    /** ID datasource that the credential is created for */
+    datasourceID?: string;
     links?: Link;
     /** Number of linked connections */
     qConnCount: number;
@@ -14,6 +16,9 @@ type Credential = {
     /** Type of credential */
     qType: string;
 };
+/**
+ * Credential
+ */
 type CredentialCreate = {
     /** ID of connection that will be associated with the credential */
     connectionId?: string;

package/data-credentials.d.ts

@@ -2,6 +2,8 @@ import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
 type Credential = {
+    /** ID datasource that the credential is created for */
+    datasourceID?: string;
     links?: Link;
     /** Number of linked connections */
     qConnCount: number;
@@ -14,6 +16,9 @@ type Credential = {
     /** Type of credential */
     qType: string;
 };
+/**
+ * Credential
+ */
 type CredentialCreate = {
     /** ID of connection that will be associated with the credential */
     connectionId?: string;

package/data-credentials.js

@@ -1,26 +1,26 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-credentials.ts
-var deleteDataCredential = async (qID, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-credentials", {
+var deleteDataCredential = async (qID, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-credentials", {
   method: "delete",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var getDataCredential = async (qID, query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-credentials", {
+var getDataCredential = async (qID, query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-credentials", {
   method: "get",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
   query,
   options
 });
-var patchDataCredential = async (qID, query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-credentials", {
+var patchDataCredential = async (qID, query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-credentials", {
   method: "patch",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
@@ -29,7 +29,7 @@ var patchDataCredential = async (qID, query, body, options) => _EL2GSPZZjs.invok
   contentType: "application/json",
   options
 });
-var updateDataCredential = async (qID, query, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-credentials", {
+var updateDataCredential = async (qID, query, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-credentials", {
   method: "put",
   pathTemplate: "/api/v1/data-credentials/{qID}",
   pathVariables: { qID },
@@ -39,7 +39,7 @@ var updateDataCredential = async (qID, query, body, options) => _EL2GSPZZjs.invo
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "data-credentials");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "data-credentials");
 }
 var dataCredentialsExport = {
   deleteDataCredential,

package/data-credentials.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-credentials.ts

package/data-files.d.mts

@@ -33,10 +33,16 @@ type ConnectionsResponse = {
     /** The type of the connection. */
     type: string;
 };
+/**
+ * Specifies the list of data file change space operations in a single batch.
+ */
 type DataFileBatchChangeSpaceRequest = {
     /** The list of data files to delete. */
     "change-space": BatchChangeSpaceItem[];
 };
+/**
+ * Specifies the list of data files to be deleted in a single batch.
+ */
 type DataFileBatchDeleteRequest = {
     /** The list of data files to delete. */
     delete: BatchDeleteItem[];

package/data-files.d.ts

@@ -33,10 +33,16 @@ type ConnectionsResponse = {
     /** The type of the connection. */
     type: string;
 };
+/**
+ * Specifies the list of data file change space operations in a single batch.
+ */
 type DataFileBatchChangeSpaceRequest = {
     /** The list of data files to delete. */
     "change-space": BatchChangeSpaceItem[];
 };
+/**
+ * Specifies the list of data files to be deleted in a single batch.
+ */
 type DataFileBatchDeleteRequest = {
     /** The list of data files to delete. */
     delete: BatchDeleteItem[];

package/data-files.js

@@ -1,68 +1,68 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/data-files.ts
-var getDataFiles = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var getDataFiles = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files",
   query,
   options
 });
-var uploadDataFile = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var uploadDataFile = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files",
   body,
   contentType: "multipart/form-data",
   options
 });
-var moveDataFiles = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var moveDataFiles = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/actions/change-space",
   body,
   contentType: "application/json",
   options
 });
-var deleteDataFiles = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var deleteDataFiles = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/actions/delete",
   body,
   contentType: "application/json",
   options
 });
-var getDataFilesConnections = async (query, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var getDataFilesConnections = async (query, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/connections",
   query,
   options
 });
-var getDataFileConnection = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var getDataFileConnection = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/connections/{id}",
   pathVariables: { id },
   options
 });
-var getDataFilesQuotas = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var getDataFilesQuotas = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/quotas",
   options
 });
-var deleteDataFile = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var deleteDataFile = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "delete",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
   options
 });
-var getDataFile = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var getDataFile = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "get",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
   options
 });
-var reuploadDataFile = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var reuploadDataFile = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "put",
   pathTemplate: "/api/v1/data-files/{id}",
   pathVariables: { id },
@@ -70,7 +70,7 @@ var reuploadDataFile = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call
   contentType: "multipart/form-data",
   options
 });
-var changeDataFileOwner = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var changeDataFileOwner = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/{id}/actions/change-owner",
   pathVariables: { id },
@@ -78,7 +78,7 @@ var changeDataFileOwner = async (id, body, options) => _EL2GSPZZjs.invokeFetch.c
   contentType: "application/json",
   options
 });
-var moveDataFile = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "data-files", {
+var moveDataFile = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "data-files", {
   method: "post",
   pathTemplate: "/api/v1/data-files/{id}/actions/change-space",
   pathVariables: { id },
@@ -87,7 +87,7 @@ var moveDataFile = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(voi
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "data-files");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "data-files");
 }
 var dataFilesExport = {
   getDataFiles,

package/data-files.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/data-files.ts

package/extensions.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
+ */
 type BundleMeta = {
     /** Description of the bundle. */
     description?: string;
@@ -9,6 +12,9 @@ type BundleMeta = {
     /** Name of the bundle. */
     name?: string;
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
     meta?: Meta;
@@ -19,6 +25,9 @@ type Error = {
     /** Title of the HTTP status code. */
     title: string;
 };
+/**
+ * The extension model.
+ */
 type Extension = {
     /** Author of the extension. */
     author?: string;
@@ -75,6 +84,9 @@ type Extension = {
 type Extensions = {
     data: Extension[];
 };
+/**
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
+ */
 type Meta = {
     /** A more detailed message explaining the error. */
     message?: string;

package/extensions.d.ts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-TzVhFPid.js';
 import './auth-types-nnUcWhuU.js';
 
+/**
+ * Object containing meta data regarding the bundle the extension belongs to. If it does not belong to a bundle, this object is not defined.
+ */
 type BundleMeta = {
     /** Description of the bundle. */
     description?: string;
@@ -9,6 +12,9 @@ type BundleMeta = {
     /** Name of the bundle. */
     name?: string;
 };
+/**
+ * An error object.
+ */
 type Error = {
     /** Object containing meta data regarding an error. It does not necessarily contain all the properties. */
     meta?: Meta;
@@ -19,6 +25,9 @@ type Error = {
     /** Title of the HTTP status code. */
     title: string;
 };
+/**
+ * The extension model.
+ */
 type Extension = {
     /** Author of the extension. */
     author?: string;
@@ -75,6 +84,9 @@ type Extension = {
 type Extensions = {
     data: Extension[];
 };
+/**
+ * Object containing meta data regarding an error. It does not necessarily contain all the properties.
+ */
 type Meta = {
     /** A more detailed message explaining the error. */
     message?: string;

package/extensions.js

@@ -1,36 +1,36 @@
 "use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
-var _EL2GSPZZjs = require('./chunks/EL2GSPZZ.js');
-require('./chunks/W2I5OQA5.js');
+var _QMWU5E4Djs = require('./chunks/QMWU5E4D.js');
+require('./chunks/FG5GDUSZ.js');
 require('./chunks/4HB3TAEO.js');
 
 // src/public/rest/extensions.ts
-var getExtensions = async (options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var getExtensions = async (options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions",
   options
 });
-var uploadExtension = async (body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var uploadExtension = async (body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "post",
   pathTemplate: "/api/v1/extensions",
   body,
   contentType: "multipart/form-data",
   options
 });
-var deleteExtension = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var deleteExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "delete",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
   options
 });
-var getExtension = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var getExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
   options
 });
-var patchExtension = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var patchExtension = async (id, body, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "patch",
   pathTemplate: "/api/v1/extensions/{id}",
   pathVariables: { id },
@@ -38,20 +38,20 @@ var patchExtension = async (id, body, options) => _EL2GSPZZjs.invokeFetch.call(v
   contentType: "multipart/form-data",
   options
 });
-var downloadExtension = async (id, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var downloadExtension = async (id, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}/file",
   pathVariables: { id },
   options
 });
-var downloadFileFromExtension = async (id, filepath, options) => _EL2GSPZZjs.invokeFetch.call(void 0, "extensions", {
+var downloadFileFromExtension = async (id, filepath, options) => _QMWU5E4Djs.invokeFetch.call(void 0, "extensions", {
   method: "get",
   pathTemplate: "/api/v1/extensions/{id}/file/{filepath}",
   pathVariables: { id, filepath },
   options
 });
 function clearCache() {
-  return _EL2GSPZZjs.clearApiCache.call(void 0, "extensions");
+  return _QMWU5E4Djs.clearApiCache.call(void 0, "extensions");
 }
 var extensionsExport = {
   getExtensions,

package/extensions.mjs

@@ -1,8 +1,8 @@
 import {
   clearApiCache,
   invokeFetch
-} from "./chunks/POR3DZIU.mjs";
-import "./chunks/VLLTA4EY.mjs";
+} from "./chunks/HWZC3PIL.mjs";
+import "./chunks/O5POHH2Q.mjs";
 import "./chunks/VSY5YIQY.mjs";
 
 // src/public/rest/extensions.ts

package/glossaries.d.mts

@@ -1,6 +1,9 @@
 import { A as ApiCallOptions } from './global.types-5iFvFJvX.mjs';
 import './auth-types-nnUcWhuU.mjs';
 
+/**
+ * A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
+ */
 type JSONPatch = {
     /** The operation to be performed. */
     op: "replace";
@@ -9,6 +12,9 @@ type JSONPatch = {
     /** The value to be used for this operation. */
     value: string | number;
 };
+/**
+ * An array of JSON Patch documents
+ */
 type JSONPatchArray = JSONPatch[];
 type AtlanEntity = {
     attributes?: AtlanEntityAttributes;
@@ -30,6 +36,9 @@ type AtlanEntityAttributes = {
     usage?: string;
     userDescription?: string;
 };
+/**
+ * Atlan glossary format. See https://apidocs.atlan.com/
+ */
 type AtlanGlossary = {
     entity?: AtlanEntity;
     referredEntities?: AtlanEntity[];
@@ -151,6 +160,28 @@ type ErrorResponse = {
     errors?: ErrorResponseCode[];
     traceId?: string;
 };
+/**
+ * ### Custom error codes
+ * * BG-1 - Context JWT is missing tenantId.
+ * * BG-2 - Context JWT is missing userId.
+ * * BG-4 - Invalid or unsupported Content Type. Valid types are: application/json, application/json+qlik, application/json+atlan, application/json+atlas
+ * * BG-5 - Failed to decode JSON payload.
+ * * BG-6 - A glossary name is required.
+ * * BG-7 - Two categories with the same name cannot have the same parent.
+ * * BG-11 - Glossary validation failed - A value or parameter is invalid or not set
+ * * BG-12 - Category validation failed - A value or parameter is invalid or not set
+ * * BG-13 - Term validation failed - A value or parameter is invalid or not set
+ * * BG-14 - Two or more categories share Id
+ * * BG-15 - Two or more terms share Id
+ * * BG-16 - Not detecting proper Atlas format
+ * * BG-17 - Not detecting proper Atlan format
+ * * BG-18 - Not detecting proper Qlik format
+ * * BG-19 - Invalid format in term
+ * * BG-20 - Duplicate link definition
+ * * BG-21 - Rich text validation failed
+ * * BG-22 - Import cancelled
+ * * BG-23 - Duplicate link related
+ */
 type ErrorResponseBadRequest = {
     errors?: ErrorResponseCode[];
     traceId?: string;
@@ -160,10 +191,20 @@ type ErrorResponseCode = {
     detail?: string;
     title?: string;
 };
+/**
+ * ### Custom error codes
+ * * BG-3 - Access denied, no read access
+ */
 type ErrorResponseForbidden = {
     errors?: ErrorResponseCode[];
     traceId?: string;
 };
+/**
+ * ### Custom error codes
+ * * BG-8 - Glossary not found
+ * * BG-9 - Category not found
+ * * BG-10 - Term not found
+ */
 type ErrorResponseNotFound = {
     errors?: ErrorResponseCode[];
     traceId?: string;
@@ -324,6 +365,9 @@ type Term = {
     /** The uuid of the user who last updated the term */
     readonly updatedBy: string;
 };
+/**
+ * Describes links to other data assets such as analytics applications or dataset.
+ */
 type TermCreateLinksTo = {
     resourceId: string;
     resourceType: "app" | "dataset";
@@ -332,6 +376,9 @@ type TermCreateLinksTo = {
     subResourceType?: "master_dimension" | "master_measure";
     type?: "definition" | "related";
 };
+/**
+ * Describes links to other entities such as qlik charts, dataset columns etc.
+ */
 type TermLinksTo = {
     readonly createdAt?: string;
     createdBy?: string;
@@ -356,6 +403,9 @@ type TermRelatesTo = {
     /** How the term related to the other object */
     type: "isA" | "hasA" | "seeAlso" | "synonym" | "antonym" | "classifies" | "other";
 };
+/**
+ * Terms status is used determine the status of a term
+ */
 type TermStatus = {
     type: "draft" | "verified" | "deprecated";
     /** Time when the state was changed */