From fc055d8d4b383c30794d078e2dcf80b90a218aa0 Mon Sep 17 00:00:00 2001 From: Visier-Build-Team Date: Sat, 3 Aug 2024 09:39:19 +0000 Subject: [PATCH] Updating Definitions --- res/administration-apis.yaml | 82 +++++++++++++++++++++++++++++++----- res/analytic-model-apis.yaml | 2 +- res/authentication-apis.yaml | 26 ++++++++---- res/data-in-apis.yaml | 35 +++++++++++++-- res/data-out-apis.yaml | 2 +- 5 files changed, 123 insertions(+), 24 deletions(-) diff --git a/res/administration-apis.yaml b/res/administration-apis.yaml index ee1b7b3..56a36e1 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.1418 + version: 22222222.99201.1430 paths: /v1/admin/capabilities: get: @@ -2585,7 +2585,44 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GetProjectCommitsAPIResponseDTO' + $ref: '#/components/schemas/ProjectCommitsAPIResponseDTO' + default: + description: Default error response + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + put: + tags: + - 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. + +
**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). + operationId: Projects_PutProjectCommits + parameters: + - name: projectId + in: path + description: The unique identifier of the draft project you want to import committed changes into. + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PutProjectCommitsRequest' + required: true + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ProjectCommitsAPIResponseDTO' default: description: Default error response content: @@ -3856,6 +3893,19 @@ components: Configures the analytic object to inherit population access filters from. The target analytic object must be assigned population access in the permission and have a binding (strong) reference from the source analytic object. * For example, assume `Applicant` -> `Requisition` is configured to be a binding (strong) reference. For `Applicant` (source analytic object) to inherit population access filters from `Requisition` (target analytic object), in the Applicant `dataSecurityProfile`, set `inheritedReferenceMemberFilterConfig` to `Requisition`. In this example, Applicant will inherit filters from Requisition because Requsition is assigned data security in this permission and there is a binding (strong) reference from Applicant to Requisition. + analyticObjectStatus: + enum: + - Unset + - Valid + - NoData + - NotFound + type: string + description: |- + The analytic object's validity status. Valid values: Valid, NoData, NotFound. + * **Valid**: The object exists and has loaded data. + * **NoData**: The object exists but doesn't have loaded data. + * **NotFound**: The object doesn't exist. + format: enum DeletePermissionsRequestDTO: type: object properties: @@ -4060,14 +4110,6 @@ components: items: $ref: '#/components/schemas/ProjectDTO' description: A list of projects that were published to production. - GetProjectCommitsAPIResponseDTO: - type: object - properties: - commits: - type: array - items: - $ref: '#/components/schemas/CommitDTO' - description: A list of committed changes in the project. GetProjectsAPIResponseDTO: type: object properties: @@ -4137,9 +4179,13 @@ components: targetAnalyticObjectId: type: string description: |- - * The unique ID of the analytic object that the source analytic object should inherit filters from. The target analytic object must have a binding (strong) reference from the source analytic object. + analyticObjectReference: + type: string + description: |- + The optional object name of a binding (strong) reference to the target analytic object. If not specified, uses the first binding reference from the source + to the target analytic object. LastLoginDTO: type: object properties: @@ -4550,6 +4596,14 @@ components: items: $ref: '#/components/schemas/ProfileGetAPIResponseDTO' description: A list of objects representing the available profiles. + ProjectCommitsAPIResponseDTO: + type: object + properties: + commits: + type: array + items: + $ref: '#/components/schemas/CommitDTO' + description: A list of committed changes in the project. ProjectDTO: type: object properties: @@ -4658,6 +4712,12 @@ components: allOf: - $ref: '#/components/schemas/ShareableDataAccessSet' description: A shareable data access set. Shareable data access sets may be linked in multiple permissions. + PutProjectCommitsRequest: + type: object + properties: + projectId: + type: string + description: The unique identifier of the draft project you want to import committed changes into. ReducedErrorDTO: type: object properties: diff --git a/res/analytic-model-apis.yaml b/res/analytic-model-apis.yaml index c375a60..4736f50 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.1418 + version: 22222222.99201.1430 paths: /v1/admin/calculation-concepts: get: diff --git a/res/authentication-apis.yaml b/res/authentication-apis.yaml index 06a2934..ba7a438 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.1418 + version: 22222222.99201.1430 paths: /v1/auth/oauth2/userinfo: get: @@ -160,14 +160,11 @@ paths: schema: $ref: "#/components/schemas/Status" "200": - description: The JSON Web Token. Use this token in your API calls to authenticate the call. + description: Returns access and refresh tokens along with the expiration time. content: - application/jwt: - schema: - type: string application/json: schema: - type: string + $ref: "#/components/schemas/TokenResponse" security: - ApiKeyAuth: [] - ApiKeyAuth: [] @@ -242,6 +239,7 @@ components: - ContentReassignment - ReportDownloading - PlutoUser + - ReportingManagement type: string format: enum accessLevel: @@ -412,9 +410,21 @@ components: TokenResponse: type: object properties: - token: + access_token: + type: string + description: The access token to be used for API calls. + refresh_token: type: string - description: The security token. Use this token in your API calls to authenticate the call. Expires after 60 minutes. + description: The token used to obtain new access tokens. + id_token: + type: string + description: The ID token containing user identity information. + token_type: + type: string + description: The type of the token, typically "Bearer". + expires_in: + type: integer + description: The duration in seconds for which the access token is valid. TokenRequestBody: type: object properties: diff --git a/res/data-in-apis.yaml b/res/data-in-apis.yaml index 6847fed..f74bc5f 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.1418 + version: 22222222.99201.1430 paths: /v1/data/directloads/{draftId}/configs: get: @@ -1679,6 +1679,7 @@ components: - GoogleWorkspace - OracleDb - SmartRecruiters + - WorkdayWQL type: string description: |- The data provider associated with the credential. @@ -2110,6 +2111,10 @@ components: type: string clientSecret: type: string + serviceAccount: + type: string + privacyMode: + type: string GreenhouseAuthParamsDTO: type: object properties: @@ -2286,6 +2291,8 @@ components: type: string clientSecret: type: string + privacyMode: + type: string MultipleTenantDataVersionsDetailsDTO: type: object properties: @@ -2950,7 +2957,18 @@ components: type: array items: type: string - description: A comma-separated list of strings representing the upload time of each data upload to exclude. + description: A comma-separated list of ISO8601 time strings representing the upload time of each data upload to exclude. + minUploadTime: + type: string + description: An ISO8601 time for the earliest upload time. If defined, omit `uploadTimes`. If omitted and `maxUploadTime` is defined, excludes files up to earliest time available. + maxUploadTime: + type: string + description: An ISO8601 time for the latest upload time. If defined, omit `uploadTimes`. If omitted and `minUploadTime` is defined, excludes files up to latest time available. + sources: + type: array + items: + type: string + description: A comma-separated list of strings representing the object name of each source to exclude. If `uploadTimes` is omitted, excludes files for the given sources for all `uploadTimes`. UploadToExcludeModel: type: object properties: @@ -2972,7 +2990,18 @@ components: type: array items: type: string - description: A comma-separated list of strings representing the upload time of each data upload to include. + description: A comma-separated list of ISO8601 time strings representing the upload time of each data upload to include. + minUploadTime: + type: string + description: An ISO8601 time for the earliest upload time. If defined, omit `uploadTimes`. If omitted and `maxUploadTime` is defined, includes files up to earliest time available. + maxUploadTime: + type: string + description: An ISO8601 time for the latest upload time. If defined, omit `uploadTimes`. If omitted and `minUploadTime` is defined, includes files up to latest time available. + sources: + type: array + items: + type: string + description: A comma-separated list of strings representing the object name of each source to include. If `uploadTimes` is omitted, includes files for the given sources for all `uploadTimes`. UploadToIncludeModel: type: object properties: diff --git a/res/data-out-apis.yaml b/res/data-out-apis.yaml index e2ef103..54a4701 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.1418 + version: 22222222.99201.1430 paths: /v1/data/query/aggregate: post: