diff --git a/libs/api-client-tiger/api/api-client-tiger.api.md b/libs/api-client-tiger/api/api-client-tiger.api.md index 4f7a2fa375e..e27c77b6965 100644 --- a/libs/api-client-tiger/api/api-client-tiger.api.md +++ b/libs/api-client-tiger/api/api-client-tiger.api.md @@ -70,6 +70,22 @@ export interface ActionsApiAnalyzeCsvRequest { readonly dataSourceId: string; } +// @public +export interface ActionsApiAnomalyDetectionRequest { + readonly anomalyDetectionRequest: AnomalyDetectionRequest; + readonly resultId: string; + readonly skipCache?: boolean; + readonly workspaceId: string; +} + +// @public +export interface ActionsApiAnomalyDetectionResultRequest { + readonly limit?: number; + readonly offset?: number; + readonly resultId: string; + readonly workspaceId: string; +} + // @public export interface ActionsApiAvailableAssigneesRequest { readonly dashboardId: string; @@ -187,6 +203,12 @@ export interface ActionsApiDashboardPermissionsRequest { readonly workspaceId: string; } +// @public +export interface ActionsApiDeleteFilesRequest { + readonly dataSourceId: string; + readonly deleteFilesRequest: DeleteFilesRequest; +} + // @public export interface ActionsApiExplainAFMRequest { readonly afmExecution: AfmExecution; @@ -479,6 +501,12 @@ export interface ActionsApiSetTranslationsRequest { readonly xliff: Xliff; } +// @public +export interface ActionsApiStagingUploadRequest { + readonly dataSourceId: string; + readonly file: any; +} + // @public export interface ActionsApiTestDataSourceDefinitionRequest { readonly testDefinitionRequest: TestDefinitionRequest; @@ -521,6 +549,8 @@ export interface AFM { // @public export class AfmActionsApi extends LabelElementsBaseApi implements AfmActionsApiInterface { + anomalyDetection(requestParameters: ActionsApiAnomalyDetectionRequest, options?: AxiosRequestConfig): Promise>; + anomalyDetectionResult(requestParameters: ActionsApiAnomalyDetectionResultRequest, options?: AxiosRequestConfig): Promise>; clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): Promise>; clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): Promise>; computeLabelElementsPost(requestParameters: ActionsApiComputeLabelElementsPostRequest, options?: AxiosRequestConfig): Promise>; @@ -538,6 +568,8 @@ export class AfmActionsApi extends LabelElementsBaseApi implements AfmActionsApi // @public export const AfmActionsApiAxiosParamCreator: (configuration?: LabelElementsConfiguration) => { + anomalyDetection: (workspaceId: string, resultId: string, anomalyDetectionRequest: AnomalyDetectionRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise; + anomalyDetectionResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise; clustering: (workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig) => Promise; clusteringResult: (workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig) => Promise; computeLabelElementsPost: (workspaceId: string, elementsRequest: ElementsRequest, offset?: number, limit?: number, skipCache?: boolean, options?: AxiosRequestConfig) => Promise; @@ -555,6 +587,8 @@ export const AfmActionsApiAxiosParamCreator: (configuration?: LabelElementsConfi // @public export const AfmActionsApiFactory: (configuration?: LabelElementsConfiguration, basePath?: string, axios?: AxiosInstance) => { + anomalyDetection(requestParameters: ActionsApiAnomalyDetectionRequest, options?: AxiosRequestConfig): AxiosPromise; + anomalyDetectionResult(requestParameters: ActionsApiAnomalyDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise; clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise; clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise; computeLabelElementsPost(requestParameters: ActionsApiComputeLabelElementsPostRequest, options?: AxiosRequestConfig): AxiosPromise; @@ -572,6 +606,8 @@ export const AfmActionsApiFactory: (configuration?: LabelElementsConfiguration, // @public export const AfmActionsApiFp: (configuration?: LabelElementsConfiguration) => { + anomalyDetection(workspaceId: string, resultId: string, anomalyDetectionRequest: AnomalyDetectionRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; + anomalyDetectionResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; clustering(workspaceId: string, resultId: string, clusteringRequest: ClusteringRequest, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; clusteringResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; computeLabelElementsPost(workspaceId: string, elementsRequest: ElementsRequest, offset?: number, limit?: number, skipCache?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; @@ -589,6 +625,8 @@ export const AfmActionsApiFp: (configuration?: LabelElementsConfiguration) => { // @public export interface AfmActionsApiInterface { + anomalyDetection(requestParameters: ActionsApiAnomalyDetectionRequest, options?: AxiosRequestConfig): AxiosPromise; + anomalyDetectionResult(requestParameters: ActionsApiAnomalyDetectionResultRequest, options?: AxiosRequestConfig): AxiosPromise; clustering(requestParameters: ActionsApiClusteringRequest, options?: AxiosRequestConfig): AxiosPromise; clusteringResult(requestParameters: ActionsApiClusteringResultRequest, options?: AxiosRequestConfig): AxiosPromise; computeLabelElementsPost(requestParameters: ActionsApiComputeLabelElementsPostRequest, options?: AxiosRequestConfig): AxiosPromise; @@ -872,6 +910,18 @@ export interface AnalyzeCsvResponseConfig { readOptions?: CsvReadOptions; } +// @public +export interface AnomalyDetectionRequest { + sensitivity: number; +} + +// @public +export interface AnomalyDetectionResult { + anomalyFlag: Array; + attribute: Array; + values: Array; +} + // @public export interface ApiEntitlement { expiry?: string; @@ -896,7 +946,6 @@ export const ApiEntitlementNameEnum: { readonly WHITE_LABELING: "WhiteLabeling"; readonly WORKSPACE_COUNT: "WorkspaceCount"; readonly USER_TELEMETRY_DISABLED: "UserTelemetryDisabled"; - readonly EXPERIMENTAL_FEATURES: "ExperimentalFeatures"; }; // @public (undocumented) @@ -3270,6 +3319,7 @@ export const DeclarativeSettingTypeEnum: { readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS"; readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES"; readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED"; + readonly OPENAI_CONFIG: "OPENAI_CONFIG"; }; // @public (undocumented) @@ -3565,6 +3615,11 @@ export interface DeclarativeWorkspaces { const defaultTigerClient: ITigerClient; export default defaultTigerClient; +// @public +export interface DeleteFilesRequest { + fileNames: Array; +} + // @public export class DependencyGraphApi extends MetadataBaseApi implements DependencyGraphApiInterface { getDependentEntitiesGraph(requestParameters: DependencyGraphApiGetDependentEntitiesGraphRequest, options?: AxiosRequestConfig): Promise>; @@ -5929,7 +5984,6 @@ export const EntitlementsRequestEntitlementsNameEnum: { readonly WHITE_LABELING: "WhiteLabeling"; readonly WORKSPACE_COUNT: "WorkspaceCount"; readonly USER_TELEMETRY_DISABLED: "UserTelemetryDisabled"; - readonly EXPERIMENTAL_FEATURES: "ExperimentalFeatures"; }; // @public (undocumented) @@ -6891,7 +6945,7 @@ export interface JsonApiAnalyticalDashboardOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -7109,12 +7163,7 @@ export interface JsonApiApiTokenOutDocument { export interface JsonApiApiTokenOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; -} - -// @public -export interface JsonApiApiTokenOutListMeta { - page?: PageMetadata; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -7219,7 +7268,7 @@ export interface JsonApiAttributeHierarchyOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -7381,7 +7430,7 @@ export interface JsonApiAttributeOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -7479,7 +7528,12 @@ export interface JsonApiColorPaletteOutDocument { export interface JsonApiColorPaletteOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; +} + +// @public +export interface JsonApiColorPaletteOutListMeta { + page?: PageMetadata; } // @public (undocumented) @@ -7534,7 +7588,7 @@ export type JsonApiColorPalettePatchTypeEnum = typeof JsonApiColorPalettePatchTy // @public export interface JsonApiCookieSecurityConfigurationIn { - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; id: string; type: JsonApiCookieSecurityConfigurationInTypeEnum; } @@ -7554,11 +7608,17 @@ export type JsonApiCookieSecurityConfigurationInTypeEnum = typeof JsonApiCookieS // @public export interface JsonApiCookieSecurityConfigurationOut { - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; id: string; type: JsonApiCookieSecurityConfigurationOutTypeEnum; } +// @public +export interface JsonApiCookieSecurityConfigurationOutAttributes { + lastRotation?: string; + rotationInterval?: string; +} + // @public export interface JsonApiCookieSecurityConfigurationOutDocument { data: JsonApiCookieSecurityConfigurationOut; @@ -7575,17 +7635,11 @@ export type JsonApiCookieSecurityConfigurationOutTypeEnum = typeof JsonApiCookie // @public export interface JsonApiCookieSecurityConfigurationPatch { - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; id: string; type: JsonApiCookieSecurityConfigurationPatchTypeEnum; } -// @public -export interface JsonApiCookieSecurityConfigurationPatchAttributes { - lastRotation?: string; - rotationInterval?: string; -} - // @public export interface JsonApiCookieSecurityConfigurationPatchDocument { data: JsonApiCookieSecurityConfigurationPatch; @@ -7641,7 +7695,7 @@ export interface JsonApiCspDirectiveOutDocument { export interface JsonApiCspDirectiveOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -7731,7 +7785,7 @@ export interface JsonApiCustomApplicationSettingOutDocument { export interface JsonApiCustomApplicationSettingOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -7877,7 +7931,7 @@ export interface JsonApiDashboardPluginOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8109,7 +8163,7 @@ export interface JsonApiDatasetOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8205,7 +8259,7 @@ export interface JsonApiDataSourceIdentifierOutDocument { export interface JsonApiDataSourceIdentifierOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -8370,7 +8424,7 @@ export interface JsonApiDataSourceOutDocument { export interface JsonApiDataSourceOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8511,7 +8565,7 @@ export interface JsonApiEntitlementOutDocument { export interface JsonApiEntitlementOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -8593,7 +8647,7 @@ export interface JsonApiExportDefinitionOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8757,7 +8811,7 @@ export interface JsonApiFactOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8849,7 +8903,7 @@ export interface JsonApiFilterContextOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -8968,7 +9022,7 @@ export interface JsonApiJwkOutDocument { export interface JsonApiJwkOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -9094,7 +9148,7 @@ export interface JsonApiLabelOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -9205,7 +9259,7 @@ export interface JsonApiMetricOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -9316,11 +9370,25 @@ export type JsonApiMetricPostOptionalIdTypeEnum = typeof JsonApiMetricPostOption // @public export interface JsonApiOrganizationIn { - attributes?: JsonApiOrganizationPatchAttributes; + attributes?: JsonApiOrganizationInAttributes; id: string; type: JsonApiOrganizationInTypeEnum; } +// @public +export interface JsonApiOrganizationInAttributes { + allowedOrigins?: Array; + earlyAccess?: string; + hostname?: string; + jitEnabled?: boolean; + name?: string; + oauthClientId?: string; + oauthClientSecret?: string; + oauthIssuerId?: string; + oauthIssuerLocation?: string; + oauthSubjectIdClaim?: string; +} + // @public export interface JsonApiOrganizationInDocument { data: JsonApiOrganizationIn; @@ -9422,25 +9490,11 @@ export type JsonApiOrganizationOutTypeEnum = typeof JsonApiOrganizationOutTypeEn // @public export interface JsonApiOrganizationPatch { - attributes?: JsonApiOrganizationPatchAttributes; + attributes?: JsonApiOrganizationInAttributes; id: string; type: JsonApiOrganizationPatchTypeEnum; } -// @public -export interface JsonApiOrganizationPatchAttributes { - allowedOrigins?: Array; - earlyAccess?: string; - hostname?: string; - jitEnabled?: boolean; - name?: string; - oauthClientId?: string; - oauthClientSecret?: string; - oauthIssuerId?: string; - oauthIssuerLocation?: string; - oauthSubjectIdClaim?: string; -} - // @public export interface JsonApiOrganizationPatchDocument { data: JsonApiOrganizationPatch; @@ -9456,7 +9510,7 @@ export type JsonApiOrganizationPatchTypeEnum = typeof JsonApiOrganizationPatchTy // @public export interface JsonApiOrganizationSettingIn { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiOrganizationSettingInTypeEnum; } @@ -9476,7 +9530,7 @@ export type JsonApiOrganizationSettingInTypeEnum = typeof JsonApiOrganizationSet // @public export interface JsonApiOrganizationSettingOut { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiOrganizationSettingOutTypeEnum; } @@ -9491,7 +9545,7 @@ export interface JsonApiOrganizationSettingOutDocument { export interface JsonApiOrganizationSettingOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -9504,7 +9558,7 @@ export type JsonApiOrganizationSettingOutTypeEnum = typeof JsonApiOrganizationSe // @public export interface JsonApiOrganizationSettingOutWithLinks { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; links?: ObjectLinks; type: JsonApiOrganizationSettingOutWithLinksTypeEnum; @@ -9520,11 +9574,37 @@ export type JsonApiOrganizationSettingOutWithLinksTypeEnum = typeof JsonApiOrgan // @public export interface JsonApiOrganizationSettingPatch { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiOrganizationSettingPatchTypeEnum; } +// @public +export interface JsonApiOrganizationSettingPatchAttributes { + content?: object; + type?: JsonApiOrganizationSettingPatchAttributesTypeEnum; +} + +// @public (undocumented) +export const JsonApiOrganizationSettingPatchAttributesTypeEnum: { + readonly TIMEZONE: "TIMEZONE"; + readonly ACTIVE_THEME: "ACTIVE_THEME"; + readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE"; + readonly WHITE_LABELING: "WHITE_LABELING"; + readonly LOCALE: "LOCALE"; + readonly METADATA_LOCALE: "METADATA_LOCALE"; + readonly FORMAT_LOCALE: "FORMAT_LOCALE"; + readonly MAPBOX_TOKEN: "MAPBOX_TOKEN"; + readonly WEEK_START: "WEEK_START"; + readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS"; + readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES"; + readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED"; + readonly OPENAI_CONFIG: "OPENAI_CONFIG"; +}; + +// @public (undocumented) +export type JsonApiOrganizationSettingPatchAttributesTypeEnum = typeof JsonApiOrganizationSettingPatchAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingPatchAttributesTypeEnum]; + // @public export interface JsonApiOrganizationSettingPatchDocument { data: JsonApiOrganizationSettingPatch; @@ -9575,7 +9655,7 @@ export interface JsonApiThemeOutDocument { export interface JsonApiThemeOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -9667,7 +9747,7 @@ export interface JsonApiUserDataFilterOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -9828,7 +9908,7 @@ export interface JsonApiUserGroupOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -9933,7 +10013,7 @@ export interface JsonApiUserIdentifierOutDocument { export interface JsonApiUserIdentifierOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10018,7 +10098,7 @@ export interface JsonApiUserOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10082,36 +10162,11 @@ export type JsonApiUserPatchTypeEnum = typeof JsonApiUserPatchTypeEnum[keyof typ // @public export interface JsonApiUserSettingIn { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiUserSettingInTypeEnum; } -// @public -export interface JsonApiUserSettingInAttributes { - content?: object; - type?: JsonApiUserSettingInAttributesTypeEnum; -} - -// @public (undocumented) -export const JsonApiUserSettingInAttributesTypeEnum: { - readonly TIMEZONE: "TIMEZONE"; - readonly ACTIVE_THEME: "ACTIVE_THEME"; - readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE"; - readonly WHITE_LABELING: "WHITE_LABELING"; - readonly LOCALE: "LOCALE"; - readonly METADATA_LOCALE: "METADATA_LOCALE"; - readonly FORMAT_LOCALE: "FORMAT_LOCALE"; - readonly MAPBOX_TOKEN: "MAPBOX_TOKEN"; - readonly WEEK_START: "WEEK_START"; - readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS"; - readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES"; - readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED"; -}; - -// @public (undocumented) -export type JsonApiUserSettingInAttributesTypeEnum = typeof JsonApiUserSettingInAttributesTypeEnum[keyof typeof JsonApiUserSettingInAttributesTypeEnum]; - // @public export interface JsonApiUserSettingInDocument { data: JsonApiUserSettingIn; @@ -10127,7 +10182,7 @@ export type JsonApiUserSettingInTypeEnum = typeof JsonApiUserSettingInTypeEnum[k // @public export interface JsonApiUserSettingOut { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiUserSettingOutTypeEnum; } @@ -10142,7 +10197,7 @@ export interface JsonApiUserSettingOutDocument { export interface JsonApiUserSettingOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10155,7 +10210,7 @@ export type JsonApiUserSettingOutTypeEnum = typeof JsonApiUserSettingOutTypeEnum // @public export interface JsonApiUserSettingOutWithLinks { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; links?: ObjectLinks; type: JsonApiUserSettingOutWithLinksTypeEnum; @@ -10227,7 +10282,7 @@ export interface JsonApiVisualizationObjectOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10372,7 +10427,7 @@ export interface JsonApiWorkspaceDataFilterOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10495,7 +10550,7 @@ export interface JsonApiWorkspaceDataFilterSettingOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10604,7 +10659,7 @@ export interface JsonApiWorkspaceOutList { data: Array; included?: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public @@ -10720,7 +10775,7 @@ export type JsonApiWorkspacePatchTypeEnum = typeof JsonApiWorkspacePatchTypeEnum // @public export interface JsonApiWorkspaceSettingIn { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiWorkspaceSettingInTypeEnum; } @@ -10740,7 +10795,7 @@ export type JsonApiWorkspaceSettingInTypeEnum = typeof JsonApiWorkspaceSettingIn // @public export interface JsonApiWorkspaceSettingOut { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; meta?: JsonApiAttributeHierarchyOutMeta; type: JsonApiWorkspaceSettingOutTypeEnum; @@ -10756,7 +10811,7 @@ export interface JsonApiWorkspaceSettingOutDocument { export interface JsonApiWorkspaceSettingOutList { data: Array; links?: ListLinks; - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } // @public (undocumented) @@ -10769,7 +10824,7 @@ export type JsonApiWorkspaceSettingOutTypeEnum = typeof JsonApiWorkspaceSettingO // @public export interface JsonApiWorkspaceSettingOutWithLinks { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; links?: ObjectLinks; meta?: JsonApiAttributeHierarchyOutMeta; @@ -10786,7 +10841,7 @@ export type JsonApiWorkspaceSettingOutWithLinksTypeEnum = typeof JsonApiWorkspac // @public export interface JsonApiWorkspaceSettingPatch { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id: string; type: JsonApiWorkspaceSettingPatchTypeEnum; } @@ -10806,7 +10861,7 @@ export type JsonApiWorkspaceSettingPatchTypeEnum = typeof JsonApiWorkspaceSettin // @public export interface JsonApiWorkspaceSettingPostOptionalId { - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; id?: string; type: JsonApiWorkspaceSettingPostOptionalIdTypeEnum; } @@ -13556,6 +13611,7 @@ export const ResolvedSettingTypeEnum: { readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS"; readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES"; readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED"; + readonly OPENAI_CONFIG: "OPENAI_CONFIG"; }; // @public (undocumented) @@ -13576,9 +13632,11 @@ export interface RestApiIdentifier { export interface ResultActionsApiInterface { analyzeCsv(requestParameters: ActionsApiAnalyzeCsvRequest, options?: AxiosRequestConfig): AxiosPromise>; collectCacheUsage(options?: AxiosRequestConfig): AxiosPromise; + deleteFiles(requestParameters: ActionsApiDeleteFilesRequest, options?: AxiosRequestConfig): AxiosPromise; getStagingUploadLocation(requestParameters: ActionsApiGetStagingUploadLocationRequest, options?: AxiosRequestConfig): AxiosPromise; importCsv(requestParameters: ActionsApiImportCsvRequest, options?: AxiosRequestConfig): AxiosPromise; listFiles(requestParameters: ActionsApiListFilesRequest, options?: AxiosRequestConfig): AxiosPromise>; + stagingUpload(requestParameters: ActionsApiStagingUploadRequest, options?: AxiosRequestConfig): AxiosPromise; } // @public @@ -14203,6 +14261,11 @@ export interface TranslationsApiSetTranslationsRequest { readonly xliff: Xliff; } +// @public +export interface UploadFileResponse { + location: string; +} + // @public export class UsageApi extends MetadataBaseApi implements UsageApiInterface { allPlatformUsage(options?: AxiosRequestConfig): Promise>; diff --git a/libs/api-client-tiger/src/generated/afm-rest-api/api.ts b/libs/api-client-tiger/src/generated/afm-rest-api/api.ts index 11de1d3e82a..db0f6e7b8bf 100644 --- a/libs/api-client-tiger/src/generated/afm-rest-api/api.ts +++ b/libs/api-client-tiger/src/generated/afm-rest-api/api.ts @@ -445,6 +445,44 @@ export interface AfmValidObjectsResponse { */ items: Array; } +/** + * + * @export + * @interface AnomalyDetectionRequest + */ +export interface AnomalyDetectionRequest { + /** + * Anomaly detection sensitivity. + * @type {number} + * @memberof AnomalyDetectionRequest + */ + sensitivity: number; +} +/** + * + * @export + * @interface AnomalyDetectionResult + */ +export interface AnomalyDetectionResult { + /** + * + * @type {Array} + * @memberof AnomalyDetectionResult + */ + attribute: Array; + /** + * + * @type {Array} + * @memberof AnomalyDetectionResult + */ + values: Array; + /** + * + * @type {Array} + * @memberof AnomalyDetectionResult + */ + anomalyFlag: Array; +} /** * Metric representing arithmetics between metrics. * @export @@ -740,13 +778,13 @@ export interface ClusteringResult { * @type {Array} * @memberof ClusteringResult */ - xcoord: Array; + ycoord: Array; /** * * @type {Array} * @memberof ClusteringResult */ - ycoord: Array; + xcoord: Array; } /** * Filter the result by comparing specified metric to given constant value, using given comparison operator. @@ -2520,6 +2558,124 @@ export interface ValidateByItem { */ export const ActionsApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Input result ID to be used in the computation + * @param {AnomalyDetectionRequest} anomalyDetectionRequest + * @param {boolean} [skipCache] Ignore all caches during execution of current request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetection: async ( + workspaceId: string, + resultId: string, + anomalyDetectionRequest: AnomalyDetectionRequest, + skipCache?: boolean, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'workspaceId' is not null or undefined + assertParamExists("anomalyDetection", "workspaceId", workspaceId); + // verify required parameter 'resultId' is not null or undefined + assertParamExists("anomalyDetection", "resultId", resultId); + // verify required parameter 'anomalyDetectionRequest' is not null or undefined + assertParamExists("anomalyDetection", "anomalyDetectionRequest", anomalyDetectionRequest); + const localVarPath = + `/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}` + .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId))) + .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (skipCache !== undefined && skipCache !== null) { + localVarHeaderParameter["skip-cache"] = String(JSON.stringify(skipCache)); + } + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + const needsSerialization = + typeof anomalyDetectionRequest !== "string" || + localVarRequestOptions.headers["Content-Type"] === "application/json"; + localVarRequestOptions.data = needsSerialization + ? JSON.stringify(anomalyDetectionRequest !== undefined ? anomalyDetectionRequest : {}) + : anomalyDetectionRequest || ""; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Result ID + * @param {number} [offset] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetectionResult: async ( + workspaceId: string, + resultId: string, + offset?: number, + limit?: number, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'workspaceId' is not null or undefined + assertParamExists("anomalyDetectionResult", "workspaceId", workspaceId); + // verify required parameter 'resultId' is not null or undefined + assertParamExists("anomalyDetectionResult", "resultId", resultId); + const localVarPath = + `/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}` + .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId))) + .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -3302,6 +3458,58 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati export const ActionsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = ActionsApiAxiosParamCreator(configuration); return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Input result ID to be used in the computation + * @param {AnomalyDetectionRequest} anomalyDetectionRequest + * @param {boolean} [skipCache] Ignore all caches during execution of current request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async anomalyDetection( + workspaceId: string, + resultId: string, + anomalyDetectionRequest: AnomalyDetectionRequest, + skipCache?: boolean, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.anomalyDetection( + workspaceId, + resultId, + anomalyDetectionRequest, + skipCache, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Result ID + * @param {number} [offset] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async anomalyDetectionResult( + workspaceId: string, + resultId: string, + offset?: number, + limit?: number, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.anomalyDetectionResult( + workspaceId, + resultId, + offset, + limit, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -3646,6 +3854,48 @@ export const ActionsApiFactory = function ( ) { const localVarFp = ActionsApiFp(configuration); return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetection( + requestParameters: ActionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .anomalyDetection( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.anomalyDetectionRequest, + requestParameters.skipCache, + options, + ) + .then((request) => request(axios, basePath)); + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetectionResult( + requestParameters: ActionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .anomalyDetectionResult( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.offset, + requestParameters.limit, + options, + ) + .then((request) => request(axios, basePath)); + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -3918,6 +4168,32 @@ export const ActionsApiFactory = function ( * @interface ActionsApi */ export interface ActionsApiInterface { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApiInterface + */ + anomalyDetection( + requestParameters: ActionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; + + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApiInterface + */ + anomalyDetectionResult( + requestParameters: ActionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; + /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -4089,108 +4365,178 @@ export interface ActionsApiInterface { } /** - * Request parameters for clustering operation in ActionsApi. + * Request parameters for anomalyDetection operation in ActionsApi. * @export - * @interface ActionsApiClusteringRequest + * @interface ActionsApiAnomalyDetectionRequest */ -export interface ActionsApiClusteringRequest { +export interface ActionsApiAnomalyDetectionRequest { /** * Workspace identifier * @type {string} - * @memberof ActionsApiClustering + * @memberof ActionsApiAnomalyDetection */ readonly workspaceId: string; /** * Input result ID to be used in the computation * @type {string} - * @memberof ActionsApiClustering + * @memberof ActionsApiAnomalyDetection */ readonly resultId: string; /** * - * @type {ClusteringRequest} - * @memberof ActionsApiClustering + * @type {AnomalyDetectionRequest} + * @memberof ActionsApiAnomalyDetection */ - readonly clusteringRequest: ClusteringRequest; + readonly anomalyDetectionRequest: AnomalyDetectionRequest; /** * Ignore all caches during execution of current request. * @type {boolean} - * @memberof ActionsApiClustering + * @memberof ActionsApiAnomalyDetection */ readonly skipCache?: boolean; } /** - * Request parameters for clusteringResult operation in ActionsApi. + * Request parameters for anomalyDetectionResult operation in ActionsApi. * @export - * @interface ActionsApiClusteringResultRequest + * @interface ActionsApiAnomalyDetectionResultRequest */ -export interface ActionsApiClusteringResultRequest { +export interface ActionsApiAnomalyDetectionResultRequest { /** * Workspace identifier * @type {string} - * @memberof ActionsApiClusteringResult + * @memberof ActionsApiAnomalyDetectionResult */ readonly workspaceId: string; /** * Result ID * @type {string} - * @memberof ActionsApiClusteringResult + * @memberof ActionsApiAnomalyDetectionResult */ readonly resultId: string; /** * * @type {number} - * @memberof ActionsApiClusteringResult + * @memberof ActionsApiAnomalyDetectionResult */ readonly offset?: number; /** * * @type {number} - * @memberof ActionsApiClusteringResult + * @memberof ActionsApiAnomalyDetectionResult */ readonly limit?: number; } /** - * Request parameters for computeLabelElementsPost operation in ActionsApi. + * Request parameters for clustering operation in ActionsApi. * @export - * @interface ActionsApiComputeLabelElementsPostRequest + * @interface ActionsApiClusteringRequest */ -export interface ActionsApiComputeLabelElementsPostRequest { +export interface ActionsApiClusteringRequest { /** * Workspace identifier * @type {string} - * @memberof ActionsApiComputeLabelElementsPost + * @memberof ActionsApiClustering */ readonly workspaceId: string; /** - * - * @type {ElementsRequest} - * @memberof ActionsApiComputeLabelElementsPost + * Input result ID to be used in the computation + * @type {string} + * @memberof ActionsApiClustering */ - readonly elementsRequest: ElementsRequest; + readonly resultId: string; /** - * Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. - * @type {number} - * @memberof ActionsApiComputeLabelElementsPost + * + * @type {ClusteringRequest} + * @memberof ActionsApiClustering */ - readonly offset?: number; + readonly clusteringRequest: ClusteringRequest; /** - * Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. - * @type {number} - * @memberof ActionsApiComputeLabelElementsPost - */ - readonly limit?: number; + * Ignore all caches during execution of current request. + * @type {boolean} + * @memberof ActionsApiClustering + */ + readonly skipCache?: boolean; +} + +/** + * Request parameters for clusteringResult operation in ActionsApi. + * @export + * @interface ActionsApiClusteringResultRequest + */ +export interface ActionsApiClusteringResultRequest { + /** + * Workspace identifier + * @type {string} + * @memberof ActionsApiClusteringResult + */ + readonly workspaceId: string; + + /** + * Result ID + * @type {string} + * @memberof ActionsApiClusteringResult + */ + readonly resultId: string; + + /** + * + * @type {number} + * @memberof ActionsApiClusteringResult + */ + readonly offset?: number; + + /** + * + * @type {number} + * @memberof ActionsApiClusteringResult + */ + readonly limit?: number; +} + +/** + * Request parameters for computeLabelElementsPost operation in ActionsApi. + * @export + * @interface ActionsApiComputeLabelElementsPostRequest + */ +export interface ActionsApiComputeLabelElementsPostRequest { + /** + * Workspace identifier + * @type {string} + * @memberof ActionsApiComputeLabelElementsPost + */ + readonly workspaceId: string; + + /** + * + * @type {ElementsRequest} + * @memberof ActionsApiComputeLabelElementsPost + */ + readonly elementsRequest: ElementsRequest; + + /** + * Request page with this offset. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + * @type {number} + * @memberof ActionsApiComputeLabelElementsPost + */ + readonly offset?: number; + + /** + * Return only this number of items. Must be positive integer. The API is limited to the maximum of 10000 items. Therefore this parameter is limited to this number as well. + * @type {number} + * @memberof ActionsApiComputeLabelElementsPost + */ + readonly limit?: number; /** * Ignore all caches during execution of current request. @@ -4518,6 +4864,52 @@ export interface ActionsApiRetrieveResultRequest { * @extends {BaseAPI} */ export class ActionsApi extends BaseAPI implements ActionsApiInterface { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {ActionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApi + */ + public anomalyDetection( + requestParameters: ActionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ) { + return ActionsApiFp(this.configuration) + .anomalyDetection( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.anomalyDetectionRequest, + requestParameters.skipCache, + options, + ) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {ActionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApi + */ + public anomalyDetectionResult( + requestParameters: ActionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ) { + return ActionsApiFp(this.configuration) + .anomalyDetectionResult( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.offset, + requestParameters.limit, + options, + ) + .then((request) => request(this.axios, this.basePath)); + } + /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -6379,6 +6771,124 @@ export class ComputationApi extends BaseAPI implements ComputationApiInterface { */ export const SmartFunctionsApiAxiosParamCreator = function (configuration?: Configuration) { return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Input result ID to be used in the computation + * @param {AnomalyDetectionRequest} anomalyDetectionRequest + * @param {boolean} [skipCache] Ignore all caches during execution of current request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetection: async ( + workspaceId: string, + resultId: string, + anomalyDetectionRequest: AnomalyDetectionRequest, + skipCache?: boolean, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'workspaceId' is not null or undefined + assertParamExists("anomalyDetection", "workspaceId", workspaceId); + // verify required parameter 'resultId' is not null or undefined + assertParamExists("anomalyDetection", "resultId", resultId); + // verify required parameter 'anomalyDetectionRequest' is not null or undefined + assertParamExists("anomalyDetection", "anomalyDetectionRequest", anomalyDetectionRequest); + const localVarPath = + `/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}` + .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId))) + .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (skipCache !== undefined && skipCache !== null) { + localVarHeaderParameter["skip-cache"] = String(JSON.stringify(skipCache)); + } + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + const needsSerialization = + typeof anomalyDetectionRequest !== "string" || + localVarRequestOptions.headers["Content-Type"] === "application/json"; + localVarRequestOptions.data = needsSerialization + ? JSON.stringify(anomalyDetectionRequest !== undefined ? anomalyDetectionRequest : {}) + : anomalyDetectionRequest || ""; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Result ID + * @param {number} [offset] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetectionResult: async ( + workspaceId: string, + resultId: string, + offset?: number, + limit?: number, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'workspaceId' is not null or undefined + assertParamExists("anomalyDetectionResult", "workspaceId", workspaceId); + // verify required parameter 'resultId' is not null or undefined + assertParamExists("anomalyDetectionResult", "resultId", resultId); + const localVarPath = + `/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}` + .replace(`{${"workspaceId"}}`, encodeURIComponent(String(workspaceId))) + .replace(`{${"resultId"}}`, encodeURIComponent(String(resultId))); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "GET", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (offset !== undefined) { + localVarQueryParameter["offset"] = offset; + } + + if (limit !== undefined) { + localVarQueryParameter["limit"] = limit; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -6625,6 +7135,58 @@ export const SmartFunctionsApiAxiosParamCreator = function (configuration?: Conf export const SmartFunctionsApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = SmartFunctionsApiAxiosParamCreator(configuration); return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Input result ID to be used in the computation + * @param {AnomalyDetectionRequest} anomalyDetectionRequest + * @param {boolean} [skipCache] Ignore all caches during execution of current request. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async anomalyDetection( + workspaceId: string, + resultId: string, + anomalyDetectionRequest: AnomalyDetectionRequest, + skipCache?: boolean, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.anomalyDetection( + workspaceId, + resultId, + anomalyDetectionRequest, + skipCache, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {string} workspaceId Workspace identifier + * @param {string} resultId Result ID + * @param {number} [offset] + * @param {number} [limit] + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async anomalyDetectionResult( + workspaceId: string, + resultId: string, + offset?: number, + limit?: number, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.anomalyDetectionResult( + workspaceId, + resultId, + offset, + limit, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -6743,6 +7305,48 @@ export const SmartFunctionsApiFactory = function ( ) { const localVarFp = SmartFunctionsApiFp(configuration); return { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetection( + requestParameters: SmartFunctionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .anomalyDetection( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.anomalyDetectionRequest, + requestParameters.skipCache, + options, + ) + .then((request) => request(axios, basePath)); + }, + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + anomalyDetectionResult( + requestParameters: SmartFunctionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .anomalyDetectionResult( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.offset, + requestParameters.limit, + options, + ) + .then((request) => request(axios, basePath)); + }, /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -6836,6 +7440,32 @@ export const SmartFunctionsApiFactory = function ( * @interface SmartFunctionsApi */ export interface SmartFunctionsApiInterface { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SmartFunctionsApiInterface + */ + anomalyDetection( + requestParameters: SmartFunctionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; + + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SmartFunctionsApiInterface + */ + anomalyDetectionResult( + requestParameters: SmartFunctionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; + /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering @@ -6889,6 +7519,76 @@ export interface SmartFunctionsApiInterface { ): AxiosPromise; } +/** + * Request parameters for anomalyDetection operation in SmartFunctionsApi. + * @export + * @interface SmartFunctionsApiAnomalyDetectionRequest + */ +export interface SmartFunctionsApiAnomalyDetectionRequest { + /** + * Workspace identifier + * @type {string} + * @memberof SmartFunctionsApiAnomalyDetection + */ + readonly workspaceId: string; + + /** + * Input result ID to be used in the computation + * @type {string} + * @memberof SmartFunctionsApiAnomalyDetection + */ + readonly resultId: string; + + /** + * + * @type {AnomalyDetectionRequest} + * @memberof SmartFunctionsApiAnomalyDetection + */ + readonly anomalyDetectionRequest: AnomalyDetectionRequest; + + /** + * Ignore all caches during execution of current request. + * @type {boolean} + * @memberof SmartFunctionsApiAnomalyDetection + */ + readonly skipCache?: boolean; +} + +/** + * Request parameters for anomalyDetectionResult operation in SmartFunctionsApi. + * @export + * @interface SmartFunctionsApiAnomalyDetectionResultRequest + */ +export interface SmartFunctionsApiAnomalyDetectionResultRequest { + /** + * Workspace identifier + * @type {string} + * @memberof SmartFunctionsApiAnomalyDetectionResult + */ + readonly workspaceId: string; + + /** + * Result ID + * @type {string} + * @memberof SmartFunctionsApiAnomalyDetectionResult + */ + readonly resultId: string; + + /** + * + * @type {number} + * @memberof SmartFunctionsApiAnomalyDetectionResult + */ + readonly offset?: number; + + /** + * + * @type {number} + * @memberof SmartFunctionsApiAnomalyDetectionResult + */ + readonly limit?: number; +} + /** * Request parameters for clustering operation in SmartFunctionsApi. * @export @@ -7036,6 +7736,52 @@ export interface SmartFunctionsApiForecastResultRequest { * @extends {BaseAPI} */ export class SmartFunctionsApi extends BaseAPI implements SmartFunctionsApiInterface { + /** + * (EXPERIMENTAL) Computes anomaly detection. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection + * @param {SmartFunctionsApiAnomalyDetectionRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SmartFunctionsApi + */ + public anomalyDetection( + requestParameters: SmartFunctionsApiAnomalyDetectionRequest, + options?: AxiosRequestConfig, + ) { + return SmartFunctionsApiFp(this.configuration) + .anomalyDetection( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.anomalyDetectionRequest, + requestParameters.skipCache, + options, + ) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * (EXPERIMENTAL) Gets anomalies. + * @summary (EXPERIMENTAL) Smart functions - Anomaly Detection Result + * @param {SmartFunctionsApiAnomalyDetectionResultRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof SmartFunctionsApi + */ + public anomalyDetectionResult( + requestParameters: SmartFunctionsApiAnomalyDetectionResultRequest, + options?: AxiosRequestConfig, + ) { + return SmartFunctionsApiFp(this.configuration) + .anomalyDetectionResult( + requestParameters.workspaceId, + requestParameters.resultId, + requestParameters.offset, + requestParameters.limit, + options, + ) + .then((request) => request(this.axios, this.basePath)); + } + /** * (EXPERIMENTAL) Computes clusters for data points from the provided execution result and parameters. * @summary (EXPERIMENTAL) Smart functions - Clustering diff --git a/libs/api-client-tiger/src/generated/afm-rest-api/openapi-spec.json b/libs/api-client-tiger/src/generated/afm-rest-api/openapi-spec.json index cdb357aa2e6..a8c15cfa059 100644 --- a/libs/api-client-tiger/src/generated/afm-rest-api/openapi-spec.json +++ b/libs/api-client-tiger/src/generated/afm-rest-api/openapi-spec.json @@ -141,6 +141,68 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/{resultId}": { + "post": { + "tags": ["Smart Functions", "actions"], + "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection", + "description": "(EXPERIMENTAL) Computes anomaly detection.", + "operationId": "anomalyDetection", + "parameters": [ + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "name": "resultId", + "in": "path", + "description": "Input result ID to be used in the computation", + "required": true, + "schema": { + "type": "string" + }, + "example": "9bd52018570364264fcf62d373da6bed313120e8" + }, + { + "name": "skip-cache", + "in": "header", + "description": "Ignore all caches during execution of current request.", + "required": false, + "schema": { + "type": "boolean", + "default": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnomalyDetectionRequest" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SmartFunctionResponse" + } + } + } + } + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers": { "post": { "tags": ["Computation", "actions"], @@ -625,6 +687,66 @@ } } }, + "/api/v1/actions/workspaces/{workspaceId}/execution/functions/anomalyDetection/result/{resultId}": { + "get": { + "tags": ["Smart Functions", "actions"], + "summary": "(EXPERIMENTAL) Smart functions - Anomaly Detection Result", + "description": "(EXPERIMENTAL) Gets anomalies.", + "operationId": "anomalyDetectionResult", + "parameters": [ + { + "name": "workspaceId", + "in": "path", + "description": "Workspace identifier", + "required": true, + "schema": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string" + } + }, + { + "name": "resultId", + "in": "path", + "description": "Result ID", + "required": true, + "schema": { + "type": "string" + }, + "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781" + }, + { + "name": "offset", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "limit", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AnomalyDetectionResult" + } + } + } + } + } + } + }, "/api/v1/actions/workspaces/{workspaceId}/execution/computeKeyDrivers/result/{resultId}": { "get": { "tags": ["Computation", "actions"], @@ -886,6 +1008,17 @@ } } }, + "AnomalyDetectionRequest": { + "required": ["sensitivity"], + "type": "object", + "properties": { + "sensitivity": { + "type": "number", + "description": "Anomaly detection sensitivity.", + "format": "float" + } + } + }, "AbsoluteDateFilter": { "required": ["absoluteDateFilter"], "type": "object", @@ -2539,13 +2672,13 @@ "nullable": true } }, - "xcoord": { + "ycoord": { "type": "array", "items": { "type": "number" } }, - "ycoord": { + "xcoord": { "type": "array", "items": { "type": "number" @@ -2553,6 +2686,32 @@ } } }, + "AnomalyDetectionResult": { + "required": ["anomalyFlag", "attribute", "values"], + "type": "object", + "properties": { + "attribute": { + "type": "array", + "items": { + "type": "string" + } + }, + "values": { + "type": "array", + "items": { + "type": "number", + "nullable": true + } + }, + "anomalyFlag": { + "type": "array", + "items": { + "type": "boolean", + "nullable": true + } + } + } + }, "KeyDriversResult": { "required": ["data"], "type": "object", diff --git a/libs/api-client-tiger/src/generated/metadata-json-api/api.ts b/libs/api-client-tiger/src/generated/metadata-json-api/api.ts index a413eb1bca7..1a91b06620d 100644 --- a/libs/api-client-tiger/src/generated/metadata-json-api/api.ts +++ b/libs/api-client-tiger/src/generated/metadata-json-api/api.ts @@ -66,7 +66,6 @@ export const ApiEntitlementNameEnum = { WHITE_LABELING: "WhiteLabeling", WORKSPACE_COUNT: "WorkspaceCount", USER_TELEMETRY_DISABLED: "UserTelemetryDisabled", - EXPERIMENTAL_FEATURES: "ExperimentalFeatures", } as const; export type ApiEntitlementNameEnum = typeof ApiEntitlementNameEnum[keyof typeof ApiEntitlementNameEnum]; @@ -1954,6 +1953,7 @@ export const DeclarativeSettingTypeEnum = { SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS", OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES", TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED", + OPENAI_CONFIG: "OPENAI_CONFIG", } as const; export type DeclarativeSettingTypeEnum = @@ -2904,7 +2904,6 @@ export const EntitlementsRequestEntitlementsNameEnum = { WHITE_LABELING: "WhiteLabeling", WORKSPACE_COUNT: "WorkspaceCount", USER_TELEMETRY_DISABLED: "UserTelemetryDisabled", - EXPERIMENTAL_FEATURES: "ExperimentalFeatures", } as const; export type EntitlementsRequestEntitlementsNameEnum = @@ -3418,10 +3417,10 @@ export interface JsonApiAnalyticalDashboardOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiAnalyticalDashboardOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -4012,23 +4011,10 @@ export interface JsonApiApiTokenOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiApiTokenOutList */ - meta?: JsonApiApiTokenOutListMeta; -} -/** - * - * @export - * @interface JsonApiApiTokenOutListMeta - */ -export interface JsonApiApiTokenOutListMeta { - /** - * - * @type {PageMetadata} - * @memberof JsonApiApiTokenOutListMeta - */ - page?: PageMetadata; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -4326,10 +4312,10 @@ export interface JsonApiAttributeHierarchyOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiAttributeHierarchyOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -4713,10 +4699,10 @@ export interface JsonApiAttributeOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiAttributeOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -4989,10 +4975,23 @@ export interface JsonApiColorPaletteOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiColorPaletteOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; +} +/** + * + * @export + * @interface JsonApiColorPaletteOutListMeta + */ +export interface JsonApiColorPaletteOutListMeta { + /** + * + * @type {PageMetadata} + * @memberof JsonApiColorPaletteOutListMeta + */ + page?: PageMetadata; } /** * @@ -5118,10 +5117,10 @@ export interface JsonApiCookieSecurityConfigurationIn { id: string; /** * - * @type {JsonApiCookieSecurityConfigurationPatchAttributes} + * @type {JsonApiCookieSecurityConfigurationOutAttributes} * @memberof JsonApiCookieSecurityConfigurationIn */ - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; } export const JsonApiCookieSecurityConfigurationInTypeEnum = { @@ -5164,10 +5163,10 @@ export interface JsonApiCookieSecurityConfigurationOut { id: string; /** * - * @type {JsonApiCookieSecurityConfigurationPatchAttributes} + * @type {JsonApiCookieSecurityConfigurationOutAttributes} * @memberof JsonApiCookieSecurityConfigurationOut */ - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; } export const JsonApiCookieSecurityConfigurationOutTypeEnum = { @@ -5177,6 +5176,25 @@ export const JsonApiCookieSecurityConfigurationOutTypeEnum = { export type JsonApiCookieSecurityConfigurationOutTypeEnum = typeof JsonApiCookieSecurityConfigurationOutTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationOutTypeEnum]; +/** + * + * @export + * @interface JsonApiCookieSecurityConfigurationOutAttributes + */ +export interface JsonApiCookieSecurityConfigurationOutAttributes { + /** + * + * @type {string} + * @memberof JsonApiCookieSecurityConfigurationOutAttributes + */ + lastRotation?: string; + /** + * Length of interval between automatic rotations expressed in format of ISO 8601 duration + * @type {string} + * @memberof JsonApiCookieSecurityConfigurationOutAttributes + */ + rotationInterval?: string; +} /** * * @export @@ -5216,10 +5234,10 @@ export interface JsonApiCookieSecurityConfigurationPatch { id: string; /** * - * @type {JsonApiCookieSecurityConfigurationPatchAttributes} + * @type {JsonApiCookieSecurityConfigurationOutAttributes} * @memberof JsonApiCookieSecurityConfigurationPatch */ - attributes?: JsonApiCookieSecurityConfigurationPatchAttributes; + attributes?: JsonApiCookieSecurityConfigurationOutAttributes; } export const JsonApiCookieSecurityConfigurationPatchTypeEnum = { @@ -5229,25 +5247,6 @@ export const JsonApiCookieSecurityConfigurationPatchTypeEnum = { export type JsonApiCookieSecurityConfigurationPatchTypeEnum = typeof JsonApiCookieSecurityConfigurationPatchTypeEnum[keyof typeof JsonApiCookieSecurityConfigurationPatchTypeEnum]; -/** - * - * @export - * @interface JsonApiCookieSecurityConfigurationPatchAttributes - */ -export interface JsonApiCookieSecurityConfigurationPatchAttributes { - /** - * - * @type {string} - * @memberof JsonApiCookieSecurityConfigurationPatchAttributes - */ - lastRotation?: string; - /** - * Length of interval between automatic rotations expressed in format of ISO 8601 duration - * @type {string} - * @memberof JsonApiCookieSecurityConfigurationPatchAttributes - */ - rotationInterval?: string; -} /** * * @export @@ -5392,10 +5391,10 @@ export interface JsonApiCspDirectiveOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiCspDirectiveOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -5619,10 +5618,10 @@ export interface JsonApiCustomApplicationSettingOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiCustomApplicationSettingOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -6011,10 +6010,10 @@ export interface JsonApiDashboardPluginOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiDashboardPluginOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -6350,10 +6349,10 @@ export interface JsonApiDataSourceIdentifierOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiDataSourceIdentifierOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -6730,10 +6729,10 @@ export interface JsonApiDataSourceOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiDataSourceOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -7358,10 +7357,10 @@ export interface JsonApiDatasetOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiDatasetOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -7562,10 +7561,10 @@ export interface JsonApiEntitlementOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiEntitlementOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -7799,10 +7798,10 @@ export interface JsonApiExportDefinitionOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiExportDefinitionOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -8257,10 +8256,10 @@ export interface JsonApiFactOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiFactOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -8504,10 +8503,10 @@ export interface JsonApiFilterContextOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiFilterContextOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -8799,10 +8798,10 @@ export interface JsonApiJwkOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiJwkOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -9097,10 +9096,10 @@ export interface JsonApiLabelOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiLabelOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -9414,10 +9413,10 @@ export interface JsonApiMetricOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiMetricOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -9743,10 +9742,10 @@ export interface JsonApiOrganizationIn { id: string; /** * - * @type {JsonApiOrganizationPatchAttributes} + * @type {JsonApiOrganizationInAttributes} * @memberof JsonApiOrganizationIn */ - attributes?: JsonApiOrganizationPatchAttributes; + attributes?: JsonApiOrganizationInAttributes; } export const JsonApiOrganizationInTypeEnum = { @@ -9756,6 +9755,73 @@ export const JsonApiOrganizationInTypeEnum = { export type JsonApiOrganizationInTypeEnum = typeof JsonApiOrganizationInTypeEnum[keyof typeof JsonApiOrganizationInTypeEnum]; +/** + * + * @export + * @interface JsonApiOrganizationInAttributes + */ +export interface JsonApiOrganizationInAttributes { + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + name?: string; + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + hostname?: string; + /** + * + * @type {Array} + * @memberof JsonApiOrganizationInAttributes + */ + allowedOrigins?: Array; + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + oauthIssuerLocation?: string; + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + oauthClientId?: string; + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + oauthClientSecret?: string; + /** + * + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + earlyAccess?: string; + /** + * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + oauthIssuerId?: string; + /** + * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'. + * @type {string} + * @memberof JsonApiOrganizationInAttributes + */ + oauthSubjectIdClaim?: string; + /** + * Flag to enable/disable JIT provisioning in the given organization + * @type {boolean} + * @memberof JsonApiOrganizationInAttributes + */ + jitEnabled?: boolean; +} /** * * @export @@ -10027,10 +10093,10 @@ export interface JsonApiOrganizationPatch { id: string; /** * - * @type {JsonApiOrganizationPatchAttributes} + * @type {JsonApiOrganizationInAttributes} * @memberof JsonApiOrganizationPatch */ - attributes?: JsonApiOrganizationPatchAttributes; + attributes?: JsonApiOrganizationInAttributes; } export const JsonApiOrganizationPatchTypeEnum = { @@ -10040,73 +10106,6 @@ export const JsonApiOrganizationPatchTypeEnum = { export type JsonApiOrganizationPatchTypeEnum = typeof JsonApiOrganizationPatchTypeEnum[keyof typeof JsonApiOrganizationPatchTypeEnum]; -/** - * - * @export - * @interface JsonApiOrganizationPatchAttributes - */ -export interface JsonApiOrganizationPatchAttributes { - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - name?: string; - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - hostname?: string; - /** - * - * @type {Array} - * @memberof JsonApiOrganizationPatchAttributes - */ - allowedOrigins?: Array; - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - oauthIssuerLocation?: string; - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - oauthClientId?: string; - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - oauthClientSecret?: string; - /** - * - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - earlyAccess?: string; - /** - * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider. - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - oauthIssuerId?: string; - /** - * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'. - * @type {string} - * @memberof JsonApiOrganizationPatchAttributes - */ - oauthSubjectIdClaim?: string; - /** - * Flag to enable/disable JIT provisioning in the given organization - * @type {boolean} - * @memberof JsonApiOrganizationPatchAttributes - */ - jitEnabled?: boolean; -} /** * * @export @@ -10140,10 +10139,10 @@ export interface JsonApiOrganizationSettingIn { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiOrganizationSettingIn */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiOrganizationSettingInTypeEnum = { @@ -10186,10 +10185,10 @@ export interface JsonApiOrganizationSettingOut { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiOrganizationSettingOut */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiOrganizationSettingOutTypeEnum = { @@ -10238,10 +10237,10 @@ export interface JsonApiOrganizationSettingOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiOrganizationSettingOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -10263,10 +10262,10 @@ export interface JsonApiOrganizationSettingOutWithLinks { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiOrganizationSettingOutWithLinks */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; /** * * @type {ObjectLinks} @@ -10302,10 +10301,10 @@ export interface JsonApiOrganizationSettingPatch { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiOrganizationSettingPatch */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiOrganizationSettingPatchTypeEnum = { @@ -10315,6 +10314,45 @@ export const JsonApiOrganizationSettingPatchTypeEnum = { export type JsonApiOrganizationSettingPatchTypeEnum = typeof JsonApiOrganizationSettingPatchTypeEnum[keyof typeof JsonApiOrganizationSettingPatchTypeEnum]; +/** + * + * @export + * @interface JsonApiOrganizationSettingPatchAttributes + */ +export interface JsonApiOrganizationSettingPatchAttributes { + /** + * Free-form JSON content. Maximum supported length is 15000 characters. + * @type {object} + * @memberof JsonApiOrganizationSettingPatchAttributes + */ + content?: object; + /** + * + * @type {string} + * @memberof JsonApiOrganizationSettingPatchAttributes + */ + type?: JsonApiOrganizationSettingPatchAttributesTypeEnum; +} + +export const JsonApiOrganizationSettingPatchAttributesTypeEnum = { + TIMEZONE: "TIMEZONE", + ACTIVE_THEME: "ACTIVE_THEME", + ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE", + WHITE_LABELING: "WHITE_LABELING", + LOCALE: "LOCALE", + METADATA_LOCALE: "METADATA_LOCALE", + FORMAT_LOCALE: "FORMAT_LOCALE", + MAPBOX_TOKEN: "MAPBOX_TOKEN", + WEEK_START: "WEEK_START", + SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS", + OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES", + TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED", + OPENAI_CONFIG: "OPENAI_CONFIG", +} as const; + +export type JsonApiOrganizationSettingPatchAttributesTypeEnum = + typeof JsonApiOrganizationSettingPatchAttributesTypeEnum[keyof typeof JsonApiOrganizationSettingPatchAttributesTypeEnum]; + /** * * @export @@ -10444,10 +10482,10 @@ export interface JsonApiThemeOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiThemeOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -10689,10 +10727,10 @@ export interface JsonApiUserDataFilterOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiUserDataFilterOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -11160,10 +11198,10 @@ export interface JsonApiUserGroupOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiUserGroupOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -11438,10 +11476,10 @@ export interface JsonApiUserIdentifierOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiUserIdentifierOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -11650,10 +11688,10 @@ export interface JsonApiUserOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiUserOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -11821,10 +11859,10 @@ export interface JsonApiUserSettingIn { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiUserSettingIn */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiUserSettingInTypeEnum = { @@ -11834,44 +11872,6 @@ export const JsonApiUserSettingInTypeEnum = { export type JsonApiUserSettingInTypeEnum = typeof JsonApiUserSettingInTypeEnum[keyof typeof JsonApiUserSettingInTypeEnum]; -/** - * - * @export - * @interface JsonApiUserSettingInAttributes - */ -export interface JsonApiUserSettingInAttributes { - /** - * Free-form JSON content. Maximum supported length is 15000 characters. - * @type {object} - * @memberof JsonApiUserSettingInAttributes - */ - content?: object; - /** - * - * @type {string} - * @memberof JsonApiUserSettingInAttributes - */ - type?: JsonApiUserSettingInAttributesTypeEnum; -} - -export const JsonApiUserSettingInAttributesTypeEnum = { - TIMEZONE: "TIMEZONE", - ACTIVE_THEME: "ACTIVE_THEME", - ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE", - WHITE_LABELING: "WHITE_LABELING", - LOCALE: "LOCALE", - METADATA_LOCALE: "METADATA_LOCALE", - FORMAT_LOCALE: "FORMAT_LOCALE", - MAPBOX_TOKEN: "MAPBOX_TOKEN", - WEEK_START: "WEEK_START", - SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS", - OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES", - TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED", -} as const; - -export type JsonApiUserSettingInAttributesTypeEnum = - typeof JsonApiUserSettingInAttributesTypeEnum[keyof typeof JsonApiUserSettingInAttributesTypeEnum]; - /** * * @export @@ -11905,10 +11905,10 @@ export interface JsonApiUserSettingOut { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiUserSettingOut */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiUserSettingOutTypeEnum = { @@ -11957,10 +11957,10 @@ export interface JsonApiUserSettingOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiUserSettingOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -11982,10 +11982,10 @@ export interface JsonApiUserSettingOutWithLinks { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiUserSettingOutWithLinks */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; /** * * @type {ObjectLinks} @@ -12171,10 +12171,10 @@ export interface JsonApiVisualizationObjectOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiVisualizationObjectOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -12552,10 +12552,10 @@ export interface JsonApiWorkspaceDataFilterOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiWorkspaceDataFilterOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -12886,10 +12886,10 @@ export interface JsonApiWorkspaceDataFilterSettingOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiWorkspaceDataFilterSettingOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -13176,10 +13176,10 @@ export interface JsonApiWorkspaceOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiWorkspaceOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; /** * Included resources * @type {Array} @@ -13493,10 +13493,10 @@ export interface JsonApiWorkspaceSettingIn { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiWorkspaceSettingIn */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiWorkspaceSettingInTypeEnum = { @@ -13545,10 +13545,10 @@ export interface JsonApiWorkspaceSettingOut { meta?: JsonApiAttributeHierarchyOutMeta; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiWorkspaceSettingOut */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiWorkspaceSettingOutTypeEnum = { @@ -13597,10 +13597,10 @@ export interface JsonApiWorkspaceSettingOutList { links?: ListLinks; /** * - * @type {JsonApiApiTokenOutListMeta} + * @type {JsonApiColorPaletteOutListMeta} * @memberof JsonApiWorkspaceSettingOutList */ - meta?: JsonApiApiTokenOutListMeta; + meta?: JsonApiColorPaletteOutListMeta; } /** * @@ -13628,10 +13628,10 @@ export interface JsonApiWorkspaceSettingOutWithLinks { meta?: JsonApiAttributeHierarchyOutMeta; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiWorkspaceSettingOutWithLinks */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; /** * * @type {ObjectLinks} @@ -13667,10 +13667,10 @@ export interface JsonApiWorkspaceSettingPatch { id: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiWorkspaceSettingPatch */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiWorkspaceSettingPatchTypeEnum = { @@ -13713,10 +13713,10 @@ export interface JsonApiWorkspaceSettingPostOptionalId { id?: string; /** * - * @type {JsonApiUserSettingInAttributes} + * @type {JsonApiOrganizationSettingPatchAttributes} * @memberof JsonApiWorkspaceSettingPostOptionalId */ - attributes?: JsonApiUserSettingInAttributes; + attributes?: JsonApiOrganizationSettingPatchAttributes; } export const JsonApiWorkspaceSettingPostOptionalIdTypeEnum = { @@ -14401,6 +14401,7 @@ export const ResolvedSettingTypeEnum = { SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS", OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES", TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED", + OPENAI_CONFIG: "OPENAI_CONFIG", } as const; export type ResolvedSettingTypeEnum = typeof ResolvedSettingTypeEnum[keyof typeof ResolvedSettingTypeEnum]; diff --git a/libs/api-client-tiger/src/generated/metadata-json-api/openapi-spec.json b/libs/api-client-tiger/src/generated/metadata-json-api/openapi-spec.json index abbce8b8789..aeb65a4ac8d 100644 --- a/libs/api-client-tiger/src/generated/metadata-json-api/openapi-spec.json +++ b/libs/api-client-tiger/src/generated/metadata-json-api/openapi-spec.json @@ -12475,119 +12475,6 @@ } } }, - "JsonApiUserSettingInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingIn" - } - } - }, - "JsonApiUserSettingIn": { - "required": ["id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "userSetting", - "enum": ["userSetting"] - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" - }, - "attributes": { - "type": "object", - "properties": { - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} - }, - "type": { - "type": "string", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "WEEK_START", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" - ] - } - } - } - }, - "description": "JSON:API representation of userSetting entity." - }, - "JsonApiUserSettingOutDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - } - } - }, - "JsonApiUserSettingOut": { - "required": ["id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "userSetting", - "enum": ["userSetting"] - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" - }, - "attributes": { - "type": "object", - "properties": { - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} - }, - "type": { - "type": "string", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "WEEK_START", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" - ] - } - } - } - }, - "description": "JSON:API representation of userSetting entity." - }, "JsonApiColorPalettePatchDocument": { "required": ["data"], "type": "object", @@ -13221,7 +13108,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } } @@ -13279,7 +13167,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } } @@ -13989,24 +13878,24 @@ }, "description": "JSON:API representation of apiToken entity." }, - "JsonApiCookieSecurityConfigurationPatchDocument": { + "JsonApiUserSettingInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" + "$ref": "#/components/schemas/JsonApiUserSettingIn" } } }, - "JsonApiCookieSecurityConfigurationPatch": { + "JsonApiUserSettingIn": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "cookieSecurityConfiguration", - "enum": ["cookieSecurityConfiguration"] + "example": "userSetting", + "enum": ["userSetting"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -14017,41 +13906,55 @@ "attributes": { "type": "object", "properties": { - "lastRotation": { - "type": "string", - "format": "date-time" + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} }, - "rotationInterval": { + "type": { "type": "string", - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D" + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "WEEK_START", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" + ] } } } }, - "description": "JSON:API representation of patching cookieSecurityConfiguration entity." + "description": "JSON:API representation of userSetting entity." }, - "JsonApiCookieSecurityConfigurationOutDocument": { + "JsonApiUserSettingOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" + "$ref": "#/components/schemas/JsonApiUserSettingOut" }, "links": { "$ref": "#/components/schemas/ObjectLinks" } } }, - "JsonApiCookieSecurityConfigurationOut": { + "JsonApiUserSettingOut": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "cookieSecurityConfiguration", - "enum": ["cookieSecurityConfiguration"] + "example": "userSetting", + "enum": ["userSetting"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -14062,38 +13965,55 @@ "attributes": { "type": "object", "properties": { - "lastRotation": { - "type": "string", - "format": "date-time" + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} }, - "rotationInterval": { + "type": { "type": "string", - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D" + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "WEEK_START", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" + ] } } } }, - "description": "JSON:API representation of cookieSecurityConfiguration entity." + "description": "JSON:API representation of userSetting entity." }, - "JsonApiOrganizationPatchDocument": { + "JsonApiCookieSecurityConfigurationOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiOrganizationPatch" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } } }, - "JsonApiOrganizationPatch": { + "JsonApiCookieSecurityConfigurationOut": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "organization", - "enum": ["organization"] + "example": "cookieSecurityConfiguration", + "enum": ["cookieSecurityConfiguration"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -14104,56 +14024,19 @@ "attributes": { "type": "object", "properties": { - "name": { - "maxLength": 255, - "type": "string" - }, - "hostname": { - "maxLength": 255, - "type": "string" - }, - "allowedOrigins": { - "type": "array", - "items": { - "type": "string" - } - }, - "oauthIssuerLocation": { - "maxLength": 255, - "type": "string" - }, - "oauthClientId": { - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "maxLength": 255, - "type": "string" - }, - "earlyAccess": { - "maxLength": 255, - "type": "string" - }, - "oauthIssuerId": { - "maxLength": 255, + "lastRotation": { "type": "string", - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider" + "format": "date-time" }, - "oauthSubjectIdClaim": { - "maxLength": 255, + "rotationInterval": { "type": "string", - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid" - }, - "jitEnabled": { - "type": "boolean", - "description": "Flag to enable/disable JIT provisioning in the given organization" + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D" } } } }, - "description": "JSON:API representation of patching organization entity." + "description": "JSON:API representation of cookieSecurityConfiguration entity." }, "JsonApiOrganizationOutIncludes": { "oneOf": [ @@ -16888,7 +16771,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } } @@ -16966,7 +16850,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } } @@ -16974,17 +16859,110 @@ }, "description": "JSON:API representation of workspaceSetting entity." }, - "JsonApiDataSourceIdentifierOutDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" + "JsonApiColorPaletteOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiColorPaletteOut" }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] + }, + "JsonApiColorPaletteOutList": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiColorPaletteOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" + }, + "JsonApiCspDirectiveOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiCspDirectiveOutList": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" + }, + "JsonApiDataSourceIdentifierOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiDataSourceIdentifierOutList": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" }, "JsonApiDataSourceIdentifierOut": { "required": ["attributes", "id", "type"], @@ -17056,17 +17034,75 @@ }, "description": "JSON:API representation of dataSourceIdentifier entity." }, - "JsonApiEntitlementOutDocument": { + "JsonApiDataSourceOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiDataSourceOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiDataSourceOutList": { "required": ["data"], "type": "object", "properties": { "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiDataSourceOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" + }, + "JsonApiEntitlementOutWithLinks": { + "allOf": [ + { "$ref": "#/components/schemas/JsonApiEntitlementOut" }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiEntitlementOutList": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiEntitlementOutWithLinks" + } + }, "links": { - "$ref": "#/components/schemas/ObjectLinks" + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } } - } + }, + "description": "A JSON:API document with a list of resources" }, "JsonApiEntitlementOut": { "required": ["id", "type"], @@ -17100,155 +17136,198 @@ }, "description": "JSON:API representation of entitlement entity." }, - "JsonApiUserIdentifierOutDocument": { + "JsonApiJwkOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiJwkOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiJwkOutList": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiJwkOutWithLinks" + } }, "links": { - "$ref": "#/components/schemas/ObjectLinks" + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } } - } + }, + "description": "A JSON:API document with a list of resources" }, - "JsonApiUserIdentifierOut": { - "required": ["id", "type"], + "JsonApiOrganizationSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiOrganizationSettingOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "userIdentifier", - "enum": ["userIdentifier"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiOrganizationSettingOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { + "meta": { "type": "object", "properties": { - "firstname": { - "maxLength": 255, - "type": "string" - }, - "lastname": { - "maxLength": 255, - "type": "string" - }, - "email": { - "maxLength": 255, - "type": "string" + "page": { + "$ref": "#/components/schemas/PageMetadata" } } } }, - "description": "JSON:API representation of userIdentifier entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiColorPaletteInDocument": { + "JsonApiThemeOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiThemeOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiThemeOutList": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiColorPaletteIn" - } - } - }, - "JsonApiColorPaletteIn": { - "required": ["attributes", "id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "colorPalette", - "enum": ["colorPalette"] + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["content", "name"], + "meta": { "type": "object", "properties": { - "name": { - "maxLength": 255, - "type": "string" - }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} + "page": { + "$ref": "#/components/schemas/PageMetadata" } } } }, - "description": "JSON:API representation of colorPalette entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiCspDirectiveInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiCspDirectiveIn" + "JsonApiUserGroupOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserGroupOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiCspDirectiveIn": { - "required": ["attributes", "id", "type"], + "JsonApiUserGroupOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "cspDirective", - "enum": ["cspDirective"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["sources"], + "meta": { "type": "object", "properties": { - "sources": { - "type": "array", - "items": { - "type": "string" - } + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + } } }, - "description": "JSON:API representation of cspDirective entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiDataSourceInDocument": { + "JsonApiUserIdentifierOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserIdentifierOutList": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiDataSourceIn" + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } } - } + }, + "description": "A JSON:API document with a list of resources" }, - "JsonApiDataSourceIn": { - "required": ["attributes", "id", "type"], + "JsonApiUserIdentifierOut": { + "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "dataSource", - "enum": ["dataSource"] + "example": "userIdentifier", + "enum": ["userIdentifier"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17257,230 +17336,165 @@ "example": "id1" }, "attributes": { - "required": ["name", "schema", "type"], "type": "object", "properties": { - "name": { - "maxLength": 255, - "type": "string", - "description": "User-facing name of the data source." - }, - "type": { - "type": "string", - "description": "Type of the database providing the data for the data source.", - "enum": [ - "POSTGRESQL", - "REDSHIFT", - "VERTICA", - "SNOWFLAKE", - "ADS", - "BIGQUERY", - "MSSQL", - "PRESTO", - "DREMIO", - "DRILL", - "GREENPLUM", - "AZURESQL", - "SYNAPSESQL", - "DATABRICKS", - "GDSTORAGE", - "CLICKHOUSE", - "MYSQL", - "MARIADB", - "ORACLE" - ] - }, - "url": { - "maxLength": 255, - "type": "string", - "description": "The URL of the database providing the data for the data source.", - "nullable": true - }, - "schema": { + "firstname": { "maxLength": 255, - "type": "string", - "description": "The schema to use as the root of the data for the data source." + "type": "string" }, - "username": { + "lastname": { "maxLength": 255, - "type": "string", - "description": "The username to use to connect to the database providing the data for the data source.", - "nullable": true + "type": "string" }, - "password": { + "email": { "maxLength": 255, - "type": "string", - "description": "The password to use to connect to the database providing the data for the data source.", - "nullable": true - }, - "token": { - "maxLength": 10000, - "type": "string", - "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Sevice Acount).", - "nullable": true - }, - "enableCaching": { - "type": "boolean", - "description": "Enable CTAS caching of intermediate results in the database.", - "nullable": true, - "example": false - }, - "cachePath": { - "type": "array", - "description": "Path to schema, where intermediate caches are stored.", - "nullable": true, - "items": { - "type": "string" - } - }, - "parameters": { - "type": "array", - "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", - "nullable": true, - "items": { - "required": ["name", "value"], - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "value": { - "type": "string" - } - } - } - }, - "cacheStrategy": { - "type": "string", - "description": "Determines how the results coming from a particular datasource should be cached.", - "nullable": true, - "enum": ["ALWAYS", "NEVER"] + "type": "string" } } } }, - "description": "JSON:API representation of dataSource entity." + "description": "JSON:API representation of userIdentifier entity." }, - "JsonApiJwkInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiJwkIn" + "JsonApiUserOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiJwkIn": { - "required": ["id", "type"], + "JsonApiUserOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "jwk", - "enum": ["jwk"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { + "meta": { "type": "object", "properties": { - "content": { - "type": "object", - "description": "Specification of the cryptographic key", - "example": { - "kyt": "RSA", - "alg": "RS256", - "use": "sig" - }, - "oneOf": [ - { - "$ref": "#/components/schemas/RsaSpecification" - } - ] + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + } } }, - "description": "JSON:API representation of jwk entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiOrganizationSettingInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingIn" + "JsonApiWorkspaceOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiOrganizationSettingIn": { - "required": ["id", "type"], + "JsonApiWorkspaceOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "organizationSetting", - "enum": ["organizationSetting"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { + "meta": { "type": "object", "properties": { - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} - }, - "type": { - "type": "string", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "WEEK_START", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" - ] + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + } } }, - "description": "JSON:API representation of organizationSetting entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiThemeInDocument": { + "JsonApiDataSourceIdentifierOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiThemeIn" + "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" } } }, - "JsonApiThemeIn": { + "JsonApiEntitlementOutDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiEntitlementOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + } + }, + "JsonApiUserIdentifierOutDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + }, + "links": { + "$ref": "#/components/schemas/ObjectLinks" + } + } + }, + "JsonApiColorPaletteInDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiColorPaletteIn" + } + } + }, + "JsonApiColorPaletteIn": { "required": ["attributes", "id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "theme", - "enum": ["theme"] + "example": "colorPalette", + "enum": ["colorPalette"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17504,26 +17518,26 @@ } } }, - "description": "JSON:API representation of theme entity." + "description": "JSON:API representation of colorPalette entity." }, - "JsonApiUserGroupInDocument": { + "JsonApiCspDirectiveInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserGroupIn" + "$ref": "#/components/schemas/JsonApiCspDirectiveIn" } } }, - "JsonApiUserGroupIn": { - "required": ["id", "type"], + "JsonApiCspDirectiveIn": { + "required": ["attributes", "id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "userGroup", - "enum": ["userGroup"] + "example": "cspDirective", + "enum": ["cspDirective"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17532,49 +17546,38 @@ "example": "id1" }, "attributes": { + "required": ["sources"], "type": "object", "properties": { - "name": { - "maxLength": 255, - "type": "string" - } - } - }, - "relationships": { - "type": "object", - "properties": { - "parents": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" - } + "sources": { + "type": "array", + "items": { + "type": "string" } } } } }, - "description": "JSON:API representation of userGroup entity." + "description": "JSON:API representation of cspDirective entity." }, - "JsonApiUserInDocument": { + "JsonApiDataSourceInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserIn" + "$ref": "#/components/schemas/JsonApiDataSourceIn" } } }, - "JsonApiUserIn": { - "required": ["id", "type"], + "JsonApiDataSourceIn": { + "required": ["attributes", "id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "user", - "enum": ["user"] + "example": "dataSource", + "enum": ["dataSource"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17583,61 +17586,128 @@ "example": "id1" }, "attributes": { + "required": ["name", "schema", "type"], "type": "object", "properties": { - "authenticationId": { + "name": { "maxLength": 255, - "type": "string" + "type": "string", + "description": "User-facing name of the data source." }, - "firstname": { + "type": { + "type": "string", + "description": "Type of the database providing the data for the data source.", + "enum": [ + "POSTGRESQL", + "REDSHIFT", + "VERTICA", + "SNOWFLAKE", + "ADS", + "BIGQUERY", + "MSSQL", + "PRESTO", + "DREMIO", + "DRILL", + "GREENPLUM", + "AZURESQL", + "SYNAPSESQL", + "DATABRICKS", + "GDSTORAGE", + "CLICKHOUSE", + "MYSQL", + "MARIADB", + "ORACLE" + ] + }, + "url": { "maxLength": 255, - "type": "string" + "type": "string", + "description": "The URL of the database providing the data for the data source.", + "nullable": true }, - "lastname": { + "schema": { "maxLength": 255, - "type": "string" + "type": "string", + "description": "The schema to use as the root of the data for the data source." }, - "email": { + "username": { "maxLength": 255, - "type": "string" - } - } - }, - "relationships": { - "type": "object", - "properties": { - "userGroups": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + "type": "string", + "description": "The username to use to connect to the database providing the data for the data source.", + "nullable": true + }, + "password": { + "maxLength": 255, + "type": "string", + "description": "The password to use to connect to the database providing the data for the data source.", + "nullable": true + }, + "token": { + "maxLength": 10000, + "type": "string", + "description": "The token to use to connect to the database providing the data for the data source (for example a BigQuery Sevice Acount).", + "nullable": true + }, + "enableCaching": { + "type": "boolean", + "description": "Enable CTAS caching of intermediate results in the database.", + "nullable": true, + "example": false + }, + "cachePath": { + "type": "array", + "description": "Path to schema, where intermediate caches are stored.", + "nullable": true, + "items": { + "type": "string" + } + }, + "parameters": { + "type": "array", + "description": "Additional parameters to be used when connecting to the database providing the data for the data source.", + "nullable": true, + "items": { + "required": ["name", "value"], + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "value": { + "type": "string" + } } } + }, + "cacheStrategy": { + "type": "string", + "description": "Determines how the results coming from a particular datasource should be cached.", + "nullable": true, + "enum": ["ALWAYS", "NEVER"] } } } }, - "description": "JSON:API representation of user entity." + "description": "JSON:API representation of dataSource entity." }, - "JsonApiWorkspaceInDocument": { + "JsonApiJwkInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceIn" + "$ref": "#/components/schemas/JsonApiJwkIn" } } }, - "JsonApiWorkspaceIn": { + "JsonApiJwkIn": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "workspace", - "enum": ["workspace"] + "example": "jwk", + "enum": ["jwk"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17648,86 +17718,43 @@ "attributes": { "type": "object", "properties": { - "name": { - "maxLength": 255, - "type": "string" - }, - "earlyAccess": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 255, - "type": "string" - }, - "prefix": { - "maxLength": 255, - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "Custom prefix of entity identifiers in workspace" - }, - "cacheExtraLimit": { - "type": "integer", - "format": "int64" - }, - "dataSource": { - "required": ["id"], + "content": { "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the used data source.", - "example": "snowflake.instance.1" - }, - "schemaPath": { - "type": "array", - "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", - "items": { - "type": "string", - "description": "The part of the schema path.", - "example": "subPath" - } - } + "description": "Specification of the cryptographic key", + "example": { + "kyt": "RSA", + "alg": "RS256", + "use": "sig" }, - "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace." - } - } - }, - "relationships": { - "type": "object", - "properties": { - "parent": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + "oneOf": [ + { + "$ref": "#/components/schemas/RsaSpecification" } - } + ] } } } }, - "description": "JSON:API representation of workspace entity." + "description": "JSON:API representation of jwk entity." }, - "JsonApiCookieSecurityConfigurationInDocument": { + "JsonApiOrganizationSettingInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" + "$ref": "#/components/schemas/JsonApiOrganizationSettingIn" } } }, - "JsonApiCookieSecurityConfigurationIn": { + "JsonApiOrganizationSettingIn": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "cookieSecurityConfiguration", - "enum": ["cookieSecurityConfiguration"] + "example": "organizationSetting", + "enum": ["organizationSetting"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17738,38 +17765,52 @@ "attributes": { "type": "object", "properties": { - "lastRotation": { - "type": "string", - "format": "date-time" + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} }, - "rotationInterval": { + "type": { "type": "string", - "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", - "example": "P30D" + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "WEEK_START", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" + ] } } } }, - "description": "JSON:API representation of cookieSecurityConfiguration entity." + "description": "JSON:API representation of organizationSetting entity." }, - "JsonApiOrganizationInDocument": { + "JsonApiThemeInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiOrganizationIn" + "$ref": "#/components/schemas/JsonApiThemeIn" } } }, - "JsonApiOrganizationIn": { - "required": ["id", "type"], + "JsonApiThemeIn": { + "required": ["attributes", "id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "organization", - "enum": ["organization"] + "example": "theme", + "enum": ["theme"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17778,77 +17819,41 @@ "example": "id1" }, "attributes": { + "required": ["content", "name"], "type": "object", "properties": { "name": { "maxLength": 255, "type": "string" }, - "hostname": { - "maxLength": 255, - "type": "string" - }, - "allowedOrigins": { - "type": "array", - "items": { - "type": "string" - } - }, - "oauthIssuerLocation": { - "maxLength": 255, - "type": "string" - }, - "oauthClientId": { - "maxLength": 255, - "type": "string" - }, - "oauthClientSecret": { - "maxLength": 255, - "type": "string" - }, - "earlyAccess": { - "maxLength": 255, - "type": "string" - }, - "oauthIssuerId": { - "maxLength": 255, - "type": "string", - "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", - "example": "myOidcProvider" - }, - "oauthSubjectIdClaim": { - "maxLength": 255, - "type": "string", - "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", - "example": "oid" - }, - "jitEnabled": { - "type": "boolean", - "description": "Flag to enable/disable JIT provisioning in the given organization" + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} } } } }, - "description": "JSON:API representation of organization entity." + "description": "JSON:API representation of theme entity." }, - "JsonApiAnalyticalDashboardPatchDocument": { + "JsonApiUserGroupInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatch" + "$ref": "#/components/schemas/JsonApiUserGroupIn" } } }, - "JsonApiAnalyticalDashboardPatch": { - "required": ["attributes", "id", "type"], + "JsonApiUserGroupIn": { + "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "analyticalDashboard", - "enum": ["analyticalDashboard"] + "example": "userGroup", + "enum": ["userGroup"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17859,57 +17864,47 @@ "attributes": { "type": "object", "properties": { - "title": { + "name": { "maxLength": 255, "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "content": { + } + } + }, + "relationships": { + "type": "object", + "properties": { + "parents": { + "required": ["data"], "type": "object", - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } } } } } }, - "description": "JSON:API representation of patching analyticalDashboard entity." + "description": "JSON:API representation of userGroup entity." }, - "JsonApiAttributeHierarchyPatchDocument": { + "JsonApiUserInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatch" + "$ref": "#/components/schemas/JsonApiUserIn" } } }, - "JsonApiAttributeHierarchyPatch": { + "JsonApiUserIn": { "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "attributeHierarchy", - "enum": ["attributeHierarchy"] + "example": "user", + "enum": ["user"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17920,66 +17915,59 @@ "attributes": { "type": "object", "properties": { - "title": { + "authenticationId": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "firstname": { + "maxLength": 255, "type": "string" }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" + "lastname": { + "maxLength": 255, + "type": "string" }, - "content": { + "email": { + "maxLength": 255, + "type": "string" + } + } + }, + "relationships": { + "type": "object", + "properties": { + "userGroups": { + "required": ["data"], "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": { - "attributes": [ - { - "identifier": { - "type": "attribute", - "id": "country" - } - }, - { - "identifier": { - "type": "attribute", - "id": "city" - } - } - ] + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToManyLinkage" + } } } } } }, - "description": "JSON:API representation of patching attributeHierarchy entity." + "description": "JSON:API representation of user entity." }, - "JsonApiCustomApplicationSettingPatchDocument": { + "JsonApiWorkspaceInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + "$ref": "#/components/schemas/JsonApiWorkspaceIn" } } }, - "JsonApiCustomApplicationSettingPatch": { - "required": ["attributes", "id", "type"], + "JsonApiWorkspaceIn": { + "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "customApplicationSetting", - "enum": ["customApplicationSetting"] + "example": "workspace", + "enum": ["workspace"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -17990,38 +17978,156 @@ "attributes": { "type": "object", "properties": { - "applicationName": { + "name": { "maxLength": 255, "type": "string" }, - "content": { + "earlyAccess": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 255, + "type": "string" + }, + "prefix": { + "maxLength": 255, + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "Custom prefix of entity identifiers in workspace" + }, + "cacheExtraLimit": { + "type": "integer", + "format": "int64" + }, + "dataSource": { + "required": ["id"], "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} + "properties": { + "id": { + "type": "string", + "description": "The ID of the used data source.", + "example": "snowflake.instance.1" + }, + "schemaPath": { + "type": "array", + "description": "The full schema path as array of its path parts. Will be rendered as subPath1.subPath2...", + "items": { + "type": "string", + "description": "The part of the schema path.", + "example": "subPath" + } + } + }, + "description": "The data source used for the particular workspace instead of the one defined in the LDM inherited from its parent workspace. Such data source cannot be defined for a single or a top-parent workspace." + } + } + }, + "relationships": { + "type": "object", + "properties": { + "parent": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiWorkspaceToOneLinkage" + } + } } } } }, - "description": "JSON:API representation of patching customApplicationSetting entity." + "description": "JSON:API representation of workspace entity." }, - "JsonApiDashboardPluginPatchDocument": { + "JsonApiApiTokenOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiApiTokenOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiApiTokenOutList": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginPatch" + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiApiTokenOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" + }, + "JsonApiUserSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" + } + ] + }, + "JsonApiUserSettingOutList": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" + } + }, + "links": { + "$ref": "#/components/schemas/ListLinks" + }, + "meta": { + "type": "object", + "properties": { + "page": { + "$ref": "#/components/schemas/PageMetadata" + } + } + } + }, + "description": "A JSON:API document with a list of resources" + }, + "JsonApiAnalyticalDashboardPatchDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardPatch" } } }, - "JsonApiDashboardPluginPatch": { - "required": ["id", "type"], + "JsonApiAnalyticalDashboardPatch": { + "required": ["attributes", "id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "dashboardPlugin", - "enum": ["dashboardPlugin"] + "example": "analyticalDashboard", + "enum": ["analyticalDashboard"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -18053,26 +18159,199 @@ "type": "object", "description": "Free-form JSON content. Maximum supported length is 250000 characters.", "example": { - "url": "" + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false } } } } }, - "description": "JSON:API representation of patching dashboardPlugin entity." + "description": "JSON:API representation of patching analyticalDashboard entity." }, - "JsonApiExportDefinitionPatchDocument": { + "JsonApiAttributeHierarchyPatchDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyPatch" } } }, - "JsonApiExportDefinitionPatch": { - "required": ["attributes", "id", "type"], - "type": "object", + "JsonApiAttributeHierarchyPatch": { + "required": ["id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "attributeHierarchy", + "enum": ["attributeHierarchy"] + }, + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" + }, + "attributes": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": { + "attributes": [ + { + "identifier": { + "type": "attribute", + "id": "country" + } + }, + { + "identifier": { + "type": "attribute", + "id": "city" + } + } + ] + } + } + } + } + }, + "description": "JSON:API representation of patching attributeHierarchy entity." + }, + "JsonApiCustomApplicationSettingPatchDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingPatch" + } + } + }, + "JsonApiCustomApplicationSettingPatch": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "customApplicationSetting", + "enum": ["customApplicationSetting"] + }, + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" + }, + "attributes": { + "type": "object", + "properties": { + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} + } + } + } + }, + "description": "JSON:API representation of patching customApplicationSetting entity." + }, + "JsonApiDashboardPluginPatchDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiDashboardPluginPatch" + } + } + }, + "JsonApiDashboardPluginPatch": { + "required": ["id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "dashboardPlugin", + "enum": ["dashboardPlugin"] + }, + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" + }, + "attributes": { + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "url": "" + } + } + } + } + }, + "description": "JSON:API representation of patching dashboardPlugin entity." + }, + "JsonApiExportDefinitionPatchDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiExportDefinitionPatch" + } + } + }, + "JsonApiExportDefinitionPatch": { + "required": ["attributes", "id", "type"], + "type": "object", "properties": { "type": { "type": "string", @@ -18563,7 +18842,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } } @@ -18571,171 +18851,126 @@ }, "description": "JSON:API representation of patching workspaceSetting entity." }, - "JsonApiApiTokenOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiApiTokenOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiApiTokenOutList": { + "JsonApiCookieSecurityConfigurationInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiApiTokenOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationIn" + } + } + }, + "JsonApiCookieSecurityConfigurationIn": { + "required": ["id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "cookieSecurityConfiguration", + "enum": ["cookieSecurityConfiguration"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "lastRotation": { + "type": "string", + "format": "date-time" + }, + "rotationInterval": { + "type": "string", + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D" } } } }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiUserSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "description": "JSON:API representation of cookieSecurityConfiguration entity." }, - "JsonApiUserSettingOutList": { + "JsonApiOrganizationInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiUserSettingOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } + "$ref": "#/components/schemas/JsonApiOrganizationIn" } - }, - "description": "A JSON:API document with a list of resources" + } }, - "JsonApiAnalyticalDashboardOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiAnalyticalDashboardOutList": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiAttributeHierarchyOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiAttributeHierarchyOutList": { - "required": ["data"], + "JsonApiOrganizationIn": { + "required": ["id", "type"], "type": "object", "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" - } + "type": { + "type": "string", + "description": "Object type", + "example": "organization", + "enum": ["organization"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "name": { + "maxLength": 255, + "type": "string" + }, + "hostname": { + "maxLength": 255, + "type": "string" + }, + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + } + }, + "oauthIssuerLocation": { + "maxLength": 255, + "type": "string" + }, + "oauthClientId": { + "maxLength": 255, + "type": "string" + }, + "oauthClientSecret": { + "maxLength": 255, + "type": "string" + }, + "earlyAccess": { + "maxLength": 255, + "type": "string" + }, + "oauthIssuerId": { + "maxLength": 255, + "type": "string", + "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example": "myOidcProvider" + }, + "oauthSubjectIdClaim": { + "maxLength": 255, + "type": "string", + "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example": "oid" + }, + "jitEnabled": { + "type": "boolean", + "description": "Flag to enable/disable JIT provisioning in the given organization" } } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" - } } }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiAttributeOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "description": "JSON:API representation of organization entity." }, "JsonApiAttributeOutIncludes": { "oneOf": [ @@ -18750,27 +18985,15 @@ } ] }, - "JsonApiAttributeOutList": { + "JsonApiAttributeOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiAttributeOut" }, "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } + "$ref": "#/components/schemas/ObjectLinks" }, "included": { "uniqueItems": true, @@ -18780,8 +19003,7 @@ "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" } } - }, - "description": "A JSON:API document with a list of resources" + } }, "JsonApiAttributeOut": { "required": ["id", "type"], @@ -18968,158 +19190,57 @@ } ] }, - "JsonApiCustomApplicationSettingOutWithLinks": { - "allOf": [ + "JsonApiDatasetOutIncludes": { + "oneOf": [ { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiCustomApplicationSettingOutList": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiDashboardPluginOutWithLinks": { - "allOf": [ { - "$ref": "#/components/schemas/JsonApiDashboardPluginOut" + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" }, { - "$ref": "#/components/schemas/ObjectLinksContainer" + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" } ] }, - "JsonApiDashboardPluginOutList": { + "JsonApiDatasetOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiDatasetOut" }, "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } + "$ref": "#/components/schemas/ObjectLinks" }, "included": { "uniqueItems": true, "type": "array", "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" } } - }, - "description": "A JSON:API document with a list of resources" + } }, - "JsonApiDatasetOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiDatasetOut" + "JsonApiDatasetOut": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "dataset", + "enum": ["dataset"] }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiDatasetOutIncludes": { - "oneOf": [ - { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - }, - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - } - ] - }, - "JsonApiDatasetOutList": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiDatasetOut": { - "required": ["attributes", "id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "dataset", - "enum": ["dataset"] - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, "meta": { "type": "object", @@ -19415,80 +19536,15 @@ } } }, - "JsonApiExportDefinitionOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiExportDefinitionOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiExportDefinitionOutList": { + "JsonApiFactOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiFactOutWithLinks": { - "allOf": [ - { "$ref": "#/components/schemas/JsonApiFactOut" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiFactOutList": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiFactOutWithLinks" - } - }, "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } + "$ref": "#/components/schemas/ObjectLinks" }, "included": { "uniqueItems": true, @@ -19498,8 +19554,7 @@ "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" } } - }, - "description": "A JSON:API document with a list of resources" + } }, "JsonApiFactOut": { "required": ["id", "type"], @@ -19592,80 +19647,15 @@ }, "description": "JSON:API representation of fact entity." }, - "JsonApiFilterContextOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiFilterContextOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiFilterContextOutList": { + "JsonApiLabelOutDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" - } - }, - "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiLabelOutWithLinks": { - "allOf": [ - { "$ref": "#/components/schemas/JsonApiLabelOut" }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiLabelOutList": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" - } - }, "links": { - "$ref": "#/components/schemas/ListLinks" - }, - "meta": { - "type": "object", - "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } + "$ref": "#/components/schemas/ObjectLinks" }, "included": { "uniqueItems": true, @@ -19675,8 +19665,7 @@ "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" } } - }, - "description": "A JSON:API document with a list of resources" + } }, "JsonApiLabelOut": { "required": ["id", "type"], @@ -19785,382 +19774,575 @@ } ] }, - "JsonApiMetricOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiMetricOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiMetricOutList": { + "JsonApiAnalyticalDashboardInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardIn" + } + } + }, + "JsonApiAnalyticalDashboardIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "analyticalDashboard", + "enum": ["analyticalDashboard"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { + "required": ["content"], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" - } - } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" - } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiUserDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiUserDataFilterOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + } + } + } } - ] + }, + "description": "JSON:API representation of analyticalDashboard entity." }, - "JsonApiUserDataFilterOutList": { + "JsonApiCustomApplicationSettingInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" + } + } + }, + "JsonApiCustomApplicationSettingIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "customApplicationSetting", + "enum": ["customApplicationSetting"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { + "required": ["applicationName", "content"], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "applicationName": { + "maxLength": 255, + "type": "string" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} } } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" - } } }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiVisualizationObjectOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "description": "JSON:API representation of customApplicationSetting entity." }, - "JsonApiVisualizationObjectOutList": { + "JsonApiDashboardPluginInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiDashboardPluginIn" + } + } + }, + "JsonApiDashboardPluginIn": { + "required": ["id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "dashboardPlugin", + "enum": ["dashboardPlugin"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "url": "" + } } } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiMetricOutIncludes" - } } }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiWorkspaceDataFilterSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "description": "JSON:API representation of dashboardPlugin entity." }, - "JsonApiWorkspaceDataFilterSettingOutList": { + "JsonApiExportDefinitionInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiExportDefinitionIn" + } + } + }, + "JsonApiExportDefinitionIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "exportDefinition", + "enum": ["exportDefinition"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { + "required": ["requestPayload"], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "requestPayload": { + "type": "object", + "description": "Free-form JSON content to be used as export request payload for /export/tabular endpoint. Maximum supported length is 15000 characters.", + "example": { + "format": "PDF", + "visualizationObjectId": "" + } + }, + "areRelationsValid": { + "type": "boolean" } } }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + "relationships": { + "type": "object", + "properties": { + "visualizationObject": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" + } + } + } } } }, - "description": "A JSON:API document with a list of resources" + "description": "JSON:API representation of exportDefinition entity." }, - "JsonApiWorkspaceDataFilterOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + "JsonApiFilterContextInDocument": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiFilterContextIn" + } + } + }, + "JsonApiFilterContextIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "filterContext", + "enum": ["filterContext"] }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" + }, + "attributes": { + "required": ["content"], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + } + } + } } - ] + }, + "description": "JSON:API representation of filterContext entity." }, - "JsonApiWorkspaceDataFilterOutList": { + "JsonApiMetricInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiMetricIn" + } + } + }, + "JsonApiMetricIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "metric", + "enum": ["metric"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { + "required": ["content"], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "required": ["maql"], + "type": "object", + "properties": { + "format": { + "maxLength": 2048, + "type": "string" + }, + "maql": { + "maxLength": 10000, + "type": "string" + } + } } } - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" - } } }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiWorkspaceSettingOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] + "description": "JSON:API representation of metric entity." }, - "JsonApiWorkspaceSettingOutList": { + "JsonApiUserDataFilterInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + } + } + }, + "JsonApiUserDataFilterIn": { + "required": ["attributes", "id", "type"], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Object type", + "example": "userDataFilter", + "enum": ["userDataFilter"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { + "required": ["maql"], "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "maql": { + "maxLength": 10000, + "type": "string" } } - } - }, - "description": "A JSON:API document with a list of resources" - }, - "JsonApiAttributeOutDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAttributeOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" + "relationships": { + "type": "object", + "properties": { + "user": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserToOneLinkage" + } + } + }, + "userGroup": { + "required": ["data"], + "type": "object", + "properties": { + "data": { + "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" + } + } + } } } - } + }, + "description": "JSON:API representation of userDataFilter entity." }, - "JsonApiDatasetOutDocument": { + "JsonApiVisualizationObjectInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiDatasetOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" - } + "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" } } }, - "JsonApiFactOutDocument": { - "required": ["data"], + "JsonApiVisualizationObjectIn": { + "required": ["attributes", "id", "type"], "type": "object", "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFactOut" + "type": { + "type": "string", + "description": "Object type", + "example": "visualizationObject", + "enum": ["visualizationObject"] }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" + "attributes": { + "required": ["content"], + "type": "object", + "properties": { + "title": { + "maxLength": 255, + "type": "string" + }, + "description": { + "maxLength": 10000, + "type": "string" + }, + "tags": { + "type": "array", + "items": { + "type": "string" + } + }, + "areRelationsValid": { + "type": "boolean" + }, + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 250000 characters.", + "example": { + "identifier": { + "id": "label.leaf", + "type": "label" + }, + "someBoolProp": false + } + } } } - } + }, + "description": "JSON:API representation of visualizationObject entity." }, - "JsonApiLabelOutDocument": { + "JsonApiWorkspaceSettingInDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiLabelOut" - }, - "links": { - "$ref": "#/components/schemas/ObjectLinks" - }, - "included": { - "uniqueItems": true, - "type": "array", - "description": "Included resources", - "items": { - "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" - } + "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" } } }, - "JsonApiColorPaletteOutWithLinks": { - "allOf": [ - { - "$ref": "#/components/schemas/JsonApiColorPaletteOut" - }, - { - "$ref": "#/components/schemas/ObjectLinksContainer" - } - ] - }, - "JsonApiColorPaletteOutList": { - "required": ["data"], + "JsonApiWorkspaceSettingIn": { + "required": ["id", "type"], "type": "object", "properties": { - "data": { - "uniqueItems": true, - "type": "array", - "items": { - "$ref": "#/components/schemas/JsonApiColorPaletteOutWithLinks" - } + "type": { + "type": "string", + "description": "Object type", + "example": "workspaceSetting", + "enum": ["workspaceSetting"] }, - "links": { - "$ref": "#/components/schemas/ListLinks" + "id": { + "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", + "type": "string", + "description": "API identifier of an object", + "example": "id1" }, - "meta": { + "attributes": { "type": "object", "properties": { - "page": { - "$ref": "#/components/schemas/PageMetadata" + "content": { + "type": "object", + "description": "Free-form JSON content. Maximum supported length is 15000 characters.", + "example": {} + }, + "type": { + "type": "string", + "enum": [ + "TIMEZONE", + "ACTIVE_THEME", + "ACTIVE_COLOR_PALETTE", + "WHITE_LABELING", + "LOCALE", + "METADATA_LOCALE", + "FORMAT_LOCALE", + "MAPBOX_TOKEN", + "WEEK_START", + "SHOW_HIDDEN_CATALOG_ITEMS", + "OPERATOR_OVERRIDES", + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" + ] } } } }, - "description": "A JSON:API document with a list of resources" + "description": "JSON:API representation of workspaceSetting entity." }, - "JsonApiCspDirectiveOutWithLinks": { + "JsonApiAnalyticalDashboardOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiCspDirectiveOut" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiCspDirectiveOutList": { + "JsonApiAnalyticalDashboardOutList": { "required": ["data"], "type": "object", "properties": { @@ -20168,7 +20350,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiCspDirectiveOutWithLinks" + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutWithLinks" } }, "links": { @@ -20181,21 +20363,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiAnalyticalDashboardOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiDataSourceIdentifierOutWithLinks": { + "JsonApiAttributeHierarchyOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOut" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiDataSourceIdentifierOutList": { + "JsonApiAttributeHierarchyOutList": { "required": ["data"], "type": "object", "properties": { @@ -20203,7 +20393,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiDataSourceIdentifierOutWithLinks" + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutWithLinks" } }, "links": { @@ -20216,21 +20406,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiAttributeHierarchyOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiDataSourceOutWithLinks": { + "JsonApiAttributeOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiDataSourceOut" + "$ref": "#/components/schemas/JsonApiAttributeOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiDataSourceOutList": { + "JsonApiAttributeOutList": { "required": ["data"], "type": "object", "properties": { @@ -20238,7 +20436,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiDataSourceOutWithLinks" + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" } }, "links": { @@ -20251,21 +20449,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiAttributeOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiEntitlementOutWithLinks": { + "JsonApiCustomApplicationSettingOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiEntitlementOut" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiEntitlementOutList": { + "JsonApiCustomApplicationSettingOutList": { "required": ["data"], "type": "object", "properties": { @@ -20273,7 +20479,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiEntitlementOutWithLinks" + "$ref": "#/components/schemas/JsonApiCustomApplicationSettingOutWithLinks" } }, "links": { @@ -20290,17 +20496,17 @@ }, "description": "A JSON:API document with a list of resources" }, - "JsonApiJwkOutWithLinks": { + "JsonApiDashboardPluginOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiJwkOut" + "$ref": "#/components/schemas/JsonApiDashboardPluginOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiJwkOutList": { + "JsonApiDashboardPluginOutList": { "required": ["data"], "type": "object", "properties": { @@ -20308,7 +20514,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiJwkOutWithLinks" + "$ref": "#/components/schemas/JsonApiDashboardPluginOutWithLinks" } }, "links": { @@ -20321,21 +20527,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiOrganizationSettingOutWithLinks": { + "JsonApiDatasetOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOut" + "$ref": "#/components/schemas/JsonApiDatasetOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiOrganizationSettingOutList": { + "JsonApiDatasetOutList": { "required": ["data"], "type": "object", "properties": { @@ -20343,7 +20557,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiOrganizationSettingOutWithLinks" + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" } }, "links": { @@ -20356,21 +20570,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiDatasetOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiThemeOutWithLinks": { + "JsonApiExportDefinitionOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiThemeOut" + "$ref": "#/components/schemas/JsonApiExportDefinitionOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiThemeOutList": { + "JsonApiExportDefinitionOutList": { "required": ["data"], "type": "object", "properties": { @@ -20378,7 +20600,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiThemeOutWithLinks" + "$ref": "#/components/schemas/JsonApiExportDefinitionOutWithLinks" } }, "links": { @@ -20391,21 +20613,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiExportDefinitionOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiUserGroupOutWithLinks": { + "JsonApiFactOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserGroupOut" + "$ref": "#/components/schemas/JsonApiFactOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserGroupOutList": { + "JsonApiFactOutList": { "required": ["data"], "type": "object", "properties": { @@ -20413,7 +20643,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiFactOutWithLinks" } }, "links": { @@ -20432,23 +20662,23 @@ "type": "array", "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiDatasetOutWithLinks" } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiUserIdentifierOutWithLinks": { + "JsonApiFilterContextOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserIdentifierOut" + "$ref": "#/components/schemas/JsonApiFilterContextOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserIdentifierOutList": { + "JsonApiFilterContextOutList": { "required": ["data"], "type": "object", "properties": { @@ -20456,7 +20686,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiUserIdentifierOutWithLinks" + "$ref": "#/components/schemas/JsonApiFilterContextOutWithLinks" } }, "links": { @@ -20469,21 +20699,29 @@ "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiFilterContextOutIncludes" + } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiUserOutWithLinks": { + "JsonApiLabelOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiUserOut" + "$ref": "#/components/schemas/JsonApiLabelOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiUserOutList": { + "JsonApiLabelOutList": { "required": ["data"], "type": "object", "properties": { @@ -20491,7 +20729,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiUserOutWithLinks" + "$ref": "#/components/schemas/JsonApiLabelOutWithLinks" } }, "links": { @@ -20510,23 +20748,23 @@ "type": "array", "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiUserGroupOutWithLinks" + "$ref": "#/components/schemas/JsonApiAttributeOutWithLinks" } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiWorkspaceOutWithLinks": { + "JsonApiMetricOutWithLinks": { "allOf": [ { - "$ref": "#/components/schemas/JsonApiWorkspaceOut" + "$ref": "#/components/schemas/JsonApiMetricOut" }, { "$ref": "#/components/schemas/ObjectLinksContainer" } ] }, - "JsonApiWorkspaceOutList": { + "JsonApiMetricOutList": { "required": ["data"], "type": "object", "properties": { @@ -20534,7 +20772,7 @@ "uniqueItems": true, "type": "array", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiMetricOutWithLinks" } }, "links": { @@ -20553,392 +20791,237 @@ "type": "array", "description": "Included resources", "items": { - "$ref": "#/components/schemas/JsonApiWorkspaceOutWithLinks" + "$ref": "#/components/schemas/JsonApiMetricOutIncludes" } } }, "description": "A JSON:API document with a list of resources" }, - "JsonApiAnalyticalDashboardInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiAnalyticalDashboardIn" - } - } - }, - "JsonApiAnalyticalDashboardIn": { - "required": ["attributes", "id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "analyticalDashboard", - "enum": ["analyticalDashboard"] - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "JsonApiUserDataFilterOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiUserDataFilterOut" }, - "attributes": { - "required": ["content"], - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - } - } - } + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - }, - "description": "JSON:API representation of analyticalDashboard entity." + ] }, - "JsonApiCustomApplicationSettingInDocument": { + "JsonApiUserDataFilterOutList": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiCustomApplicationSettingIn" - } - } - }, - "JsonApiCustomApplicationSettingIn": { - "required": ["attributes", "id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "customApplicationSetting", - "enum": ["customApplicationSetting"] + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["applicationName", "content"], + "meta": { "type": "object", "properties": { - "applicationName": { - "maxLength": 255, - "type": "string" - }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiUserDataFilterOutIncludes" + } } }, - "description": "JSON:API representation of customApplicationSetting entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiDashboardPluginInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiDashboardPluginIn" + "JsonApiVisualizationObjectOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiDashboardPluginIn": { - "required": ["id", "type"], + "JsonApiVisualizationObjectOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "dashboardPlugin", - "enum": ["dashboardPlugin"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiVisualizationObjectOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { + "meta": { "type": "object", "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "url": "" - } + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiMetricOutIncludes" + } } }, - "description": "JSON:API representation of dashboardPlugin entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiExportDefinitionInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiExportDefinitionIn" + "JsonApiWorkspaceDataFilterSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiExportDefinitionIn": { - "required": ["attributes", "id", "type"], + "JsonApiWorkspaceDataFilterSettingOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "exportDefinition", - "enum": ["exportDefinition"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["requestPayload"], + "meta": { "type": "object", "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "requestPayload": { - "type": "object", - "description": "Free-form JSON content to be used as export request payload for /export/tabular endpoint. Maximum supported length is 15000 characters.", - "example": { - "format": "PDF", - "visualizationObjectId": "" - } - }, - "areRelationsValid": { - "type": "boolean" + "page": { + "$ref": "#/components/schemas/PageMetadata" } } }, - "relationships": { - "type": "object", - "properties": { - "visualizationObject": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectToOneLinkage" - } - } - } + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" } } }, - "description": "JSON:API representation of exportDefinition entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiFilterContextInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiFilterContextIn" + "JsonApiWorkspaceDataFilterOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiFilterContextIn": { - "required": ["attributes", "id", "type"], + "JsonApiWorkspaceDataFilterOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "filterContext", - "enum": ["filterContext"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["content"], + "meta": { "type": "object", "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - } + "page": { + "$ref": "#/components/schemas/PageMetadata" } } + }, + "included": { + "uniqueItems": true, + "type": "array", + "description": "Included resources", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceDataFilterSettingOutWithLinks" + } } }, - "description": "JSON:API representation of filterContext entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiMetricInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiMetricIn" + "JsonApiWorkspaceSettingOutWithLinks": { + "allOf": [ + { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOut" + }, + { + "$ref": "#/components/schemas/ObjectLinksContainer" } - } + ] }, - "JsonApiMetricIn": { - "required": ["attributes", "id", "type"], + "JsonApiWorkspaceSettingOutList": { + "required": ["data"], "type": "object", "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "metric", - "enum": ["metric"] + "data": { + "uniqueItems": true, + "type": "array", + "items": { + "$ref": "#/components/schemas/JsonApiWorkspaceSettingOutWithLinks" + } }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" + "links": { + "$ref": "#/components/schemas/ListLinks" }, - "attributes": { - "required": ["content"], + "meta": { "type": "object", "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "content": { - "required": ["maql"], - "type": "object", - "properties": { - "format": { - "maxLength": 2048, - "type": "string" - }, - "maql": { - "maxLength": 10000, - "type": "string" - } - } + "page": { + "$ref": "#/components/schemas/PageMetadata" } } } }, - "description": "JSON:API representation of metric entity." + "description": "A JSON:API document with a list of resources" }, - "JsonApiUserDataFilterInDocument": { + "JsonApiCookieSecurityConfigurationPatchDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiUserDataFilterIn" + "$ref": "#/components/schemas/JsonApiCookieSecurityConfigurationPatch" } } }, - "JsonApiUserDataFilterIn": { - "required": ["attributes", "id", "type"], + "JsonApiCookieSecurityConfigurationPatch": { + "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "userDataFilter", - "enum": ["userDataFilter"] + "example": "cookieSecurityConfiguration", + "enum": ["cookieSecurityConfiguration"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -20947,76 +21030,40 @@ "example": "id1" }, "attributes": { - "required": ["maql"], - "type": "object", - "properties": { - "title": { - "maxLength": 255, - "type": "string" - }, - "description": { - "maxLength": 10000, - "type": "string" - }, - "tags": { - "type": "array", - "items": { - "type": "string" - } - }, - "areRelationsValid": { - "type": "boolean" - }, - "maql": { - "maxLength": 10000, - "type": "string" - } - } - }, - "relationships": { "type": "object", "properties": { - "user": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserToOneLinkage" - } - } + "lastRotation": { + "type": "string", + "format": "date-time" }, - "userGroup": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiUserGroupToOneLinkage" - } - } + "rotationInterval": { + "type": "string", + "description": "Length of interval between automatic rotations expressed in format of ISO 8601 duration", + "example": "P30D" } } } }, - "description": "JSON:API representation of userDataFilter entity." + "description": "JSON:API representation of patching cookieSecurityConfiguration entity." }, - "JsonApiVisualizationObjectInDocument": { + "JsonApiOrganizationPatchDocument": { "required": ["data"], "type": "object", "properties": { "data": { - "$ref": "#/components/schemas/JsonApiVisualizationObjectIn" + "$ref": "#/components/schemas/JsonApiOrganizationPatch" } } }, - "JsonApiVisualizationObjectIn": { - "required": ["attributes", "id", "type"], + "JsonApiOrganizationPatch": { + "required": ["id", "type"], "type": "object", "properties": { "type": { "type": "string", "description": "Object type", - "example": "visualizationObject", - "enum": ["visualizationObject"] + "example": "organization", + "enum": ["organization"] }, "id": { "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", @@ -21025,96 +21072,58 @@ "example": "id1" }, "attributes": { - "required": ["content"], "type": "object", "properties": { - "title": { + "name": { "maxLength": 255, "type": "string" }, - "description": { - "maxLength": 10000, + "hostname": { + "maxLength": 255, "type": "string" }, - "tags": { + "allowedOrigins": { "type": "array", "items": { "type": "string" } }, - "areRelationsValid": { - "type": "boolean" + "oauthIssuerLocation": { + "maxLength": 255, + "type": "string" }, - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 250000 characters.", - "example": { - "identifier": { - "id": "label.leaf", - "type": "label" - }, - "someBoolProp": false - } - } - } - } - }, - "description": "JSON:API representation of visualizationObject entity." - }, - "JsonApiWorkspaceSettingInDocument": { - "required": ["data"], - "type": "object", - "properties": { - "data": { - "$ref": "#/components/schemas/JsonApiWorkspaceSettingIn" - } - } - }, - "JsonApiWorkspaceSettingIn": { - "required": ["id", "type"], - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Object type", - "example": "workspaceSetting", - "enum": ["workspaceSetting"] - }, - "id": { - "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$", - "type": "string", - "description": "API identifier of an object", - "example": "id1" - }, - "attributes": { - "type": "object", - "properties": { - "content": { - "type": "object", - "description": "Free-form JSON content. Maximum supported length is 15000 characters.", - "example": {} + "oauthClientId": { + "maxLength": 255, + "type": "string" }, - "type": { + "oauthClientSecret": { + "maxLength": 255, + "type": "string" + }, + "earlyAccess": { + "maxLength": 255, + "type": "string" + }, + "oauthIssuerId": { + "maxLength": 255, "type": "string", - "enum": [ - "TIMEZONE", - "ACTIVE_THEME", - "ACTIVE_COLOR_PALETTE", - "WHITE_LABELING", - "LOCALE", - "METADATA_LOCALE", - "FORMAT_LOCALE", - "MAPBOX_TOKEN", - "WEEK_START", - "SHOW_HIDDEN_CATALOG_ITEMS", - "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" - ] + "description": "Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.", + "example": "myOidcProvider" + }, + "oauthSubjectIdClaim": { + "maxLength": 255, + "type": "string", + "description": "Any string identifying the claim in ID token, that should be used for user identification. The default value is 'sub'.", + "example": "oid" + }, + "jitEnabled": { + "type": "boolean", + "description": "Flag to enable/disable JIT provisioning in the given organization" } } } }, - "description": "JSON:API representation of workspaceSetting entity." + "description": "JSON:API representation of patching organization entity." }, "DeclarativeUserDataFilter": { "required": ["id", "maql", "title"], @@ -22466,7 +22475,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } }, @@ -23593,7 +23603,8 @@ "WEEK_START", "SHOW_HIDDEN_CATALOG_ITEMS", "OPERATOR_OVERRIDES", - "TIMEZONE_VALIDATION_ENABLED" + "TIMEZONE_VALIDATION_ENABLED", + "OPENAI_CONFIG" ] } }, @@ -23978,8 +23989,7 @@ "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", - "UserTelemetryDisabled", - "ExperimentalFeatures" + "UserTelemetryDisabled" ] } } @@ -24006,8 +24016,7 @@ "UnlimitedWorkspaces", "WhiteLabeling", "WorkspaceCount", - "UserTelemetryDisabled", - "ExperimentalFeatures" + "UserTelemetryDisabled" ] }, "value": { diff --git a/libs/api-client-tiger/src/generated/result-json-api/api.ts b/libs/api-client-tiger/src/generated/result-json-api/api.ts index 94220fe9be2..4ce2e4607f7 100644 --- a/libs/api-client-tiger/src/generated/result-json-api/api.ts +++ b/libs/api-client-tiger/src/generated/result-json-api/api.ts @@ -414,6 +414,19 @@ export interface CsvReadOptions { */ encoding?: string; } +/** + * Request to delete files from the storage. + * @export + * @interface DeleteFilesRequest + */ +export interface DeleteFilesRequest { + /** + * Names of the files to delete. + * @type {Array} + * @memberof DeleteFilesRequest + */ + fileNames: Array; +} /** * File stored in GD Storage. * @export @@ -622,6 +635,19 @@ export interface StagingUploadLocation { */ uploadUrl: string; } +/** + * Information related to the file uploaded to the staging area. + * @export + * @interface UploadFileResponse + */ +export interface UploadFileResponse { + /** + * Location to use when referencing the uploaded file in subsequent requests. + * @type {string} + * @memberof UploadFileResponse + */ + location: string; +} /** * Cache settings for the workspace. * @export @@ -781,6 +807,58 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {string} dataSourceId + * @param {DeleteFilesRequest} deleteFilesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFiles: async ( + dataSourceId: string, + deleteFilesRequest: DeleteFilesRequest, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'dataSourceId' is not null or undefined + assertParamExists("deleteFiles", "dataSourceId", dataSourceId); + // verify required parameter 'deleteFilesRequest' is not null or undefined + assertParamExists("deleteFiles", "deleteFilesRequest", deleteFilesRequest); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/deleteFiles`.replace( + `{${"dataSourceId"}}`, + encodeURIComponent(String(dataSourceId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + const needsSerialization = + typeof deleteFilesRequest !== "string" || + localVarRequestOptions.headers["Content-Type"] === "application/json"; + localVarRequestOptions.data = needsSerialization + ? JSON.stringify(deleteFilesRequest !== undefined ? deleteFilesRequest : {}) + : deleteFilesRequest || ""; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Provides a location for uploading staging files. * @summary Get a staging upload location @@ -905,6 +983,58 @@ export const ActionsApiAxiosParamCreator = function (configuration?: Configurati ...options.headers, }; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {string} dataSourceId + * @param {any} file The file to upload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stagingUpload: async ( + dataSourceId: string, + file: any, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'dataSourceId' is not null or undefined + assertParamExists("stagingUpload", "dataSourceId", dataSourceId); + // verify required parameter 'file' is not null or undefined + assertParamExists("stagingUpload", "file", file); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/staging/uploadFile`.replace( + `{${"dataSourceId"}}`, + encodeURIComponent(String(dataSourceId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + if (file !== undefined) { + localVarFormParams.append("file", file as any); + } + + localVarHeaderParameter["Content-Type"] = "multipart/form-data"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = localVarFormParams; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -952,6 +1082,26 @@ export const ActionsApiFp = function (configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.collectCacheUsage(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {string} dataSourceId + * @param {DeleteFilesRequest} deleteFilesRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async deleteFiles( + dataSourceId: string, + deleteFilesRequest: DeleteFilesRequest, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFiles( + dataSourceId, + deleteFilesRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Provides a location for uploading staging files. * @summary Get a staging upload location @@ -1003,6 +1153,26 @@ export const ActionsApiFp = function (configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.listFiles(dataSourceId, options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {string} dataSourceId + * @param {any} file The file to upload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stagingUpload( + dataSourceId: string, + file: any, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stagingUpload( + dataSourceId, + file, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, }; }; @@ -1041,6 +1211,21 @@ export const ActionsApiFactory = function ( collectCacheUsage(options?: AxiosRequestConfig): AxiosPromise { return localVarFp.collectCacheUsage(options).then((request) => request(axios, basePath)); }, + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {ActionsApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFiles( + requestParameters: ActionsApiDeleteFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .deleteFiles(requestParameters.dataSourceId, requestParameters.deleteFilesRequest, options) + .then((request) => request(axios, basePath)); + }, /** * Provides a location for uploading staging files. * @summary Get a staging upload location @@ -1086,6 +1271,21 @@ export const ActionsApiFactory = function ( .listFiles(requestParameters.dataSourceId, options) .then((request) => request(axios, basePath)); }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {ActionsApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stagingUpload( + requestParameters: ActionsApiStagingUploadRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .stagingUpload(requestParameters.dataSourceId, requestParameters.file, options) + .then((request) => request(axios, basePath)); + }, }; }; @@ -1117,6 +1317,19 @@ export interface ActionsApiInterface { */ collectCacheUsage(options?: AxiosRequestConfig): AxiosPromise; + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {ActionsApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApiInterface + */ + deleteFiles( + requestParameters: ActionsApiDeleteFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; + /** * Provides a location for uploading staging files. * @summary Get a staging upload location @@ -1155,6 +1368,19 @@ export interface ActionsApiInterface { requestParameters: ActionsApiListFilesRequest, options?: AxiosRequestConfig, ): AxiosPromise>; + + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {ActionsApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApiInterface + */ + stagingUpload( + requestParameters: ActionsApiStagingUploadRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; } /** @@ -1178,6 +1404,27 @@ export interface ActionsApiAnalyzeCsvRequest { readonly analyzeCsvRequest: AnalyzeCsvRequest; } +/** + * Request parameters for deleteFiles operation in ActionsApi. + * @export + * @interface ActionsApiDeleteFilesRequest + */ +export interface ActionsApiDeleteFilesRequest { + /** + * + * @type {string} + * @memberof ActionsApiDeleteFiles + */ + readonly dataSourceId: string; + + /** + * + * @type {DeleteFilesRequest} + * @memberof ActionsApiDeleteFiles + */ + readonly deleteFilesRequest: DeleteFilesRequest; +} + /** * Request parameters for getStagingUploadLocation operation in ActionsApi. * @export @@ -1227,6 +1474,27 @@ export interface ActionsApiListFilesRequest { readonly dataSourceId: string; } +/** + * Request parameters for stagingUpload operation in ActionsApi. + * @export + * @interface ActionsApiStagingUploadRequest + */ +export interface ActionsApiStagingUploadRequest { + /** + * + * @type {string} + * @memberof ActionsApiStagingUpload + */ + readonly dataSourceId: string; + + /** + * The file to upload. + * @type {any} + * @memberof ActionsApiStagingUpload + */ + readonly file: any; +} + /** * ActionsApi - object-oriented interface * @export @@ -1261,6 +1529,20 @@ export class ActionsApi extends BaseAPI implements ActionsApiInterface { .then((request) => request(this.axios, this.basePath)); } + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {ActionsApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApi + */ + public deleteFiles(requestParameters: ActionsApiDeleteFilesRequest, options?: AxiosRequestConfig) { + return ActionsApiFp(this.configuration) + .deleteFiles(requestParameters.dataSourceId, requestParameters.deleteFilesRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + /** * Provides a location for uploading staging files. * @summary Get a staging upload location @@ -1305,6 +1587,20 @@ export class ActionsApi extends BaseAPI implements ActionsApiInterface { .listFiles(requestParameters.dataSourceId, options) .then((request) => request(this.axios, this.basePath)); } + + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {ActionsApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof ActionsApi + */ + public stagingUpload(requestParameters: ActionsApiStagingUploadRequest, options?: AxiosRequestConfig) { + return ActionsApiFp(this.configuration) + .stagingUpload(requestParameters.dataSourceId, requestParameters.file, options) + .then((request) => request(this.axios, this.basePath)); + } } /** @@ -1616,29 +1912,29 @@ export class DataSourceFilesAnalysisApi extends BaseAPI implements DataSourceFil } /** - * DataSourceFilesImportApi - axios parameter creator + * DataSourceFilesDeletionApi - axios parameter creator * @export */ -export const DataSourceFilesImportApiAxiosParamCreator = function (configuration?: Configuration) { +export const DataSourceFilesDeletionApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * Import the CSV files at the given locations in the staging area to the final location. - * @summary Import CSV + * Delete the files in the given data source. + * @summary Delete datasource files * @param {string} dataSourceId - * @param {ImportCsvRequest} importCsvRequest + * @param {DeleteFilesRequest} deleteFilesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - importCsv: async ( + deleteFiles: async ( dataSourceId: string, - importCsvRequest: ImportCsvRequest, + deleteFilesRequest: DeleteFilesRequest, options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'dataSourceId' is not null or undefined - assertParamExists("importCsv", "dataSourceId", dataSourceId); - // verify required parameter 'importCsvRequest' is not null or undefined - assertParamExists("importCsv", "importCsvRequest", importCsvRequest); - const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/import`.replace( + assertParamExists("deleteFiles", "dataSourceId", dataSourceId); + // verify required parameter 'deleteFilesRequest' is not null or undefined + assertParamExists("deleteFiles", "deleteFilesRequest", deleteFilesRequest); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/deleteFiles`.replace( `{${"dataSourceId"}}`, encodeURIComponent(String(dataSourceId)), ); @@ -1662,48 +1958,11 @@ export const DataSourceFilesImportApiAxiosParamCreator = function (configuration ...options.headers, }; const needsSerialization = - typeof importCsvRequest !== "string" || + typeof deleteFilesRequest !== "string" || localVarRequestOptions.headers["Content-Type"] === "application/json"; localVarRequestOptions.data = needsSerialization - ? JSON.stringify(importCsvRequest !== undefined ? importCsvRequest : {}) - : importCsvRequest || ""; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, - /** - * List all the files in the given data source. - * @summary List datasource files - * @param {string} dataSourceId - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listFiles: async (dataSourceId: string, options: AxiosRequestConfig = {}): Promise => { - // verify required parameter 'dataSourceId' is not null or undefined - assertParamExists("listFiles", "dataSourceId", dataSourceId); - const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/listFiles`.replace( - `{${"dataSourceId"}}`, - encodeURIComponent(String(dataSourceId)), - ); - // use dummy base URL string because the URL constructor only accepts absolute URLs. - const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); - let baseOptions; - if (configuration) { - baseOptions = configuration.baseOptions; - } - const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - setSearchParams(localVarUrlObj, localVarQueryParameter); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers, - }; + ? JSON.stringify(deleteFilesRequest !== undefined ? deleteFilesRequest : {}) + : deleteFilesRequest || ""; return { url: toPathString(localVarUrlObj), @@ -1714,44 +1973,216 @@ export const DataSourceFilesImportApiAxiosParamCreator = function (configuration }; /** - * DataSourceFilesImportApi - functional programming interface + * DataSourceFilesDeletionApi - functional programming interface * @export */ -export const DataSourceFilesImportApiFp = function (configuration?: Configuration) { - const localVarAxiosParamCreator = DataSourceFilesImportApiAxiosParamCreator(configuration); +export const DataSourceFilesDeletionApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = DataSourceFilesDeletionApiAxiosParamCreator(configuration); return { /** - * Import the CSV files at the given locations in the staging area to the final location. - * @summary Import CSV + * Delete the files in the given data source. + * @summary Delete datasource files * @param {string} dataSourceId - * @param {ImportCsvRequest} importCsvRequest + * @param {DeleteFilesRequest} deleteFilesRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async importCsv( + async deleteFiles( dataSourceId: string, - importCsvRequest: ImportCsvRequest, + deleteFilesRequest: DeleteFilesRequest, options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.importCsv( + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteFiles( dataSourceId, - importCsvRequest, + deleteFilesRequest, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + }; +}; + +/** + * DataSourceFilesDeletionApi - factory interface + * @export + */ +export const DataSourceFilesDeletionApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = DataSourceFilesDeletionApiFp(configuration); + return { /** - * List all the files in the given data source. - * @summary List datasource files + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {DataSourceFilesDeletionApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + deleteFiles( + requestParameters: DataSourceFilesDeletionApiDeleteFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .deleteFiles(requestParameters.dataSourceId, requestParameters.deleteFilesRequest, options) + .then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DataSourceFilesDeletionApi - interface + * @export + * @interface DataSourceFilesDeletionApi + */ +export interface DataSourceFilesDeletionApiInterface { + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {DataSourceFilesDeletionApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DataSourceFilesDeletionApiInterface + */ + deleteFiles( + requestParameters: DataSourceFilesDeletionApiDeleteFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; +} + +/** + * Request parameters for deleteFiles operation in DataSourceFilesDeletionApi. + * @export + * @interface DataSourceFilesDeletionApiDeleteFilesRequest + */ +export interface DataSourceFilesDeletionApiDeleteFilesRequest { + /** + * + * @type {string} + * @memberof DataSourceFilesDeletionApiDeleteFiles + */ + readonly dataSourceId: string; + + /** + * + * @type {DeleteFilesRequest} + * @memberof DataSourceFilesDeletionApiDeleteFiles + */ + readonly deleteFilesRequest: DeleteFilesRequest; +} + +/** + * DataSourceFilesDeletionApi - object-oriented interface + * @export + * @class DataSourceFilesDeletionApi + * @extends {BaseAPI} + */ +export class DataSourceFilesDeletionApi extends BaseAPI implements DataSourceFilesDeletionApiInterface { + /** + * Delete the files in the given data source. + * @summary Delete datasource files + * @param {DataSourceFilesDeletionApiDeleteFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DataSourceFilesDeletionApi + */ + public deleteFiles( + requestParameters: DataSourceFilesDeletionApiDeleteFilesRequest, + options?: AxiosRequestConfig, + ) { + return DataSourceFilesDeletionApiFp(this.configuration) + .deleteFiles(requestParameters.dataSourceId, requestParameters.deleteFilesRequest, options) + .then((request) => request(this.axios, this.basePath)); + } +} + +/** + * DataSourceFilesImportApi - axios parameter creator + * @export + */ +export const DataSourceFilesImportApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * Import the CSV files at the given locations in the staging area to the final location. + * @summary Import CSV * @param {string} dataSourceId + * @param {ImportCsvRequest} importCsvRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listFiles( + importCsv: async ( + dataSourceId: string, + importCsvRequest: ImportCsvRequest, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'dataSourceId' is not null or undefined + assertParamExists("importCsv", "dataSourceId", dataSourceId); + // verify required parameter 'importCsvRequest' is not null or undefined + assertParamExists("importCsv", "importCsvRequest", importCsvRequest); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/import`.replace( + `{${"dataSourceId"}}`, + encodeURIComponent(String(dataSourceId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + localVarHeaderParameter["Content-Type"] = "application/json"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + const needsSerialization = + typeof importCsvRequest !== "string" || + localVarRequestOptions.headers["Content-Type"] === "application/json"; + localVarRequestOptions.data = needsSerialization + ? JSON.stringify(importCsvRequest !== undefined ? importCsvRequest : {}) + : importCsvRequest || ""; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + }; +}; + +/** + * DataSourceFilesImportApi - functional programming interface + * @export + */ +export const DataSourceFilesImportApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = DataSourceFilesImportApiAxiosParamCreator(configuration); + return { + /** + * Import the CSV files at the given locations in the staging area to the final location. + * @summary Import CSV + * @param {string} dataSourceId + * @param {ImportCsvRequest} importCsvRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async importCsv( dataSourceId: string, + importCsvRequest: ImportCsvRequest, options?: AxiosRequestConfig, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listFiles(dataSourceId, options); + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.importCsv( + dataSourceId, + importCsvRequest, + options, + ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, }; @@ -1783,21 +2214,6 @@ export const DataSourceFilesImportApiFactory = function ( .importCsv(requestParameters.dataSourceId, requestParameters.importCsvRequest, options) .then((request) => request(axios, basePath)); }, - /** - * List all the files in the given data source. - * @summary List datasource files - * @param {DataSourceFilesImportApiListFilesRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - listFiles( - requestParameters: DataSourceFilesImportApiListFilesRequest, - options?: AxiosRequestConfig, - ): AxiosPromise> { - return localVarFp - .listFiles(requestParameters.dataSourceId, options) - .then((request) => request(axios, basePath)); - }, }; }; @@ -1819,19 +2235,6 @@ export interface DataSourceFilesImportApiInterface { requestParameters: DataSourceFilesImportApiImportCsvRequest, options?: AxiosRequestConfig, ): AxiosPromise; - - /** - * List all the files in the given data source. - * @summary List datasource files - * @param {DataSourceFilesImportApiListFilesRequest} requestParameters Request parameters. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof DataSourceFilesImportApiInterface - */ - listFiles( - requestParameters: DataSourceFilesImportApiListFilesRequest, - options?: AxiosRequestConfig, - ): AxiosPromise>; } /** @@ -1855,20 +2258,6 @@ export interface DataSourceFilesImportApiImportCsvRequest { readonly importCsvRequest: ImportCsvRequest; } -/** - * Request parameters for listFiles operation in DataSourceFilesImportApi. - * @export - * @interface DataSourceFilesImportApiListFilesRequest - */ -export interface DataSourceFilesImportApiListFilesRequest { - /** - * - * @type {string} - * @memberof DataSourceFilesImportApiListFiles - */ - readonly dataSourceId: string; -} - /** * DataSourceFilesImportApi - object-oriented interface * @export @@ -1892,20 +2281,161 @@ export class DataSourceFilesImportApi extends BaseAPI implements DataSourceFiles .importCsv(requestParameters.dataSourceId, requestParameters.importCsvRequest, options) .then((request) => request(this.axios, this.basePath)); } +} +/** + * DataSourceFilesListingApi - axios parameter creator + * @export + */ +export const DataSourceFilesListingApiAxiosParamCreator = function (configuration?: Configuration) { + return { + /** + * List all the files in the given data source. + * @summary List datasource files + * @param {string} dataSourceId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listFiles: async (dataSourceId: string, options: AxiosRequestConfig = {}): Promise => { + // verify required parameter 'dataSourceId' is not null or undefined + assertParamExists("listFiles", "dataSourceId", dataSourceId); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/listFiles`.replace( + `{${"dataSourceId"}}`, + encodeURIComponent(String(dataSourceId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + }; +}; + +/** + * DataSourceFilesListingApi - functional programming interface + * @export + */ +export const DataSourceFilesListingApiFp = function (configuration?: Configuration) { + const localVarAxiosParamCreator = DataSourceFilesListingApiAxiosParamCreator(configuration); + return { + /** + * List all the files in the given data source. + * @summary List datasource files + * @param {string} dataSourceId + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async listFiles( + dataSourceId: string, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listFiles(dataSourceId, options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + }; +}; + +/** + * DataSourceFilesListingApi - factory interface + * @export + */ +export const DataSourceFilesListingApiFactory = function ( + configuration?: Configuration, + basePath?: string, + axios?: AxiosInstance, +) { + const localVarFp = DataSourceFilesListingApiFp(configuration); + return { + /** + * List all the files in the given data source. + * @summary List datasource files + * @param {DataSourceFilesListingApiListFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + listFiles( + requestParameters: DataSourceFilesListingApiListFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise> { + return localVarFp + .listFiles(requestParameters.dataSourceId, options) + .then((request) => request(axios, basePath)); + }, + }; +}; + +/** + * DataSourceFilesListingApi - interface + * @export + * @interface DataSourceFilesListingApi + */ +export interface DataSourceFilesListingApiInterface { /** * List all the files in the given data source. * @summary List datasource files - * @param {DataSourceFilesImportApiListFilesRequest} requestParameters Request parameters. + * @param {DataSourceFilesListingApiListFilesRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} - * @memberof DataSourceFilesImportApi + * @memberof DataSourceFilesListingApiInterface + */ + listFiles( + requestParameters: DataSourceFilesListingApiListFilesRequest, + options?: AxiosRequestConfig, + ): AxiosPromise>; +} + +/** + * Request parameters for listFiles operation in DataSourceFilesListingApi. + * @export + * @interface DataSourceFilesListingApiListFilesRequest + */ +export interface DataSourceFilesListingApiListFilesRequest { + /** + * + * @type {string} + * @memberof DataSourceFilesListingApiListFiles + */ + readonly dataSourceId: string; +} + +/** + * DataSourceFilesListingApi - object-oriented interface + * @export + * @class DataSourceFilesListingApi + * @extends {BaseAPI} + */ +export class DataSourceFilesListingApi extends BaseAPI implements DataSourceFilesListingApiInterface { + /** + * List all the files in the given data source. + * @summary List datasource files + * @param {DataSourceFilesListingApiListFilesRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DataSourceFilesListingApi */ public listFiles( - requestParameters: DataSourceFilesImportApiListFilesRequest, + requestParameters: DataSourceFilesListingApiListFilesRequest, options?: AxiosRequestConfig, ) { - return DataSourceFilesImportApiFp(this.configuration) + return DataSourceFilesListingApiFp(this.configuration) .listFiles(requestParameters.dataSourceId, options) .then((request) => request(this.axios, this.basePath)); } @@ -1952,6 +2482,58 @@ export const DataSourceStagingLocationApiAxiosParamCreator = function (configura ...options.headers, }; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {string} dataSourceId + * @param {any} file The file to upload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stagingUpload: async ( + dataSourceId: string, + file: any, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'dataSourceId' is not null or undefined + assertParamExists("stagingUpload", "dataSourceId", dataSourceId); + // verify required parameter 'file' is not null or undefined + assertParamExists("stagingUpload", "file", file); + const localVarPath = `/api/v1/actions/dataSources/{dataSourceId}/staging/uploadFile`.replace( + `{${"dataSourceId"}}`, + encodeURIComponent(String(dataSourceId)), + ); + // use dummy base URL string because the URL constructor only accepts absolute URLs. + const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); + let baseOptions; + if (configuration) { + baseOptions = configuration.baseOptions; + } + const localVarRequestOptions = { method: "POST", ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + const localVarFormParams = new ((configuration && configuration.formDataCtor) || FormData)(); + + if (file !== undefined) { + localVarFormParams.append("file", file as any); + } + + localVarHeaderParameter["Content-Type"] = "multipart/form-data"; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = localVarFormParams; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -1984,6 +2566,26 @@ export const DataSourceStagingLocationApiFp = function (configuration?: Configur ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {string} dataSourceId + * @param {any} file The file to upload. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async stagingUpload( + dataSourceId: string, + file: any, + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.stagingUpload( + dataSourceId, + file, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, }; }; @@ -2013,6 +2615,21 @@ export const DataSourceStagingLocationApiFactory = function ( .getStagingUploadLocation(requestParameters.dataSourceId, options) .then((request) => request(axios, basePath)); }, + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {DataSourceStagingLocationApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + stagingUpload( + requestParameters: DataSourceStagingLocationApiStagingUploadRequest, + options?: AxiosRequestConfig, + ): AxiosPromise { + return localVarFp + .stagingUpload(requestParameters.dataSourceId, requestParameters.file, options) + .then((request) => request(axios, basePath)); + }, }; }; @@ -2034,6 +2651,19 @@ export interface DataSourceStagingLocationApiInterface { requestParameters: DataSourceStagingLocationApiGetStagingUploadLocationRequest, options?: AxiosRequestConfig, ): AxiosPromise; + + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {DataSourceStagingLocationApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DataSourceStagingLocationApiInterface + */ + stagingUpload( + requestParameters: DataSourceStagingLocationApiStagingUploadRequest, + options?: AxiosRequestConfig, + ): AxiosPromise; } /** @@ -2050,6 +2680,27 @@ export interface DataSourceStagingLocationApiGetStagingUploadLocationRequest { readonly dataSourceId: string; } +/** + * Request parameters for stagingUpload operation in DataSourceStagingLocationApi. + * @export + * @interface DataSourceStagingLocationApiStagingUploadRequest + */ +export interface DataSourceStagingLocationApiStagingUploadRequest { + /** + * + * @type {string} + * @memberof DataSourceStagingLocationApiStagingUpload + */ + readonly dataSourceId: string; + + /** + * The file to upload. + * @type {any} + * @memberof DataSourceStagingLocationApiStagingUpload + */ + readonly file: any; +} + /** * DataSourceStagingLocationApi - object-oriented interface * @export @@ -2073,4 +2724,21 @@ export class DataSourceStagingLocationApi extends BaseAPI implements DataSourceS .getStagingUploadLocation(requestParameters.dataSourceId, options) .then((request) => request(this.axios, this.basePath)); } + + /** + * Provides a location for uploading staging files. + * @summary Upload a file to the staging area + * @param {DataSourceStagingLocationApiStagingUploadRequest} requestParameters Request parameters. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DataSourceStagingLocationApi + */ + public stagingUpload( + requestParameters: DataSourceStagingLocationApiStagingUploadRequest, + options?: AxiosRequestConfig, + ) { + return DataSourceStagingLocationApiFp(this.configuration) + .stagingUpload(requestParameters.dataSourceId, requestParameters.file, options) + .then((request) => request(this.axios, this.basePath)); + } } diff --git a/libs/api-client-tiger/src/generated/result-json-api/openapi-spec.json b/libs/api-client-tiger/src/generated/result-json-api/openapi-spec.json index e944c802d15..f1808823fa9 100644 --- a/libs/api-client-tiger/src/generated/result-json-api/openapi-spec.json +++ b/libs/api-client-tiger/src/generated/result-json-api/openapi-spec.json @@ -21,6 +21,57 @@ } ], "paths": { + "/api/v1/actions/dataSources/{dataSourceId}/staging/uploadFile": { + "post": { + "tags": ["Data source staging location", "actions"], + "summary": "Upload a file to the staging area", + "description": "Provides a location for uploading staging files.", + "operationId": "stagingUpload", + "parameters": [ + { + "name": "dataSourceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "multipart/form-data": { + "schema": { + "required": ["file"], + "type": "object", + "properties": { + "file": { + "type": "string", + "description": "The file to upload.", + "format": "binary" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Upload was successful.", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UploadFileResponse" + } + } + } + } + }, + "x-gdc-security-info": { + "permissions": ["MANAGE"], + "description": "Minimal permission required to use this endpoint." + } + } + }, "/api/v1/actions/dataSources/{dataSourceId}/staging/upload": { "post": { "tags": ["Data source staging location", "actions"], @@ -57,7 +108,7 @@ }, "/api/v1/actions/dataSources/{dataSourceId}/listFiles": { "post": { - "tags": ["Data source files import", "actions"], + "tags": ["Data source files listing", "actions"], "summary": "List datasource files", "description": "List all the files in the given data source.", "operationId": "listFiles", @@ -129,6 +180,43 @@ } } }, + "/api/v1/actions/dataSources/{dataSourceId}/deleteFiles": { + "post": { + "tags": ["Data source files deletion", "actions"], + "summary": "Delete datasource files", + "description": "Delete the files in the given data source.", + "operationId": "deleteFiles", + "parameters": [ + { + "name": "dataSourceId", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DeleteFilesRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "Successful deletion." + } + }, + "x-gdc-security-info": { + "permissions": ["MANAGE"], + "description": "Minimal permission required to use this endpoint." + } + } + }, "/api/v1/actions/dataSources/{dataSourceId}/analyze": { "post": { "tags": ["Data source files analysis", "actions"], @@ -203,6 +291,17 @@ }, "components": { "schemas": { + "UploadFileResponse": { + "required": ["location"], + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "Location to use when referencing the uploaded file in subsequent requests." + } + }, + "description": "Information related to the file uploaded to the staging area." + }, "StagingUploadLocation": { "required": ["location", "uploadUrl"], "type": "object", @@ -485,6 +584,21 @@ }, "description": "Config to use when accessing the data for executions, etc." }, + "DeleteFilesRequest": { + "required": ["fileNames"], + "type": "object", + "properties": { + "fileNames": { + "type": "array", + "description": "Names of the files to delete.", + "items": { + "type": "string", + "description": "Names of the files to delete." + } + } + }, + "description": "Request to delete files from the storage." + }, "AnalyzeCsvRequest": { "required": ["analyzeRequests"], "type": "object", diff --git a/libs/api-client-tiger/src/index.ts b/libs/api-client-tiger/src/index.ts index 0d9f0c4ea76..3218cfabb13 100644 --- a/libs/api-client-tiger/src/index.ts +++ b/libs/api-client-tiger/src/index.ts @@ -189,6 +189,10 @@ export { KeyDriversDimension, KeyDriversDimensionGranularityEnum, KeyDriversDimensionValueTypeEnum, + AnomalyDetectionRequest, + ActionsApiAnomalyDetectionRequest, + ActionsApiAnomalyDetectionResultRequest, + AnomalyDetectionResult, } from "./generated/afm-rest-api/api.js"; export { ActionsApiFactory as AuthActionsApiFactory, @@ -285,6 +289,10 @@ export { WorkspaceCacheSettings, WorkspaceCacheUsage, WorkspaceCurrentCacheUsage, + ActionsApiDeleteFilesRequest, + ActionsApiStagingUploadRequest, + UploadFileResponse, + DeleteFilesRequest, } from "./generated/result-json-api/api.js"; export * from "./client.js"; diff --git a/libs/sdk-backend-spi/api/sdk-backend-spi.api.md b/libs/sdk-backend-spi/api/sdk-backend-spi.api.md index 0ce02711b66..bf384459fcb 100644 --- a/libs/sdk-backend-spi/api/sdk-backend-spi.api.md +++ b/libs/sdk-backend-spi/api/sdk-backend-spi.api.md @@ -1032,6 +1032,7 @@ export interface IWorkspaceDatasetsService { export interface IWorkspaceDescriptor { // (undocumented) description: string; + earlyAccess?: string; // (undocumented) id: string; // (undocumented) diff --git a/libs/sdk-backend-spi/src/workspace/index.ts b/libs/sdk-backend-spi/src/workspace/index.ts index c68d0d534b5..6c1b3d92389 100644 --- a/libs/sdk-backend-spi/src/workspace/index.ts +++ b/libs/sdk-backend-spi/src/workspace/index.ts @@ -156,6 +156,10 @@ export interface IWorkspaceDescriptor { * Prefixes of parent workspaces */ parentPrefixes?: string[]; + /** + * Early access attribute value of the workspace + */ + earlyAccess?: string; } /** diff --git a/libs/sdk-backend-tiger/src/backend/features/feature.ts b/libs/sdk-backend-tiger/src/backend/features/feature.ts index 040b22fe6d1..ad9b0c1e1f7 100644 --- a/libs/sdk-backend-tiger/src/backend/features/feature.ts +++ b/libs/sdk-backend-tiger/src/backend/features/feature.ts @@ -282,6 +282,48 @@ export function mapFeatures(features: FeaturesMap): Partial "BOOLEAN", FeatureFlagsValues.enableOracleDataSource, ), + ...loadFeature( + features, + TigerFeaturesNames.EnableAnalyticalCatalog, + "enableAnalyticalCatalog", + "BOOLEAN", + FeatureFlagsValues.enableAnalyticalCatalog, + ), + ...loadFeature( + features, + TigerFeaturesNames.EnableAlerting, + "enableAlerting", + "BOOLEAN", + FeatureFlagsValues.enableAlerting, + ), + ...loadFeature( + features, + TigerFeaturesNames.EnableLabsSmartFunctions, + "enableLabsSmartFunctions", + "BOOLEAN", + FeatureFlagsValues.enableLabsSmartFunctions, + ), + ...loadFeature( + features, + TigerFeaturesNames.EnableKeyDriverAnalysis, + "enableKeyDriverAnalysis", + "BOOLEAN", + FeatureFlagsValues.enableKeyDriverAnalysis, + ), + ...loadFeature( + features, + TigerFeaturesNames.EnableDataProfiling, + "enableDataProfiling", + "BOOLEAN", + FeatureFlagsValues.enableDataProfiling, + ), + ...loadFeature( + features, + TigerFeaturesNames.EnableExperimentalFeaturesUI, + "enableExperimentalFeaturesUI", + "BOOLEAN", + FeatureFlagsValues.enableExperimentalFeaturesUI, + ), }; } diff --git a/libs/sdk-backend-tiger/src/backend/features/index.ts b/libs/sdk-backend-tiger/src/backend/features/index.ts index 66e757e04d1..b5291b07bc0 100644 --- a/libs/sdk-backend-tiger/src/backend/features/index.ts +++ b/libs/sdk-backend-tiger/src/backend/features/index.ts @@ -4,7 +4,7 @@ import { IUserProfile, ILiveFeatures, FeatureContext, - JsonApiWorkspacePatchAttributes, + DeclarativeWorkspace, } from "@gooddata/api-client-tiger"; import { LRUCache } from "lru-cache"; import { TigerAuthenticatedCallGuard } from "../../types/index.js"; @@ -73,7 +73,7 @@ function featuresAreStatic(item: any): item is IStaticFeatures { } export function pickContext( - attributes: JsonApiWorkspacePatchAttributes | undefined, + attributes: Partial | undefined, organizationId: string | undefined, ): Partial { const context: Partial = {}; diff --git a/libs/sdk-backend-tiger/src/backend/organization/index.ts b/libs/sdk-backend-tiger/src/backend/organization/index.ts index 83af9c394ed..00b7097a394 100644 --- a/libs/sdk-backend-tiger/src/backend/organization/index.ts +++ b/libs/sdk-backend-tiger/src/backend/organization/index.ts @@ -1,4 +1,4 @@ -// (C) 2021-2022 GoodData Corporation +// (C) 2021-2024 GoodData Corporation import { IOrganization, @@ -55,6 +55,7 @@ export class TigerOrganization implements IOrganization { title: organizationName, bootstrapUser: idRef(bootstrapUser.id, bootstrapUser.type), bootstrapUserGroup: idRef(bootstrapUserGroup.id, bootstrapUserGroup.type), + earlyAccess: result.data.data.attributes?.earlyAccess, }; } diff --git a/libs/sdk-backend-tiger/src/backend/uiFeatures.ts b/libs/sdk-backend-tiger/src/backend/uiFeatures.ts index 804fe2245b8..6926a7b3de0 100644 --- a/libs/sdk-backend-tiger/src/backend/uiFeatures.ts +++ b/libs/sdk-backend-tiger/src/backend/uiFeatures.ts @@ -77,6 +77,12 @@ export enum TigerFeaturesNames { EnableMultipleCSVs = "enableMultipleCSVs", //boolean EnableOracleDataSource = "enableOracleDataSource", + EnableAnalyticalCatalog = "enableAnalyticalCatalog", + EnableAlerting = "enableAlerting", + EnableLabsSmartFunctions = "enableLabsSmartFunctions", + EnableKeyDriverAnalysis = "enableKeyDriverAnalysis", + EnableDataProfiling = "enableDataProfiling", + EnableExperimentalFeaturesUI = "enableExperimentalFeaturesUI", } export type ITigerFeatureFlags = { @@ -118,6 +124,12 @@ export type ITigerFeatureFlags = { enableKDAttributeFilterDatesValidation: typeof FeatureFlagsValues["enableKDAttributeFilterDatesValidation"][number]; enableMultipleCSVs: typeof FeatureFlagsValues["enableMultipleCSVs"][number]; enableOracleDataSource: typeof FeatureFlagsValues["enableOracleDataSource"][number]; + enableAnalyticalCatalog: typeof FeatureFlagsValues["enableAnalyticalCatalog"][number]; + enableAlerting: typeof FeatureFlagsValues["enableAlerting"][number]; + enableLabsSmartFunctions: typeof FeatureFlagsValues["enableLabsSmartFunctions"][number]; + enableKeyDriverAnalysis: typeof FeatureFlagsValues["enableKeyDriverAnalysis"][number]; + enableDataProfiling: typeof FeatureFlagsValues["enableDataProfiling"][number]; + enableExperimentalFeaturesUI: typeof FeatureFlagsValues["enableExperimentalFeaturesUI"][number]; }; export const DefaultFeatureFlags: ITigerFeatureFlags = { @@ -159,6 +171,12 @@ export const DefaultFeatureFlags: ITigerFeatureFlags = { enableKDAttributeFilterDatesValidation: true, enableMultipleCSVs: false, enableOracleDataSource: false, + enableAnalyticalCatalog: false, + enableAlerting: false, + enableLabsSmartFunctions: false, + enableKeyDriverAnalysis: false, + enableDataProfiling: false, + enableExperimentalFeaturesUI: false, }; export const FeatureFlagsValues = { @@ -204,4 +222,10 @@ export const FeatureFlagsValues = { enableKDAttributeFilterDatesValidation: [true, false] as const, enableMultipleCSVs: [true, false] as const, enableOracleDataSource: [true, false] as const, + enableAnalyticalCatalog: [true, false] as const, + enableAlerting: [true, false] as const, + enableLabsSmartFunctions: [true, false] as const, + enableKeyDriverAnalysis: [true, false] as const, + enableDataProfiling: [true, false] as const, + enableExperimentalFeaturesUI: [true, false] as const, }; diff --git a/libs/sdk-backend-tiger/src/backend/workspaces/index.ts b/libs/sdk-backend-tiger/src/backend/workspaces/index.ts index 17103d08fba..849080f2014 100644 --- a/libs/sdk-backend-tiger/src/backend/workspaces/index.ts +++ b/libs/sdk-backend-tiger/src/backend/workspaces/index.ts @@ -6,7 +6,7 @@ import { IAnalyticalWorkspace, IWorkspaceDescriptor, } from "@gooddata/sdk-backend-spi"; -import { JsonApiWorkspaceOutList, JsonApiWorkspacePatchAttributes } from "@gooddata/api-client-tiger"; +import { JsonApiWorkspaceOutList, DeclarativeWorkspace } from "@gooddata/api-client-tiger"; import { TigerAuthenticatedCallGuard } from "../../types/index.js"; import { DateFormatter } from "../../convertors/fromBackend/dateFormatting/types.js"; import { workspaceConverter } from "../../convertors/fromBackend/WorkspaceConverter.js"; @@ -32,7 +32,7 @@ class TigerWorkspaceQuery implements IWorkspacesQuery { private limit: number = 100; private offset: number = 0; private search: string | undefined = undefined; - private filter: JsonApiWorkspacePatchAttributes = {}; + private filter: Partial = {}; private parentWorkspaceId: string | undefined = undefined; constructor( diff --git a/libs/sdk-backend-tiger/src/convertors/fromBackend/WorkspaceConverter.ts b/libs/sdk-backend-tiger/src/convertors/fromBackend/WorkspaceConverter.ts index 30d7d2be76e..1e0fb50cd8a 100644 --- a/libs/sdk-backend-tiger/src/convertors/fromBackend/WorkspaceConverter.ts +++ b/libs/sdk-backend-tiger/src/convertors/fromBackend/WorkspaceConverter.ts @@ -1,4 +1,4 @@ -// (C) 2019-2023 GoodData Corporation +// (C) 2019-2024 GoodData Corporation import { JsonApiWorkspaceOut, JsonApiWorkspaceOutWithLinks } from "@gooddata/api-client-tiger"; import { IWorkspaceDescriptor } from "@gooddata/sdk-backend-spi"; @@ -14,5 +14,6 @@ export const workspaceConverter = ( prefix: attributes?.prefix, parentWorkspace, parentPrefixes, + earlyAccess: attributes?.earlyAccess, }; }; diff --git a/libs/sdk-model/api/sdk-model.api.md b/libs/sdk-model/api/sdk-model.api.md index fb69c22cf7d..06c7968650e 100644 --- a/libs/sdk-model/api/sdk-model.api.md +++ b/libs/sdk-model/api/sdk-model.api.md @@ -2061,6 +2061,8 @@ export interface IOrganizationDescriptor { // (undocumented) bootstrapUserGroup?: ObjRef; // (undocumented) + earlyAccess?: string; + // (undocumented) id: string; // (undocumented) title: string; diff --git a/libs/sdk-model/src/organization/index.ts b/libs/sdk-model/src/organization/index.ts index d8efcd7e3b9..f296d27f83c 100644 --- a/libs/sdk-model/src/organization/index.ts +++ b/libs/sdk-model/src/organization/index.ts @@ -12,6 +12,7 @@ export interface IOrganizationDescriptor { title: string; bootstrapUser?: ObjRef; bootstrapUserGroup?: ObjRef; + earlyAccess?: string; } /** diff --git a/libs/sdk-ui-kit/api/sdk-ui-kit.api.md b/libs/sdk-ui-kit/api/sdk-ui-kit.api.md index 5874c45e8e6..26c18fa75d6 100644 --- a/libs/sdk-ui-kit/api/sdk-ui-kit.api.md +++ b/libs/sdk-ui-kit/api/sdk-ui-kit.api.md @@ -2261,6 +2261,7 @@ export interface IInvertableSelectRenderItemProps { onDeselect: () => void; onSelect: () => void; onSelectOnly: () => void; + title: string; } // @internal (undocumented) diff --git a/libs/sdk-ui-kit/src/List/InvertableSelect/InvertableSelect.tsx b/libs/sdk-ui-kit/src/List/InvertableSelect/InvertableSelect.tsx index 2e20fd5257a..3c79f3ea820 100644 --- a/libs/sdk-ui-kit/src/List/InvertableSelect/InvertableSelect.tsx +++ b/libs/sdk-ui-kit/src/List/InvertableSelect/InvertableSelect.tsx @@ -1,4 +1,4 @@ -// (C) 2007-2023 GoodData Corporation +// (C) 2007-2024 GoodData Corporation import React, { useCallback } from "react"; import cx from "classnames"; import DefaultMeasure from "react-measure"; @@ -31,6 +31,11 @@ export interface IInvertableSelectRenderItemProps { */ item: T; + /** + * Title of the item + */ + title: string; + /** * Indicate that item is selected */ @@ -212,10 +217,11 @@ export function InvertableSelect(props: IInvertableSelectProps) { }, onSelectOnly: () => selectOnly(item), item, + title: getItemTitle(item), isSelected: getIsItemSelected(item), }); }, - [renderItem, getIsItemSelected, selectItems, deselectItems, selectOnly], + [renderItem, getIsItemSelected, getItemTitle, selectItems, deselectItems, selectOnly], ); return ( @@ -303,7 +309,14 @@ function defaultNoData(): JSX.Element { } function defaultItem(props: IInvertableSelectRenderItemProps): JSX.Element { - return ; + return ( + + ); } function defaultStatusBar(props: IInvertableSelectRenderStatusBarProps): JSX.Element {