From 6d778d11882fec28cd0a821e1bdcad224bb223e3 Mon Sep 17 00:00:00 2001 From: Visier-Build-Team Date: Fri, 13 Sep 2024 17:18:32 +0000 Subject: [PATCH] Updating Definitions --- res/administration-apis.yaml | 31 ++++++++++++++++++------------- res/analytic-model-apis.yaml | 2 +- res/authentication-apis.yaml | 2 +- res/data-in-apis.yaml | 23 ++++++++++++++++++----- res/data-out-apis.yaml | 14 +++++++------- 5 files changed, 45 insertions(+), 27 deletions(-) diff --git a/res/administration-apis.yaml b/res/administration-apis.yaml index 4eaf174..6beb33f 100644 --- a/res/administration-apis.yaml +++ b/res/administration-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1474 + version: 22222222.99201.1481 paths: /v1/admin/capabilities: get: @@ -2625,8 +2625,7 @@ paths: - Projects summary: Import committed changes into a project description: |- - * - Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from `POST /v1alpha/admin/production-versions`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment. + Import a ZIP file that contains a list of committed changes into a draft project. The file must be an export from `POST /v1alpha/admin/production-versions`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment.
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM). @@ -2661,10 +2660,9 @@ paths: put: tags: - Sources - summary: Import a ZIP file that contains a list of sources + summary: Import a list of sources description: |- - * - Import a ZIP file that contains a list of sources. The file must be an export from `POST /v1alpha/admin/sources`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment. + Import a list of sources in ZIP format. The file must be an export from `POST /v1alpha/admin/sources`. Use this API after making changes in a development environment to copy the changes to a draft project in your production environment.
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your Customer Success Manager (CSM). @@ -2672,7 +2670,7 @@ paths: parameters: - name: replaceAllExistingSources in: query - description: '`false` if the sources from the ZIP archive should be added to the sources in the target tenant. `true` if all sources in the target tenant should be removed while importing the ZIP archive.' + description: If `false`, adds the sources from the ZIP to the sources in the target tenant. If `true`, removes all sources in the target tenant and adds the sources from the ZIP. Default is `false`. schema: type: boolean requestBody: @@ -2695,9 +2693,9 @@ paths: post: tags: - Sources - summary: Perform an operation on the collection of all sources + summary: Perform an operation on all sources description: |- - Perform operations on the collection of sources. The following operations are supported: + Perform operations on all sources. The following operations are supported: * `exportSources`: Export a ZIP file that contains a list of all sources in the application.
**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. @@ -4940,11 +4938,11 @@ components: format: int32 ignored: type: integer - description: The number of imported sources that already existed and were ignored in the target tenant. + description: The number of imported sources that already existed and were unchanged in the target tenant. format: int32 deleted: type: integer - description: The number of imported sources that existed in the target tenant prior to the import, and were deleted during the import. + description: The number of imported sources that existed in the target tenant prior to the import and were deleted during the import. format: int32 SourcesAPIOperationRequestDTO: type: object @@ -4964,7 +4962,7 @@ components: summary: allOf: - $ref: '#/components/schemas/SourceImportResultSummaryDTO' - description: A summary of the changes made to the sources during the PUT operation. + description: The changes made to the sources during the operation. StaticDimensionFilterDTO: type: object properties: @@ -5250,6 +5248,7 @@ components: type: integer description: |- The 6-digit NAICS code for the industry to which the analytic tenant belongs. If the code is unknown, type 000000. + For 2-digit codes, add trailing zeros at the end to reach 6 digits, such as 620000. Required if creating new tenants. format: uint32 primaryBusinessLocation: @@ -5260,7 +5259,13 @@ components: type: array items: type: string - description: A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants. + description: |- + A comma-separated collection of strings that represent the Visier modules assigned to the new analytic tenant. Required if creating new tenants. + + To get the module name: + 1. In Visier, open a project and navigate to **Model > Modules**. + 2. Select a module. + 3. In **Basic Information**, copy the **Object name**. This is the module name. embeddableDomains: type: array items: diff --git a/res/analytic-model-apis.yaml b/res/analytic-model-apis.yaml index 7c910dc..287224e 100644 --- a/res/analytic-model-apis.yaml +++ b/res/analytic-model-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1474 + version: 22222222.99201.1481 paths: /v1/admin/calculation-concepts: get: diff --git a/res/authentication-apis.yaml b/res/authentication-apis.yaml index 5a39f02..9a9d579 100644 --- a/res/authentication-apis.yaml +++ b/res/authentication-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1474 + version: 22222222.99201.1481 paths: /v1/auth/oauth2/userinfo: get: diff --git a/res/data-in-apis.yaml b/res/data-in-apis.yaml index 4ac470b..14f64c6 100644 --- a/res/data-in-apis.yaml +++ b/res/data-in-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1474 + version: 22222222.99201.1481 paths: /v1/data/directloads/{draftId}/configs: get: @@ -101,7 +101,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DirectDataSchemaFieldDTO' + $ref: '#/components/schemas/DirectDataSchemaDTO' default: description: Default error response content: @@ -1383,10 +1383,14 @@ paths: type: string requestBody: content: - application/octetstream: + multipart/form-data: schema: - type: string - format: binary + type: object + properties: + file: + type: string + format: binary + description: The file to upload responses: "200": description: OK @@ -1985,6 +1989,15 @@ components: - $ref: '#/components/schemas/DirectDataJobConfigDTO' description: The direct data intake job configuration. description: The configuration for the direct data intake, such as the direct data intake job type. + DirectDataSchemaDTO: + type: object + properties: + schema: + type: array + items: + $ref: '#/components/schemas/DirectDataSchemaFieldDTO' + description: The schema definition for loading a specific object + description: Public API Direct Intake schema response object DirectDataSchemaFieldDTO: type: object properties: diff --git a/res/data-out-apis.yaml b/res/data-out-apis.yaml index 5995016..e6b94d6 100644 --- a/res/data-out-apis.yaml +++ b/res/data-out-apis.yaml @@ -8,7 +8,7 @@ info: license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 - version: 22222222.99201.1474 + version: 22222222.99201.1481 paths: /v1/data/query/aggregate: post: @@ -237,7 +237,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DataVersionExportsDTO' + $ref: '#/components/schemas/DataVersionExportDTO' default: description: Default error response content: @@ -1446,19 +1446,19 @@ components: - COMPACT_DISPLAY type: string description: |- - Define the `memberDisplayMode` options to control how member values are rendered in the aggregate query result set. You can override the `memberDisplayMode` on a per-axis basis, if required. + Control how member values are displayed. You can override the `memberDisplayMode` on a per-axis basis, if required. Valid values are `DEFAULT`, `COMPACT`, `DISPLAY`, or `MDX`. Default is `DEFAULT`. - * `DEFAULT`: The default member name representation. For non-time members, this means returning the technical member name path. + * `DEFAULT`: The default member name representation. For non-time members, this returns the technical member name path. For time members, this includes a bracketed member index. For example, Time instant member: `2019-06-01T00:00:00.000Z - [0]` For example, Time interval member: `2022-06-01T00:00:00.000Z/2022-07-01T00:00:00.000Z - [12]` - * `COMPACT`: Compacts the time member name representation. This also transforms the representation of time intervals to the end time of the interval. + * `COMPACT`: Shortens the member name representation. For time intervals, the member name is the end time of the interval. For example, Time instant member: `2019-06-01T00:00:00.000Z` For example, Time interval member: `2022-07-01T00:00:00.000Z` where the interval member name was `2022-06-01T00:00:00.000Z/2022-07-01T00:00:00.000Z - [12]` - * `DISPLAY`: Emit the members' display names whenever possible. When combined with `axisVisibility = VERBOSE`, the full display name path will be emitted. - * `MDX`: Emit member name paths where each element is enclosed in square brackets, `[]`. Multidimensional expression (MDX) display mode automatically encloses time members in square brackets and puts them in `COMPACT` format. + * `DISPLAY`: Emits the members' display names whenever possible. When combined with `axisVisibility = VERBOSE`, the full display name path will be emitted. + * `MDX`: Emits member name paths where each element is enclosed in square brackets, `[]`. Multidimensional expression (MDX) display mode automatically encloses time members in square brackets and puts them in `COMPACT` format. For example, Location member `North America.United States.California` becomes `[North America].[United States].[California]` in MDX display mode. For example, Time instant member `2019-06-01T00:00:00.000Z - [0]` becomes `[2019-06-01T00:00:00.000Z]` in MDX display mode. format: enum