Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR for release-22222222.99201.1523 #130

Merged
merged 1 commit into from
Oct 15, 2024
Merged

PR for release-22222222.99201.1523 #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 89 additions & 82 deletions res/administration-apis.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ info:
license:
name: Apache License, Version 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 22222222.99201.1508
version: 22222222.99201.1523
paths:
/v1/admin/capabilities:
get:
Expand Down Expand Up @@ -1566,7 +1566,7 @@ paths:
$ref: '#/components/schemas/UserCreationAPIRequestDTO'
required: true
responses:
"200":
"201":
description: OK
content:
application/json:
Expand Down Expand Up @@ -2372,23 +2372,15 @@ paths:
parameters:
- name: productionVersionId
in: path
description: The production version to use as the target of the operation; for example, the production version to roll back to for the `rollBackTo` operation.
required: true
schema:
type: string
- name: operation
in: query
description: |-
The operation to perform. Valid values:
* `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version.
schema:
enum:
- unknownProductionVersionAPIOperation
- rollBackTo
type: string
format: enum
requestBody:
content:
application/json: {}
application/json:
schema:
$ref: '#/components/schemas/ProductionVersionAPIOperationRequestDTO'
required: true
responses:
"200":
Expand Down Expand Up @@ -2657,63 +2649,66 @@ paths:
schema:
$ref: '#/components/schemas/Status'
/v1alpha/admin/sources:
put:
post:
tags:
- Sources
summary: Import a list of sources
summary: Perform an operation on all sources
description: |-
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.
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.

<br>**Note:** <em>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).</em>
operationId: Sources_PutSources
parameters:
- name: replaceAllExistingSources
in: query
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
operationId: Sources_RunSourcesOperation
requestBody:
content:
application/json: {}
application/json:
schema:
$ref: '#/components/schemas/SourcesAPIOperationRequestDTO'
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SourcesAPIPutResponseDTO'
$ref: '#/components/schemas/ExportSourcesAPIOperationResponseDTO'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
post:
put:
tags:
- Sources
summary: Perform an operation on all sources
summary: Import a list of sources
description: |-
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.
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.

<br>**Note:** <em>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).</em>
operationId: Sources_RunSourcesOperation
operationId: Sources_PutSources
parameters:
- name: replaceAllExistingSources
in: query
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:
required: true
content:
application/json:
application/zip:
schema:
$ref: '#/components/schemas/SourcesAPIOperationRequestDTO'
required: true
type: string
format: binary
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExportSourcesAPIOperationResponseDTO'
$ref: '#/components/schemas/SourcesAPIPutResponseDTO'
default:
description: Default error response
content:
Expand Down Expand Up @@ -4589,6 +4584,18 @@ components:
items:
$ref: '#/components/schemas/PermissionsToUserGroupRequestDTO'
description: A list of objects representing the user groups and permissions to assign or remove.
ProductionVersionAPIOperationRequestDTO:
type: object
properties:
operation:
enum:
- unknownProductionVersionAPIOperation
- rollBackTo
type: string
description: |-
The operation to perform. Valid values:
* `rollBackTo`: Create a project that rolls back the production version to the specified version. The project contains uncommitted changes that reverse the published versions after the target production version.
format: enum
ProductionVersionAPIOperationResponseDTO:
type: object
properties:
Expand Down Expand Up @@ -4925,25 +4932,6 @@ components:
username:
type: string
description: The user's username. This is typically the user's email, such as john@visier.com.
SourceImportResultSummaryDTO:
type: object
properties:
created:
type: integer
description: The number of imported sources that were newly created in the target tenant.
format: int32
updated:
type: integer
description: The number of imported sources that already existed and were updated in the target tenant.
format: int32
ignored:
type: integer
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.
format: int32
SourcesAPIOperationRequestDTO:
type: object
properties:
Expand All @@ -4956,13 +4944,6 @@ components:
The operation to perform. Valid values:
* `exportSources`: Export all sources from the tenant. If successful, a ZIP file is returned containing a compressed JSON file with the sources.
format: enum
SourcesAPIPutResponseDTO:
type: object
properties:
summary:
allOf:
- $ref: '#/components/schemas/SourceImportResultSummaryDTO'
description: The changes made to the sources during the operation.
StaticDimensionFilterDTO:
type: object
properties:
Expand Down Expand Up @@ -5531,27 +5512,6 @@ components:
email:
type: string
description: The user's email. This is used if the user's email is different from their username. For example, "john.doe@visier.com".
UserCreationAPIResponseDTO:
type: object
properties:
userId:
type: string
description: The unique identifier associated with the user.
username:
type: string
description: The user's username. This is typically the user's email, such as john@jupiter.com.
displayName:
type: string
description: An identifiable name to display within Visier. For example, "John Smith".
employeeId:
type: string
description: If applicable, and if available, the user employee ID in the data.
accountEnabled:
type: string
description: If true, the user account is enabled.
email:
type: string
description: The user's email address.
UserGetAPIResponseDTO:
type: object
properties:
Expand Down Expand Up @@ -6068,6 +6028,53 @@ components:
email:
type: string
description: The user's email address.
SourceImportResultSummaryDTO:
type: object
properties:
created:
type: integer
description: The number of imported sources that were newly created in the target tenant.
format: int32
updated:
type: integer
description: The number of imported sources that already existed and were updated in the target tenant.
format: int32
ignored:
type: integer
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.
format: int32
SourcesAPIPutResponseDTO:
type: object
properties:
summary:
allOf:
- $ref: '#/components/schemas/SourceImportResultSummaryDTO'
description: The changes made to the sources during the operation.
UserCreationAPIResponseDTO:
type: object
properties:
userId:
type: string
description: The unique identifier associated with the user.
username:
type: string
description: The user's username. This is typically the user's email, such as john@jupiter.com.
displayName:
type: string
description: An identifiable name to display within Visier. For example, "John Smith".
employeeId:
type: string
description: If applicable, and if available, the user employee ID in the data.
accountEnabled:
type: string
description: If true, the user account is enabled.
email:
type: string
description: The user's email address.
Status:
type: object
properties:
Expand Down
Loading