From fa57b074e6e8103c3f7fbb68d7691213bae3d642 Mon Sep 17 00:00:00 2001 From: Evis Drenova Date: Thu, 24 Oct 2024 17:00:49 -0700 Subject: [PATCH 1/3] update postman link --- compose.dev.yml | 2 +- docs/docusaurus.config.ts | 6 +- docs/final_openapi.yaml | 11600 ++++++++++++++++++++++++++++++++++++ schema_only.sql | 4 + 4 files changed, 11610 insertions(+), 2 deletions(-) create mode 100644 docs/final_openapi.yaml create mode 100644 schema_only.sql diff --git a/compose.dev.yml b/compose.dev.yml index ad94d9d763..7af4f64ad6 100644 --- a/compose.dev.yml +++ b/compose.dev.yml @@ -8,7 +8,7 @@ include: # - path: ./compose/compose-db-mysql.yml # - path: ./compose/compose-db-mongo.yml # - path: ./compose/compose-db-dynamo.yml - # - path: ./compose/compose-db-mssql.yml + - path: ./compose/compose-db-mssql.yml services: app: diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index 577559dc8d..6e2b71e627 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -144,8 +144,12 @@ const config: Config = { 'aria-label': 'Discord Server', }, { to: '/', label: 'Docs' }, - { to: '/api', label: 'API' }, + { to: '/api', label: 'SDK' }, { to: '/changelog', label: 'Changelog' }, + { + to: 'https://www.postman.com/payload-pilot-82848251/neosync-rest-apis/collection/6sxdkh5/mgmt-v1alpha1?action=share&creator=24215189', + label: 'API Reference', + }, ], }, footer: { diff --git a/docs/final_openapi.yaml b/docs/final_openapi.yaml new file mode 100644 index 0000000000..9fe43a6efb --- /dev/null +++ b/docs/final_openapi.yaml @@ -0,0 +1,11600 @@ +openapi: 3.0.1 +info: + title: mgmt.v1alpha1 + version: '1' +tags: + - name: mgmt.v1alpha1.AnonymizationService + x-displayName: mgmt.v1alpha1.AnonymizationService + - name: mgmt.v1alpha1.ApiKeyService + description: >- + Service that manages the lifecycle of API Keys that are associated with a + specific Account. + x-displayName: mgmt.v1alpha1.ApiKeyService + - name: mgmt.v1alpha1.AuthService + description: |- + Service that handles generic Authentication for Neosync + Today this is mostly used by the CLI to receive authentication information + x-displayName: mgmt.v1alpha1.AuthService + - name: mgmt.v1alpha1.ConnectionService + description: |- + Service for managing datasource connections. + This is a primary data model in Neosync and is used in reference when hooking up Jobs to synchronize and generate data. + x-displayName: mgmt.v1alpha1.ConnectionService + - name: mgmt.v1alpha1.ConnectionDataService + description: |- + Service for managing connection data. + This is used in handle data from a connection + x-displayName: mgmt.v1alpha1.ConnectionDataService + - name: mgmt.v1alpha1.JobService + x-displayName: mgmt.v1alpha1.JobService + - name: mgmt.v1alpha1.MetricsService + x-displayName: mgmt.v1alpha1.MetricsService + - name: mgmt.v1alpha1.TransformersService + x-displayName: mgmt.v1alpha1.TransformersService + - name: mgmt.v1alpha1.UserAccountService + x-displayName: mgmt.v1alpha1.UserAccountService +paths: + /mgmt.v1alpha1.AnonymizationService/AnonymizeMany: + post: + tags: + - mgmt.v1alpha1.AnonymizationService + summary: AnonymizeMany + description: >- + Anonymizes many JSON strings by applying specified transformation + mappings. + operationId: mgmt.v1alpha1.AnonymizationService.AnonymizeMany + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AnonymizationService/AnonymizeSingle: + post: + tags: + - mgmt.v1alpha1.AnonymizationService + summary: AnonymizeSingle + description: >- + Anonymizes a single JSON strings by applying specified transformation + mappings. + operationId: mgmt.v1alpha1.AnonymizationService.AnonymizeSingle + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeSingleRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeSingleResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ApiKeyService/GetAccountApiKeys: + post: + tags: + - mgmt.v1alpha1.ApiKeyService + summary: GetAccountApiKeys + description: Retrieves a list of Account API Keys + operationId: mgmt.v1alpha1.ApiKeyService.GetAccountApiKeys + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeysRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeysResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ApiKeyService/GetAccountApiKey: + post: + tags: + - mgmt.v1alpha1.ApiKeyService + summary: GetAccountApiKey + description: Retrieves a single API Key + operationId: mgmt.v1alpha1.ApiKeyService.GetAccountApiKey + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeyRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeyResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ApiKeyService/CreateAccountApiKey: + post: + tags: + - mgmt.v1alpha1.ApiKeyService + summary: CreateAccountApiKey + description: |- + Creates a single API Key + This method will return the decrypted contents of the API key + operationId: mgmt.v1alpha1.ApiKeyService.CreateAccountApiKey + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateAccountApiKeyRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateAccountApiKeyResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ApiKeyService/RegenerateAccountApiKey: + post: + tags: + - mgmt.v1alpha1.ApiKeyService + summary: RegenerateAccountApiKey + description: |- + Regenerates a single API Key with a new expiration time + This method will return the decrypted contents of the API key + operationId: mgmt.v1alpha1.ApiKeyService.RegenerateAccountApiKey + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RegenerateAccountApiKeyRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RegenerateAccountApiKeyResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ApiKeyService/DeleteAccountApiKey: + post: + tags: + - mgmt.v1alpha1.ApiKeyService + summary: DeleteAccountApiKey + description: Deletes an API Key from the system. + operationId: mgmt.v1alpha1.ApiKeyService.DeleteAccountApiKey + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteAccountApiKeyRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteAccountApiKeyResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/LoginCli: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: LoginCli + description: Used by the CLI to login to Neosync with OAuth. + operationId: mgmt.v1alpha1.AuthService.LoginCli + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.LoginCliRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.LoginCliResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/RefreshCli: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: RefreshCli + description: |- + Used by the CLI to refresh an expired Neosync accesss token. + This should only be used if an access token was previously retrieved from the `LoginCli` or `RefreshCli` methods. + operationId: mgmt.v1alpha1.AuthService.RefreshCli + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.RefreshCliRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.RefreshCliResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/CheckToken: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: CheckToken + description: Empty endpoint to simply check if the provided access token is valid + operationId: mgmt.v1alpha1.AuthService.CheckToken + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CheckTokenRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CheckTokenResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/GetCliIssuer: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: GetCliIssuer + description: |- + Used by the CLI to retrieve Auth Issuer information + @deprecated + operationId: mgmt.v1alpha1.AuthService.GetCliIssuer + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetCliIssuerRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetCliIssuerResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/GetAuthorizeUrl: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: GetAuthorizeUrl + description: Used by the CLI to retrieve an Authorize URL for use with OAuth login. + operationId: mgmt.v1alpha1.AuthService.GetAuthorizeUrl + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthorizeUrlRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthorizeUrlResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.AuthService/GetAuthStatus: + post: + tags: + - mgmt.v1alpha1.AuthService + summary: GetAuthStatus + description: >- + Returns the auth status of the API server. Whether or not the backend + has authentication enabled. + This is used by clients to make decisions on whether or not they should send access tokens to the API. + operationId: mgmt.v1alpha1.AuthService.GetAuthStatus + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthStatusRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthStatusResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/GetConnections: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: GetConnections + description: Returns a list of connections associated with the account + operationId: mgmt.v1alpha1.ConnectionService.GetConnections + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/GetConnection: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: GetConnection + description: Returns a single connection + operationId: mgmt.v1alpha1.ConnectionService.GetConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/CreateConnection: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: CreateConnection + description: Creates a new connection + operationId: mgmt.v1alpha1.ConnectionService.CreateConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateConnectionRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateConnectionResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/UpdateConnection: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: UpdateConnection + description: Updates an existing connection + operationId: mgmt.v1alpha1.ConnectionService.UpdateConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.UpdateConnectionRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.UpdateConnectionResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/DeleteConnection: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: DeleteConnection + description: Removes a connection from the system. + operationId: mgmt.v1alpha1.ConnectionService.DeleteConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteConnectionRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteConnectionResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/IsConnectionNameAvailable: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: IsConnectionNameAvailable + description: >- + Connections have friendly names, this method checks if the requested + name is available in the system based on the account + operationId: mgmt.v1alpha1.ConnectionService.IsConnectionNameAvailable + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.IsConnectionNameAvailableRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.IsConnectionNameAvailableResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/CheckConnectionConfig: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: CheckConnectionConfig + description: |- + Checks if the connection config is connectable by the backend. + Used mostly to verify that a connection is valid prior to creating a Connection object. + operationId: mgmt.v1alpha1.ConnectionService.CheckConnectionConfig + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CheckConnectionConfigRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/CheckConnectionConfigById: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: CheckConnectionConfigById + description: |- + Checks if the connection id is connectable by the backend. + Used to verify that a connection is still connectable. + operationId: mgmt.v1alpha1.ConnectionService.CheckConnectionConfigById + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigByIdRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigByIdResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionService/CheckSqlQuery: + post: + tags: + - mgmt.v1alpha1.ConnectionService + summary: CheckSqlQuery + description: >- + Checks a constructed SQL query against a sql-based connection to see if + it's valid based on that connection's data schema + This is useful when constructing subsets to see if the WHERE clause is correct + operationId: mgmt.v1alpha1.ConnectionService.CheckSqlQuery + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CheckSqlQueryRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CheckSqlQueryResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionDataStream: {} + /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchema: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionSchema + description: >- + Returns the schema for a specific connection. Used mostly for SQL-based + connections + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchema + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchemaMap: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionSchemaMap + description: >- + Returns the schema in map format. The keys are the fully qualified table + in the format . + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchemaMap + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchemaMaps: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionSchemaMaps + description: Returns the schema in map format for every request provided + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchemaMaps + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionTableConstraints: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionTableConstraints + description: >- + For a specific connection, returns the table constraints. Mostly useful + for SQL-based Connections. + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionTableConstraints + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionTableConstraintsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionTableConstraintsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionForeignConstraints: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionForeignConstraints + description: >- + For a specific connection, returns the foreign key constraints. Mostly + useful for SQL-based Connections. + Used primarily by the CLI sync command to determine stream order. + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionForeignConstraints + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionForeignConstraintsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionForeignConstraintsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionPrimaryConstraints: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionPrimaryConstraints + description: >- + For a specific connection, returns the primary key constraints. Mostly + useful for SQL-based Connections. + Used primarily by the CLI sync command to determine stream order. + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionPrimaryConstraints + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionPrimaryConstraintsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionInitStatements: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionInitStatements + description: >- + For a specific connection, returns the init table statements. Mostly + useful for SQL-based Connections. + Used primarily by the CLI sync command to create table schema init statement. + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionInitStatements + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionInitStatementsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionInitStatementsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetConnectionUniqueConstraints: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetConnectionUniqueConstraints + description: >- + For a specific connection, returns the unique constraints. Mostly useful + for SQL-based connections. + operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionUniqueConstraints + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionUniqueConstraintsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetAiGeneratedData: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetAiGeneratedData + description: >- + Query an AI connection by providing the necessary values. Typically used + for generating preview data + operationId: mgmt.v1alpha1.ConnectionDataService.GetAiGeneratedData + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAiGeneratedDataRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAiGeneratedDataResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.ConnectionDataService/GetTableRowCount: + post: + tags: + - mgmt.v1alpha1.ConnectionDataService + summary: GetTableRowCount + description: Query table with subset to get row count + operationId: mgmt.v1alpha1.ConnectionDataService.GetTableRowCount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetTableRowCountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetTableRowCountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobs: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobs + operationId: mgmt.v1alpha1.JobService.GetJobs + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJob: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJob + operationId: mgmt.v1alpha1.JobService.GetJob + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/CreateJob: + post: + tags: + - mgmt.v1alpha1.JobService + summary: CreateJob + operationId: mgmt.v1alpha1.JobService.CreateJob + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/DeleteJob: + post: + tags: + - mgmt.v1alpha1.JobService + summary: DeleteJob + operationId: mgmt.v1alpha1.JobService.DeleteJob + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/IsJobNameAvailable: + post: + tags: + - mgmt.v1alpha1.JobService + summary: IsJobNameAvailable + operationId: mgmt.v1alpha1.JobService.IsJobNameAvailable + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.IsJobNameAvailableRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.IsJobNameAvailableResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/UpdateJobSchedule: + post: + tags: + - mgmt.v1alpha1.JobService + summary: UpdateJobSchedule + operationId: mgmt.v1alpha1.JobService.UpdateJobSchedule + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.UpdateJobScheduleRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.UpdateJobScheduleResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/UpdateJobSourceConnection: + post: + tags: + - mgmt.v1alpha1.JobService + summary: UpdateJobSourceConnection + operationId: mgmt.v1alpha1.JobService.UpdateJobSourceConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateJobSourceConnectionRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateJobSourceConnectionResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/SetJobSourceSqlConnectionSubsets: + post: + tags: + - mgmt.v1alpha1.JobService + summary: SetJobSourceSqlConnectionSubsets + operationId: mgmt.v1alpha1.JobService.SetJobSourceSqlConnectionSubsets + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/UpdateJobDestinationConnection: + post: + tags: + - mgmt.v1alpha1.JobService + summary: UpdateJobDestinationConnection + operationId: mgmt.v1alpha1.JobService.UpdateJobDestinationConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateJobDestinationConnectionRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateJobDestinationConnectionResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/DeleteJobDestinationConnection: + post: + tags: + - mgmt.v1alpha1.JobService + summary: DeleteJobDestinationConnection + operationId: mgmt.v1alpha1.JobService.DeleteJobDestinationConnection + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.DeleteJobDestinationConnectionRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.DeleteJobDestinationConnectionResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/CreateJobDestinationConnections: + post: + tags: + - mgmt.v1alpha1.JobService + summary: CreateJobDestinationConnections + operationId: mgmt.v1alpha1.JobService.CreateJobDestinationConnections + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CreateJobDestinationConnectionsRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CreateJobDestinationConnectionsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/PauseJob: + post: + tags: + - mgmt.v1alpha1.JobService + summary: PauseJob + operationId: mgmt.v1alpha1.JobService.PauseJob + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.PauseJobRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.PauseJobResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobRecentRuns: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobRecentRuns + description: >- + Returns a list of recently invoked job runs baseds on the Temporal cron + scheduler. This will return a list of job runs that include archived + runs + operationId: mgmt.v1alpha1.JobService.GetJobRecentRuns + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRecentRunsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRecentRunsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobNextRuns: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobNextRuns + description: >- + Returns a list of runs that are scheduled for execution based on the + Temporal cron scheduler. + operationId: mgmt.v1alpha1.JobService.GetJobNextRuns + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobNextRunsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobNextRunsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobStatus: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobStatus + operationId: mgmt.v1alpha1.JobService.GetJobStatus + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobStatuses: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobStatuses + operationId: mgmt.v1alpha1.JobService.GetJobStatuses + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusesRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusesResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobRuns: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobRuns + description: Returns a list of job runs by either account or job + operationId: mgmt.v1alpha1.JobService.GetJobRuns + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobRunEvents: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobRunEvents + operationId: mgmt.v1alpha1.JobService.GetJobRunEvents + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunEventsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunEventsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobRun: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetJobRun + description: Returns a specific job run, along with any of its pending activities + operationId: mgmt.v1alpha1.JobService.GetJobRun + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/DeleteJobRun: + post: + tags: + - mgmt.v1alpha1.JobService + summary: DeleteJobRun + operationId: mgmt.v1alpha1.JobService.DeleteJobRun + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRunRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRunResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/CreateJobRun: + post: + tags: + - mgmt.v1alpha1.JobService + summary: CreateJobRun + operationId: mgmt.v1alpha1.JobService.CreateJobRun + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRunRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRunResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/CancelJobRun: + post: + tags: + - mgmt.v1alpha1.JobService + summary: CancelJobRun + operationId: mgmt.v1alpha1.JobService.CancelJobRun + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CancelJobRunRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CancelJobRunResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/TerminateJobRun: + post: + tags: + - mgmt.v1alpha1.JobService + summary: TerminateJobRun + operationId: mgmt.v1alpha1.JobService.TerminateJobRun + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.TerminateJobRunRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.TerminateJobRunResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetJobRunLogsStream: {} + /mgmt.v1alpha1.JobService/SetJobWorkflowOptions: + post: + tags: + - mgmt.v1alpha1.JobService + summary: SetJobWorkflowOptions + description: >- + Set any job workflow options. Must provide entire object as is it will + fully override the previous configuration + operationId: mgmt.v1alpha1.JobService.SetJobWorkflowOptions + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetJobWorkflowOptionsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetJobWorkflowOptionsResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/SetJobSyncOptions: + post: + tags: + - mgmt.v1alpha1.JobService + summary: SetJobSyncOptions + description: >- + Set the job sync options. Must provide entire object as it will fully + override the previous configuration + operationId: mgmt.v1alpha1.JobService.SetJobSyncOptions + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetJobSyncOptionsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetJobSyncOptionsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/ValidateJobMappings: + post: + tags: + - mgmt.v1alpha1.JobService + summary: ValidateJobMappings + description: validates that the jobmapping configured can run with table constraints + operationId: mgmt.v1alpha1.JobService.ValidateJobMappings + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.ValidateJobMappingsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.ValidateJobMappingsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/GetRunContext: + post: + tags: + - mgmt.v1alpha1.JobService + summary: GetRunContext + description: Gets a run context to be used by a workflow run + operationId: mgmt.v1alpha1.JobService.GetRunContext + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetRunContextRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetRunContextResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/SetRunContext: + post: + tags: + - mgmt.v1alpha1.JobService + summary: SetRunContext + description: Sets a run context to be used by a workflow run + operationId: mgmt.v1alpha1.JobService.SetRunContext + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetRunContextRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetRunContextResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.JobService/SetRunContexts: {} + /mgmt.v1alpha1.MetricsService/GetDailyMetricCount: + post: + tags: + - mgmt.v1alpha1.MetricsService + summary: GetDailyMetricCount + description: Retrieve a timed range of records + operationId: mgmt.v1alpha1.MetricsService.GetDailyMetricCount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetDailyMetricCountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetDailyMetricCountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.MetricsService/GetMetricCount: + post: + tags: + - mgmt.v1alpha1.MetricsService + summary: GetMetricCount + description: For the given metric and time range, returns the total count found + operationId: mgmt.v1alpha1.MetricsService.GetMetricCount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetMetricCountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetMetricCountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/GetSystemTransformers: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: GetSystemTransformers + operationId: mgmt.v1alpha1.TransformersService.GetSystemTransformers + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetSystemTransformersRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetSystemTransformersResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/GetSystemTransformerBySource: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: GetSystemTransformerBySource + operationId: mgmt.v1alpha1.TransformersService.GetSystemTransformerBySource + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetSystemTransformerBySourceRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetSystemTransformerBySourceResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/GetUserDefinedTransformers: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: GetUserDefinedTransformers + operationId: mgmt.v1alpha1.TransformersService.GetUserDefinedTransformers + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformersRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformersResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/GetUserDefinedTransformerById: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: GetUserDefinedTransformerById + operationId: mgmt.v1alpha1.TransformersService.GetUserDefinedTransformerById + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformerByIdRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformerByIdResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/CreateUserDefinedTransformer: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: CreateUserDefinedTransformer + operationId: mgmt.v1alpha1.TransformersService.CreateUserDefinedTransformer + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CreateUserDefinedTransformerRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.CreateUserDefinedTransformerResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/DeleteUserDefinedTransformer: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: DeleteUserDefinedTransformer + operationId: mgmt.v1alpha1.TransformersService.DeleteUserDefinedTransformer + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.DeleteUserDefinedTransformerRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.DeleteUserDefinedTransformerResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/UpdateUserDefinedTransformer: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: UpdateUserDefinedTransformer + operationId: mgmt.v1alpha1.TransformersService.UpdateUserDefinedTransformer + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateUserDefinedTransformerRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.UpdateUserDefinedTransformerResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/IsTransformerNameAvailable: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: IsTransformerNameAvailable + operationId: mgmt.v1alpha1.TransformersService.IsTransformerNameAvailable + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.IsTransformerNameAvailableRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.IsTransformerNameAvailableResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/ValidateUserJavascriptCode: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: ValidateUserJavascriptCode + operationId: mgmt.v1alpha1.TransformersService.ValidateUserJavascriptCode + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.ValidateUserJavascriptCodeRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.ValidateUserJavascriptCodeResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.TransformersService/ValidateUserRegexCode: + post: + tags: + - mgmt.v1alpha1.TransformersService + summary: ValidateUserRegexCode + operationId: mgmt.v1alpha1.TransformersService.ValidateUserRegexCode + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.ValidateUserRegexCodeRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.ValidateUserRegexCodeResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetUser: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetUser + operationId: mgmt.v1alpha1.UserAccountService.GetUser + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetUserRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetUserResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/SetUser: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: SetUser + operationId: mgmt.v1alpha1.UserAccountService.SetUser + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetUserRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetUserResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetUserAccounts: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetUserAccounts + operationId: mgmt.v1alpha1.UserAccountService.GetUserAccounts + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetUserAccountsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetUserAccountsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/SetPersonalAccount: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: SetPersonalAccount + operationId: mgmt.v1alpha1.UserAccountService.SetPersonalAccount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetPersonalAccountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetPersonalAccountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/ConvertPersonalToTeamAccount: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: ConvertPersonalToTeamAccount + description: >- + Convert a personal account to a team account retaining all of the jobs + and connections. This will also create a new empty personal account. + operationId: mgmt.v1alpha1.UserAccountService.ConvertPersonalToTeamAccount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.ConvertPersonalToTeamAccountRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.ConvertPersonalToTeamAccountResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/CreateTeamAccount: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: CreateTeamAccount + description: Creates a new team account + operationId: mgmt.v1alpha1.UserAccountService.CreateTeamAccount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateTeamAccountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateTeamAccountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/IsUserInAccount: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: IsUserInAccount + operationId: mgmt.v1alpha1.UserAccountService.IsUserInAccount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.IsUserInAccountRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.IsUserInAccountResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetAccountTemporalConfig: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetAccountTemporalConfig + operationId: mgmt.v1alpha1.UserAccountService.GetAccountTemporalConfig + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountTemporalConfigRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountTemporalConfigResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/SetAccountTemporalConfig: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: SetAccountTemporalConfig + operationId: mgmt.v1alpha1.UserAccountService.SetAccountTemporalConfig + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetAccountTemporalConfigRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetAccountTemporalConfigResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetTeamAccountMembers: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetTeamAccountMembers + operationId: mgmt.v1alpha1.UserAccountService.GetTeamAccountMembers + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetTeamAccountMembersRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetTeamAccountMembersResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/RemoveTeamAccountMember: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: RemoveTeamAccountMember + operationId: mgmt.v1alpha1.UserAccountService.RemoveTeamAccountMember + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountMemberRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountMemberResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/InviteUserToTeamAccount: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: InviteUserToTeamAccount + operationId: mgmt.v1alpha1.UserAccountService.InviteUserToTeamAccount + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.InviteUserToTeamAccountRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.InviteUserToTeamAccountResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetTeamAccountInvites: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetTeamAccountInvites + operationId: mgmt.v1alpha1.UserAccountService.GetTeamAccountInvites + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetTeamAccountInvitesRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetTeamAccountInvitesResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/RemoveTeamAccountInvite: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: RemoveTeamAccountInvite + operationId: mgmt.v1alpha1.UserAccountService.RemoveTeamAccountInvite + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountInviteRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountInviteResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/AcceptTeamAccountInvite: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: AcceptTeamAccountInvite + operationId: mgmt.v1alpha1.UserAccountService.AcceptTeamAccountInvite + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.AcceptTeamAccountInviteRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.AcceptTeamAccountInviteResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetSystemInformation: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetSystemInformation + operationId: mgmt.v1alpha1.UserAccountService.GetSystemInformation + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetSystemInformationRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetSystemInformationResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetAccountOnboardingConfig: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetAccountOnboardingConfig + operationId: mgmt.v1alpha1.UserAccountService.GetAccountOnboardingConfig + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountOnboardingConfigRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountOnboardingConfigResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/SetAccountOnboardingConfig: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: SetAccountOnboardingConfig + operationId: mgmt.v1alpha1.UserAccountService.SetAccountOnboardingConfig + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetAccountOnboardingConfigRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetAccountOnboardingConfigResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetAccountStatus: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetAccountStatus + description: >- + Returns different metrics on the account status for the active billing + period + operationId: mgmt.v1alpha1.UserAccountService.GetAccountStatus + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountStatusRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountStatusResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/IsAccountStatusValid: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: IsAccountStatusValid + description: Distils the account status down to whether not it is in a valid state. + operationId: mgmt.v1alpha1.UserAccountService.IsAccountStatusValid + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.IsAccountStatusValidRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.IsAccountStatusValidResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetAccountBillingCheckoutSession: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetAccountBillingCheckoutSession + description: Returns a new checkout session for the account to subscribe + operationId: mgmt.v1alpha1.UserAccountService.GetAccountBillingCheckoutSession + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountBillingCheckoutSessionRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountBillingCheckoutSessionResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetAccountBillingPortalSession: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetAccountBillingPortalSession + description: >- + Returns a new billing portal session if the account has a billing + customer id + operationId: mgmt.v1alpha1.UserAccountService.GetAccountBillingPortalSession + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountBillingPortalSessionRequest + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.GetAccountBillingPortalSessionResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/GetBillingAccounts: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: GetBillingAccounts + description: Returns user accounts that have a billing id. + operationId: mgmt.v1alpha1.UserAccountService.GetBillingAccounts + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetBillingAccountsRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.GetBillingAccountsResponse' + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] + /mgmt.v1alpha1.UserAccountService/SetBillingMeterEvent: + post: + tags: + - mgmt.v1alpha1.UserAccountService + summary: SetBillingMeterEvent + description: Sends a new metered event to the billing system + operationId: mgmt.v1alpha1.UserAccountService.SetBillingMeterEvent + parameters: + - name: Connect-Protocol-Version + in: header + required: true + schema: + $ref: '#/components/schemas/connect-protocol-version' + - name: Connect-Timeout-Ms + in: header + schema: + $ref: '#/components/schemas/connect-timeout-header' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/mgmt.v1alpha1.SetBillingMeterEventRequest' + required: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: >- + #/components/schemas/mgmt.v1alpha1.SetBillingMeterEventResponse + default: + description: Error + content: + application/json: + schema: + $ref: '#/components/schemas/connect.error' + security: [] +components: + schemas: + mgmt.v1alpha1.GenerateEmailType: + type: string + title: GenerateEmailType + enum: + - GENERATE_EMAIL_TYPE_UNSPECIFIED + - GENERATE_EMAIL_TYPE_UUID_V4 + - GENERATE_EMAIL_TYPE_FULLNAME + mgmt.v1alpha1.InvalidEmailAction: + type: string + title: InvalidEmailAction + enum: + - INVALID_EMAIL_ACTION_UNSPECIFIED + - INVALID_EMAIL_ACTION_REJECT + - INVALID_EMAIL_ACTION_NULL + - INVALID_EMAIL_ACTION_PASSTHROUGH + - INVALID_EMAIL_ACTION_GENERATE + description: >- + Action enumeration that dictates what the transform_email transformer + should do in the case that it encounters an email that does not conform + to RFC 5322 + mgmt.v1alpha1.PiiAnonymizer.Hash.HashType: + type: string + title: HashType + enum: + - HASH_TYPE_UNSPECIFIED + - HASH_TYPE_MD5 + - HASH_TYPE_SHA256 + - HASH_TYPE_SHA512 + mgmt.v1alpha1.AnonymizeManyErrors: + type: object + properties: + inputIndex: + oneOf: + - type: string + - type: number + title: input_index + description: Index of input data that caused error + errorMessage: + type: string + title: error_message + description: Error message + title: AnonymizeManyErrors + additionalProperties: false + mgmt.v1alpha1.AnonymizeManyRequest: + type: object + allOf: + - anyOf: + - required: + - defaultTransformers + - not: + anyOf: + - required: + - defaultTransformers + anyOf: + - required: + - defaultTransformers + - not: + anyOf: + - required: + - defaultTransformers + properties: + inputData: + type: array + items: + type: string + minLength: 1 + maxItems: 25 + minItems: 1 + title: input_data + maxItems: 25 + minItems: 1 + description: Array of stringified JSON data to be anonymized (up to 25 items) + transformerMappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.TransformerMapping' + title: transformer_mappings + description: Array of Transformer mappings + defaultTransformers: + allOf: + - title: default_transformers + description: Optional default transformations for any unmapped keys + - $ref: '#/components/schemas/mgmt.v1alpha1.DefaultTransformersConfig' + haltOnFailure: + type: boolean + title: halt_on_failure + description: |- + Flag to indicate whether to stop processing when an error occurs + true: stops on first error encounter + title: AnonymizeManyRequest + additionalProperties: false + mgmt.v1alpha1.AnonymizeManyResponse: + type: object + properties: + outputData: + type: array + items: + type: string + title: output_data + description: Array of anonymized JSON data + errors: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyErrors' + title: errors + description: Array of errors that occured during anonymization + title: AnonymizeManyResponse + additionalProperties: false + mgmt.v1alpha1.AnonymizeSingleRequest: + type: object + allOf: + - anyOf: + - required: + - defaultTransformers + - not: + anyOf: + - required: + - defaultTransformers + anyOf: + - required: + - defaultTransformers + - not: + anyOf: + - required: + - defaultTransformers + properties: + inputData: + type: string + title: input_data + description: Stringified JSON data to be anonymized + transformerMappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.TransformerMapping' + title: transformer_mappings + description: Array of Transformer mappings + defaultTransformers: + allOf: + - title: default_transformers + description: Optional default transformations for any unmapped keys + - $ref: '#/components/schemas/mgmt.v1alpha1.DefaultTransformersConfig' + title: AnonymizeSingleRequest + additionalProperties: false + mgmt.v1alpha1.AnonymizeSingleResponse: + type: object + properties: + outputData: + type: string + title: output_data + description: Anonymized JSON data + title: AnonymizeSingleResponse + additionalProperties: false + mgmt.v1alpha1.DefaultTransformersConfig: + type: object + properties: + boolean: + allOf: + - title: boolean + description: Boolean + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + 'n': + allOf: + - title: 'n' + description: Number + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + s: + allOf: + - title: s + description: String + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + title: DefaultTransformersConfig + additionalProperties: false + mgmt.v1alpha1.GenerateBool: + type: object + title: GenerateBool + additionalProperties: false + mgmt.v1alpha1.GenerateCardNumber: + type: object + properties: + validLuhn: + type: boolean + title: valid_luhn + title: GenerateCardNumber + additionalProperties: false + mgmt.v1alpha1.GenerateCategorical: + type: object + properties: + categories: + type: string + title: categories + title: GenerateCategorical + additionalProperties: false + mgmt.v1alpha1.GenerateCity: + type: object + title: GenerateCity + additionalProperties: false + mgmt.v1alpha1.GenerateCountry: + type: object + properties: + generateFullName: + type: boolean + title: generate_full_name + description: >- + An option to return the full country name of the randomly selected + country or return the default of a 2-letter country code. + title: GenerateCountry + additionalProperties: false + mgmt.v1alpha1.GenerateDefault: + type: object + title: GenerateDefault + additionalProperties: false + mgmt.v1alpha1.GenerateE164PhoneNumber: + type: object + properties: + min: + oneOf: + - type: string + - type: number + title: min + max: + oneOf: + - type: string + - type: number + title: max + title: GenerateE164PhoneNumber + additionalProperties: false + mgmt.v1alpha1.GenerateEmail: + type: object + allOf: + - anyOf: + - required: + - emailType + - not: + anyOf: + - required: + - emailType + anyOf: + - required: + - emailType + - not: + anyOf: + - required: + - emailType + properties: + emailType: + allOf: + - title: email_type + description: >- + Optionally specify the type of email to generate. The types + specified determine the contents on the left side of the @. + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmailType' + title: GenerateEmail + additionalProperties: false + mgmt.v1alpha1.GenerateFirstName: + type: object + title: GenerateFirstName + additionalProperties: false + mgmt.v1alpha1.GenerateFloat64: + type: object + properties: + randomizeSign: + type: boolean + title: randomize_sign + min: + oneOf: + - type: string + - type: number + title: min + max: + oneOf: + - type: string + - type: number + title: max + precision: + oneOf: + - type: string + - type: number + title: precision + title: GenerateFloat64 + additionalProperties: false + mgmt.v1alpha1.GenerateFullAddress: + type: object + title: GenerateFullAddress + additionalProperties: false + mgmt.v1alpha1.GenerateFullName: + type: object + title: GenerateFullName + additionalProperties: false + mgmt.v1alpha1.GenerateGender: + type: object + properties: + abbreviate: + type: boolean + title: abbreviate + title: GenerateGender + additionalProperties: false + mgmt.v1alpha1.GenerateInt64: + type: object + properties: + randomizeSign: + type: boolean + title: randomize_sign + min: + oneOf: + - type: string + - type: number + title: min + max: + oneOf: + - type: string + - type: number + title: max + title: GenerateInt64 + additionalProperties: false + mgmt.v1alpha1.GenerateInt64PhoneNumber: + type: object + title: GenerateInt64PhoneNumber + additionalProperties: false + mgmt.v1alpha1.GenerateJavascript: + type: object + properties: + code: + type: string + title: code + title: GenerateJavascript + additionalProperties: false + mgmt.v1alpha1.GenerateLastName: + type: object + title: GenerateLastName + additionalProperties: false + mgmt.v1alpha1.GenerateSSN: + type: object + title: GenerateSSN + additionalProperties: false + mgmt.v1alpha1.GenerateSha256Hash: + type: object + title: GenerateSha256Hash + additionalProperties: false + mgmt.v1alpha1.GenerateState: + type: object + properties: + generateFullName: + type: boolean + title: generate_full_name + description: >- + An option to return the full state name of the randomly selected + state or return the default of a 2-letter state code. + title: GenerateState + additionalProperties: false + mgmt.v1alpha1.GenerateStreetAddress: + type: object + title: GenerateStreetAddress + additionalProperties: false + mgmt.v1alpha1.GenerateString: + type: object + properties: + min: + oneOf: + - type: string + - type: number + title: min + max: + oneOf: + - type: string + - type: number + title: max + title: GenerateString + additionalProperties: false + mgmt.v1alpha1.GenerateStringPhoneNumber: + type: object + properties: + min: + oneOf: + - type: string + - type: number + title: min + max: + oneOf: + - type: string + - type: number + title: max + title: GenerateStringPhoneNumber + additionalProperties: false + mgmt.v1alpha1.GenerateUnixTimestamp: + type: object + title: GenerateUnixTimestamp + additionalProperties: false + mgmt.v1alpha1.GenerateUsername: + type: object + title: GenerateUsername + additionalProperties: false + mgmt.v1alpha1.GenerateUtcTimestamp: + type: object + title: GenerateUtcTimestamp + additionalProperties: false + mgmt.v1alpha1.GenerateUuid: + type: object + properties: + includeHyphens: + type: boolean + title: include_hyphens + title: GenerateUuid + additionalProperties: false + mgmt.v1alpha1.GenerateZipcode: + type: object + title: GenerateZipcode + additionalProperties: false + mgmt.v1alpha1.Null: + type: object + title: 'Null' + additionalProperties: false + mgmt.v1alpha1.Passthrough: + type: object + title: Passthrough + additionalProperties: false + mgmt.v1alpha1.PiiAnonymizer: + type: object + allOf: + - anyOf: + - required: + - hash + - required: + - mask + - required: + - redact + - required: + - replace + - not: + anyOf: + - required: + - hash + - required: + - mask + - required: + - redact + - required: + - replace + anyOf: + - required: + - hash + - required: + - mask + - required: + - redact + - required: + - replace + - not: + anyOf: + - required: + - hash + - required: + - mask + - required: + - redact + - required: + - replace + properties: + replace: + allOf: + - title: replace + description: >- + Configures the anonymizer to replace the identified PII with a + specific value + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Replace' + redact: + allOf: + - title: redact + description: >- + Configures the anonymizer to completely remove the identified + PII + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Redact' + mask: + allOf: + - title: mask + description: Configures the anonymizer to mask the identified PII + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Mask' + hash: + allOf: + - title: hash + description: Configures the anonymizer to hash the identified PII + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Hash' + title: PiiAnonymizer + additionalProperties: false + mgmt.v1alpha1.PiiAnonymizer.Hash: + type: object + allOf: + - anyOf: + - required: + - algo + - not: + anyOf: + - required: + - algo + anyOf: + - required: + - algo + - not: + anyOf: + - required: + - algo + properties: + algo: + allOf: + - title: algo + description: The hashing algorithm to use. + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Hash.HashType' + title: Hash + additionalProperties: false + mgmt.v1alpha1.PiiAnonymizer.Mask: + type: object + allOf: + - anyOf: + - required: + - charsToMask + - not: + anyOf: + - required: + - charsToMask + - anyOf: + - required: + - fromEnd + - not: + anyOf: + - required: + - fromEnd + - anyOf: + - required: + - maskingChar + - not: + anyOf: + - required: + - maskingChar + properties: + maskingChar: + type: string + title: masking_char + description: Provide a character that will be used for the replacement. + charsToMask: + type: integer + title: chars_to_mask + description: How many characters to mask. + fromEnd: + type: boolean + title: from_end + description: Whether to mask the PII from start or end + title: Mask + additionalProperties: false + mgmt.v1alpha1.PiiAnonymizer.Redact: + type: object + title: Redact + additionalProperties: false + mgmt.v1alpha1.PiiAnonymizer.Replace: + type: object + allOf: + - anyOf: + - required: + - value + - not: + anyOf: + - required: + - value + anyOf: + - required: + - value + - not: + anyOf: + - required: + - value + properties: + value: + type: string + title: value + description: >- + The value to replace. If not provided, a template token of the + anonymizer is used. + title: Replace + additionalProperties: false + mgmt.v1alpha1.PiiDenyRecognizer: + type: object + properties: + name: + type: string + title: name + pattern: ^[a-z0-9-_]{1,100}$ + description: Friendly name of this entity + denyWords: + type: array + items: + type: string + minLength: 1 + title: deny_words + description: List of words that will be treated as PII. + title: PiiDenyRecognizer + additionalProperties: false + mgmt.v1alpha1.TransformCharacterScramble: + type: object + allOf: + - anyOf: + - required: + - userProvidedRegex + - not: + anyOf: + - required: + - userProvidedRegex + anyOf: + - required: + - userProvidedRegex + - not: + anyOf: + - required: + - userProvidedRegex + properties: + userProvidedRegex: + type: string + title: user_provided_regex + description: >- + a user provided regular expression that they wish to validate if it + compiles in GO + title: TransformCharacterScramble + additionalProperties: false + mgmt.v1alpha1.TransformE164PhoneNumber: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformE164PhoneNumber + additionalProperties: false + mgmt.v1alpha1.TransformEmail: + type: object + allOf: + - anyOf: + - required: + - emailType + - not: + anyOf: + - required: + - emailType + - anyOf: + - required: + - invalidEmailAction + - not: + anyOf: + - required: + - invalidEmailAction + properties: + preserveDomain: + type: boolean + title: preserve_domain + description: >- + Whether or not to preserve the original domain, barring what has + been specified in the excluded_domains property. + preserveLength: + type: boolean + title: preserve_length + description: >- + Whether or not to preserve the original length of the email. This + causes the transformed email to retain the original length. + excludedDomains: + type: array + items: + type: string + title: excluded_domains + description: >- + A lsit of email domains that should be excluded. This changes based + on the preserve_domain flag. See the docs for more details. + emailType: + allOf: + - title: email_type + description: >- + Optionally specify the type of email to generate. The types + specified determine the contents on the left side of the @. + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmailType' + invalidEmailAction: + allOf: + - title: invalid_email_action + description: >- + Optionally specify an action in the result of an invalid email. + An invalid email is one that does not conform to RFC 5322. + - $ref: '#/components/schemas/mgmt.v1alpha1.InvalidEmailAction' + title: TransformEmail + additionalProperties: false + mgmt.v1alpha1.TransformFirstName: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformFirstName + additionalProperties: false + mgmt.v1alpha1.TransformFloat64: + type: object + properties: + randomizationRangeMin: + oneOf: + - type: string + - type: number + title: randomization_range_min + randomizationRangeMax: + oneOf: + - type: string + - type: number + title: randomization_range_max + title: TransformFloat64 + additionalProperties: false + mgmt.v1alpha1.TransformFullName: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformFullName + additionalProperties: false + mgmt.v1alpha1.TransformInt64: + type: object + properties: + randomizationRangeMin: + oneOf: + - type: string + - type: number + title: randomization_range_min + randomizationRangeMax: + oneOf: + - type: string + - type: number + title: randomization_range_max + title: TransformInt64 + additionalProperties: false + mgmt.v1alpha1.TransformInt64PhoneNumber: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformInt64PhoneNumber + additionalProperties: false + mgmt.v1alpha1.TransformJavascript: + type: object + properties: + code: + type: string + title: code + title: TransformJavascript + additionalProperties: false + mgmt.v1alpha1.TransformLastName: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformLastName + additionalProperties: false + mgmt.v1alpha1.TransformPhoneNumber: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformPhoneNumber + additionalProperties: false + mgmt.v1alpha1.TransformPiiText: + type: object + properties: + scoreThreshold: + type: number + title: score_threshold + description: Minimal detection score for determining PII. 0.0-1.0 + defaultAnonymizer: + allOf: + - title: default_anonymizer + description: >- + The default anonmyization config used for all instances of + detected PII. + - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer' + denyRecognizers: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.PiiDenyRecognizer' + title: deny_recognizers + description: Configure deny lists where each word is treated as PII. + title: TransformPiiText + additionalProperties: false + description: NeosyncCloud/Enterprise only transformer for anonymizing PII Text + mgmt.v1alpha1.TransformString: + type: object + properties: + preserveLength: + type: boolean + title: preserve_length + title: TransformString + additionalProperties: false + mgmt.v1alpha1.TransformerConfig: + type: object + allOf: + - anyOf: + - required: + - generateBoolConfig + - required: + - generateCardNumberConfig + - required: + - generateCategoricalConfig + - required: + - generateCityConfig + - required: + - generateCountryConfig + - required: + - generateDefaultConfig + - required: + - generateE164PhoneNumberConfig + - required: + - generateEmailConfig + - required: + - generateFirstNameConfig + - required: + - generateFloat64Config + - required: + - generateFullAddressConfig + - required: + - generateFullNameConfig + - required: + - generateGenderConfig + - required: + - generateInt64Config + - required: + - generateInt64PhoneNumberConfig + - required: + - generateJavascriptConfig + - required: + - generateLastNameConfig + - required: + - generateSha256hashConfig + - required: + - generateSsnConfig + - required: + - generateStateConfig + - required: + - generateStreetAddressConfig + - required: + - generateStringConfig + - required: + - generateStringPhoneNumberConfig + - required: + - generateUnixtimestampConfig + - required: + - generateUsernameConfig + - required: + - generateUtctimestampConfig + - required: + - generateUuidConfig + - required: + - generateZipcodeConfig + - required: + - nullconfig + - required: + - passthroughConfig + - required: + - transformCharacterScrambleConfig + - required: + - transformE164PhoneNumberConfig + - required: + - transformEmailConfig + - required: + - transformFirstNameConfig + - required: + - transformFloat64Config + - required: + - transformFullNameConfig + - required: + - transformInt64Config + - required: + - transformInt64PhoneNumberConfig + - required: + - transformJavascriptConfig + - required: + - transformLastNameConfig + - required: + - transformPhoneNumberConfig + - required: + - transformPiiTextConfig + - required: + - transformStringConfig + - required: + - userDefinedTransformerConfig + - not: + anyOf: + - required: + - generateBoolConfig + - required: + - generateCardNumberConfig + - required: + - generateCategoricalConfig + - required: + - generateCityConfig + - required: + - generateCountryConfig + - required: + - generateDefaultConfig + - required: + - generateE164PhoneNumberConfig + - required: + - generateEmailConfig + - required: + - generateFirstNameConfig + - required: + - generateFloat64Config + - required: + - generateFullAddressConfig + - required: + - generateFullNameConfig + - required: + - generateGenderConfig + - required: + - generateInt64Config + - required: + - generateInt64PhoneNumberConfig + - required: + - generateJavascriptConfig + - required: + - generateLastNameConfig + - required: + - generateSha256hashConfig + - required: + - generateSsnConfig + - required: + - generateStateConfig + - required: + - generateStreetAddressConfig + - required: + - generateStringConfig + - required: + - generateStringPhoneNumberConfig + - required: + - generateUnixtimestampConfig + - required: + - generateUsernameConfig + - required: + - generateUtctimestampConfig + - required: + - generateUuidConfig + - required: + - generateZipcodeConfig + - required: + - nullconfig + - required: + - passthroughConfig + - required: + - transformCharacterScrambleConfig + - required: + - transformE164PhoneNumberConfig + - required: + - transformEmailConfig + - required: + - transformFirstNameConfig + - required: + - transformFloat64Config + - required: + - transformFullNameConfig + - required: + - transformInt64Config + - required: + - transformInt64PhoneNumberConfig + - required: + - transformJavascriptConfig + - required: + - transformLastNameConfig + - required: + - transformPhoneNumberConfig + - required: + - transformPiiTextConfig + - required: + - transformStringConfig + - required: + - userDefinedTransformerConfig + anyOf: + - required: + - generateBoolConfig + - required: + - generateCardNumberConfig + - required: + - generateCategoricalConfig + - required: + - generateCityConfig + - required: + - generateCountryConfig + - required: + - generateDefaultConfig + - required: + - generateE164PhoneNumberConfig + - required: + - generateEmailConfig + - required: + - generateFirstNameConfig + - required: + - generateFloat64Config + - required: + - generateFullAddressConfig + - required: + - generateFullNameConfig + - required: + - generateGenderConfig + - required: + - generateInt64Config + - required: + - generateInt64PhoneNumberConfig + - required: + - generateJavascriptConfig + - required: + - generateLastNameConfig + - required: + - generateSha256hashConfig + - required: + - generateSsnConfig + - required: + - generateStateConfig + - required: + - generateStreetAddressConfig + - required: + - generateStringConfig + - required: + - generateStringPhoneNumberConfig + - required: + - generateUnixtimestampConfig + - required: + - generateUsernameConfig + - required: + - generateUtctimestampConfig + - required: + - generateUuidConfig + - required: + - generateZipcodeConfig + - required: + - nullconfig + - required: + - passthroughConfig + - required: + - transformCharacterScrambleConfig + - required: + - transformE164PhoneNumberConfig + - required: + - transformEmailConfig + - required: + - transformFirstNameConfig + - required: + - transformFloat64Config + - required: + - transformFullNameConfig + - required: + - transformInt64Config + - required: + - transformInt64PhoneNumberConfig + - required: + - transformJavascriptConfig + - required: + - transformLastNameConfig + - required: + - transformPhoneNumberConfig + - required: + - transformPiiTextConfig + - required: + - transformStringConfig + - required: + - userDefinedTransformerConfig + - not: + anyOf: + - required: + - generateBoolConfig + - required: + - generateCardNumberConfig + - required: + - generateCategoricalConfig + - required: + - generateCityConfig + - required: + - generateCountryConfig + - required: + - generateDefaultConfig + - required: + - generateE164PhoneNumberConfig + - required: + - generateEmailConfig + - required: + - generateFirstNameConfig + - required: + - generateFloat64Config + - required: + - generateFullAddressConfig + - required: + - generateFullNameConfig + - required: + - generateGenderConfig + - required: + - generateInt64Config + - required: + - generateInt64PhoneNumberConfig + - required: + - generateJavascriptConfig + - required: + - generateLastNameConfig + - required: + - generateSha256hashConfig + - required: + - generateSsnConfig + - required: + - generateStateConfig + - required: + - generateStreetAddressConfig + - required: + - generateStringConfig + - required: + - generateStringPhoneNumberConfig + - required: + - generateUnixtimestampConfig + - required: + - generateUsernameConfig + - required: + - generateUtctimestampConfig + - required: + - generateUuidConfig + - required: + - generateZipcodeConfig + - required: + - nullconfig + - required: + - passthroughConfig + - required: + - transformCharacterScrambleConfig + - required: + - transformE164PhoneNumberConfig + - required: + - transformEmailConfig + - required: + - transformFirstNameConfig + - required: + - transformFloat64Config + - required: + - transformFullNameConfig + - required: + - transformInt64Config + - required: + - transformInt64PhoneNumberConfig + - required: + - transformJavascriptConfig + - required: + - transformLastNameConfig + - required: + - transformPhoneNumberConfig + - required: + - transformPiiTextConfig + - required: + - transformStringConfig + - required: + - userDefinedTransformerConfig + properties: + generateEmailConfig: + allOf: + - title: generate_email_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmail' + transformEmailConfig: + allOf: + - title: transform_email_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformEmail' + generateBoolConfig: + allOf: + - title: generate_bool_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateBool' + generateCardNumberConfig: + allOf: + - title: generate_card_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCardNumber' + generateCityConfig: + allOf: + - title: generate_city_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCity' + generateE164PhoneNumberConfig: + allOf: + - title: generate_e164_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateE164PhoneNumber' + generateFirstNameConfig: + allOf: + - title: generate_first_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFirstName' + generateFloat64Config: + allOf: + - title: generate_float64_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFloat64' + generateFullAddressConfig: + allOf: + - title: generate_full_address_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFullAddress' + generateFullNameConfig: + allOf: + - title: generate_full_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFullName' + generateGenderConfig: + allOf: + - title: generate_gender_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateGender' + generateInt64PhoneNumberConfig: + allOf: + - title: generate_int64_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateInt64PhoneNumber' + generateInt64Config: + allOf: + - title: generate_int64_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateInt64' + generateLastNameConfig: + allOf: + - title: generate_last_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateLastName' + generateSha256hashConfig: + allOf: + - title: generate_sha256hash_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSha256Hash' + generateSsnConfig: + allOf: + - title: generate_ssn_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSSN' + generateStateConfig: + allOf: + - title: generate_state_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateState' + generateStreetAddressConfig: + allOf: + - title: generate_street_address_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateStreetAddress' + generateStringPhoneNumberConfig: + allOf: + - title: generate_string_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateStringPhoneNumber' + generateStringConfig: + allOf: + - title: generate_string_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateString' + generateUnixtimestampConfig: + allOf: + - title: generate_unixtimestamp_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUnixTimestamp' + generateUsernameConfig: + allOf: + - title: generate_username_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUsername' + generateUtctimestampConfig: + allOf: + - title: generate_utctimestamp_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUtcTimestamp' + generateUuidConfig: + allOf: + - title: generate_uuid_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUuid' + generateZipcodeConfig: + allOf: + - title: generate_zipcode_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateZipcode' + transformE164PhoneNumberConfig: + allOf: + - title: transform_e164_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformE164PhoneNumber' + transformFirstNameConfig: + allOf: + - title: transform_first_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFirstName' + transformFloat64Config: + allOf: + - title: transform_float64_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFloat64' + transformFullNameConfig: + allOf: + - title: transform_full_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFullName' + transformInt64PhoneNumberConfig: + allOf: + - title: transform_int64_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformInt64PhoneNumber' + transformInt64Config: + allOf: + - title: transform_int64_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformInt64' + transformLastNameConfig: + allOf: + - title: transform_last_name_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformLastName' + transformPhoneNumberConfig: + allOf: + - title: transform_phone_number_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPhoneNumber' + transformStringConfig: + allOf: + - title: transform_string_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformString' + passthroughConfig: + allOf: + - title: passthrough_config + - $ref: '#/components/schemas/mgmt.v1alpha1.Passthrough' + nullconfig: + allOf: + - title: nullconfig + - $ref: '#/components/schemas/mgmt.v1alpha1.Null' + userDefinedTransformerConfig: + allOf: + - title: user_defined_transformer_config + - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformerConfig' + generateDefaultConfig: + allOf: + - title: generate_default_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateDefault' + transformJavascriptConfig: + allOf: + - title: transform_javascript_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformJavascript' + generateCategoricalConfig: + allOf: + - title: generate_categorical_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCategorical' + transformCharacterScrambleConfig: + allOf: + - title: transform_character_scramble_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformCharacterScramble' + generateJavascriptConfig: + allOf: + - title: generate_javascript_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateJavascript' + generateCountryConfig: + allOf: + - title: generate_country_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCountry' + transformPiiTextConfig: + allOf: + - title: transform_pii_text_config + description: >- + NeosyncCloud/Enterprise only transformer for anonymizing PII + Text + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPiiText' + title: TransformerConfig + additionalProperties: false + mgmt.v1alpha1.TransformerMapping: + type: object + properties: + expression: + type: string + title: expression + description: JQ Expression or Field Path to apply the transformation to + transformer: + allOf: + - title: transformer + description: Configuration of Transformer to apply + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + title: TransformerMapping + required: + - expression + - transformer + - transformer + additionalProperties: false + mgmt.v1alpha1.UserDefinedTransformerConfig: + type: object + properties: + id: + type: string + title: id + format: uuid + title: UserDefinedTransformerConfig + additionalProperties: false + connect-protocol-version: + type: number + title: Connect-Protocol-Version + enum: + - 1 + description: Define the version of the Connect protocol + const: 1 + connect-timeout-header: + type: number + title: Connect-Timeout-Ms + description: Define the timeout, in ms + connect.error: + type: object + properties: + code: + type: string + examples: + - CodeNotFound + enum: + - CodeCanceled + - CodeUnknown + - CodeInvalidArgument + - CodeDeadlineExceeded + - CodeNotFound + - CodeAlreadyExists + - CodePermissionDenied + - CodeResourceExhausted + - CodeFailedPrecondition + - CodeAborted + - CodeOutOfRange + - CodeInternal + - CodeUnavailable + - CodeDataLoss + - CodeUnauthenticated + description: >- + The status code, which should be an enum value of + [google.rpc.Code][google.rpc.Code]. + message: + type: string + description: >- + A developer-facing error message, which should be in English. Any + user-facing error message should be localized and sent in the + [google.rpc.Status.details][google.rpc.Status.details] field, or + localized by the client. + detail: + $ref: '#/components/schemas/google.protobuf.Any' + title: Connect Error + additionalProperties: true + description: >- + Error type returned by Connect: + https://connectrpc.com/docs/go/errors/#http-representation + google.protobuf.Any: + type: object + properties: + type: + type: string + value: + type: string + format: binary + debug: + type: object + additionalProperties: true + additionalProperties: true + description: >- + Contains an arbitrary serialized message along with a @type that + describes the type of the serialized message. + google.protobuf.Timestamp: + type: string + format: date-time + description: >- + A Timestamp represents a point in time independent of any time zone or + local + calendar, encoded as a count of seconds and fractions of seconds at + nanosecond resolution. The count is relative to an epoch at UTC midnight on + January 1, 1970, in the proleptic Gregorian calendar which extends the + Gregorian calendar backwards to year one. + + All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap + second table is needed for interpretation, using a [24-hour linear + smear](https://developers.google.com/time/smear). + + The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By + restricting to that range, we ensure that we can convert to and from [RFC + 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. + + # Examples + + Example 1: Compute Timestamp from POSIX `time()`. + + Timestamp timestamp; + timestamp.set_seconds(time(NULL)); + timestamp.set_nanos(0); + + Example 2: Compute Timestamp from POSIX `gettimeofday()`. + + struct timeval tv; + gettimeofday(&tv, NULL); + + Timestamp timestamp; + timestamp.set_seconds(tv.tv_sec); + timestamp.set_nanos(tv.tv_usec * 1000); + + Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. + + FILETIME ft; + GetSystemTimeAsFileTime(&ft); + UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; + + // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z + // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. + Timestamp timestamp; + timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); + timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); + + Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. + + long millis = System.currentTimeMillis(); + + Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) + .setNanos((int) ((millis % 1000) * 1000000)).build(); + + Example 5: Compute Timestamp from Java `Instant.now()`. + + Instant now = Instant.now(); + + Timestamp timestamp = + Timestamp.newBuilder().setSeconds(now.getEpochSecond()) + .setNanos(now.getNano()).build(); + + Example 6: Compute Timestamp from current time in Python. + + timestamp = Timestamp() + timestamp.GetCurrentTime() + + # JSON Mapping + + In JSON format, the Timestamp type is encoded as a string in the + [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the + format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" + where {year} is always expressed using four digits while {month}, {day}, + {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional + seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), + are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone + is required. A proto3 JSON serializer should always use UTC (as indicated by + "Z") when printing the Timestamp type and a proto3 JSON parser should be + able to accept both UTC and other timezones (as indicated by an offset). + + For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past + 01:30 UTC on January 15, 2017. + + In JavaScript, one can convert a Date object to this format using the + standard + [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) + method. In Python, a standard `datetime.datetime` object can be converted + to this format using + [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with + the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use + the Joda Time's [`ISODateTimeFormat.dateTime()`]( + http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() + ) to obtain a formatter capable of generating timestamps in this format. + mgmt.v1alpha1.AccountApiKey: + type: object + allOf: + - anyOf: + - required: + - keyValue + - not: + anyOf: + - required: + - keyValue + anyOf: + - required: + - keyValue + - not: + anyOf: + - required: + - keyValue + properties: + id: + type: string + title: id + name: + type: string + title: name + description: The friendly name of the API Key + accountId: + type: string + title: account_id + createdById: + type: string + title: created_by_id + createdAt: + allOf: + - title: created_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + updatedById: + type: string + title: updated_by_id + updatedAt: + allOf: + - title: updated_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + keyValue: + type: string + title: key_value + description: >- + key_value is only returned on initial creation or when it is + regenerated + userId: + type: string + title: user_id + expiresAt: + allOf: + - title: expires_at + description: >- + The timestamp of what the API key expires and will not longer be + usable. + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: AccountApiKey + additionalProperties: false + mgmt.v1alpha1.CreateAccountApiKeyRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + expiresAt: + allOf: + - title: expires_at + description: 'Validate between now and one year: now < x < 365 days' + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: CreateAccountApiKeyRequest + required: + - expiresAt + - expiresAt + additionalProperties: false + mgmt.v1alpha1.CreateAccountApiKeyResponse: + type: object + properties: + apiKey: + allOf: + - title: api_key + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' + title: CreateAccountApiKeyResponse + additionalProperties: false + mgmt.v1alpha1.DeleteAccountApiKeyRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: DeleteAccountApiKeyRequest + additionalProperties: false + mgmt.v1alpha1.DeleteAccountApiKeyResponse: + type: object + title: DeleteAccountApiKeyResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountApiKeyRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: GetAccountApiKeyRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountApiKeyResponse: + type: object + properties: + apiKey: + allOf: + - title: api_key + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' + title: GetAccountApiKeyResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountApiKeysRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountApiKeysRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountApiKeysResponse: + type: object + properties: + apiKeys: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' + title: api_keys + title: GetAccountApiKeysResponse + additionalProperties: false + mgmt.v1alpha1.RegenerateAccountApiKeyRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + expiresAt: + allOf: + - title: expires_at + description: 'Validate between now and one year: now < x < 365 days' + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: RegenerateAccountApiKeyRequest + required: + - expiresAt + - expiresAt + additionalProperties: false + mgmt.v1alpha1.RegenerateAccountApiKeyResponse: + type: object + properties: + apiKey: + allOf: + - title: api_key + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' + title: RegenerateAccountApiKeyResponse + additionalProperties: false + mgmt.v1alpha1.AccessToken: + type: object + allOf: + - anyOf: + - required: + - idToken + - not: + anyOf: + - required: + - idToken + - anyOf: + - required: + - refreshToken + - not: + anyOf: + - required: + - refreshToken + properties: + accessToken: + type: string + title: access_token + description: >- + The access token that will be provided in subsequent requests to + provide authenticated access to the Api + refreshToken: + type: string + title: refresh_token + description: |- + Token that can be used to retrieve a refreshed access token. + Will not be provided if the offline_access scope is not provided in the initial login flow. + expiresIn: + oneOf: + - type: string + - type: number + title: expires_in + description: >- + Relative time in seconds that the access token will expire. Combine + with the current time to get the expires_at time. + scope: + type: string + title: scope + description: The scopes that the access token have + idToken: + type: string + title: id_token + description: The identity token of the authenticated user + tokenType: + type: string + title: token_type + description: The token type. For JWTs, this will be `Bearer` + title: AccessToken + additionalProperties: false + description: A decoded representation of an Access token from the backing auth server + mgmt.v1alpha1.CheckTokenRequest: + type: object + title: CheckTokenRequest + additionalProperties: false + mgmt.v1alpha1.CheckTokenResponse: + type: object + title: CheckTokenResponse + additionalProperties: false + mgmt.v1alpha1.GetAuthStatusRequest: + type: object + title: GetAuthStatusRequest + additionalProperties: false + mgmt.v1alpha1.GetAuthStatusResponse: + type: object + properties: + isEnabled: + type: boolean + title: is_enabled + description: |- + Whether or not the server has authentication enabled. + This tells the client if it is expected to send access tokens. + title: GetAuthStatusResponse + additionalProperties: false + mgmt.v1alpha1.GetAuthorizeUrlRequest: + type: object + properties: + state: + type: string + title: state + minLength: 1 + description: >- + The state that's generated by the client that is passed along to + prevent tampering + redirectUri: + type: string + title: redirect_uri + minLength: 1 + description: >- + The redirect uri that the client will be redirected back to during + the auth request + scope: + type: string + title: scope + minLength: 1 + description: >- + The scopes the client is requesting as a part of the oauth login + request + title: GetAuthorizeUrlRequest + additionalProperties: false + mgmt.v1alpha1.GetAuthorizeUrlResponse: + type: object + properties: + url: + type: string + title: url + description: >- + The generated url that is the client will be redirected to during + the Oauth flow + title: GetAuthorizeUrlResponse + additionalProperties: false + mgmt.v1alpha1.GetCliIssuerRequest: + type: object + title: GetCliIssuerRequest + additionalProperties: false + mgmt.v1alpha1.GetCliIssuerResponse: + type: object + properties: + issuerUrl: + type: string + title: issuer_url + description: The backing authentication issuer url + audience: + type: string + title: audience + description: >- + The audience that will be used in the access token. This corresponds + to the "aud" claim + title: GetCliIssuerResponse + additionalProperties: false + mgmt.v1alpha1.LoginCliRequest: + type: object + properties: + code: + type: string + title: code + minLength: 1 + description: The oauth code + redirectUri: + type: string + title: redirect_uri + minLength: 1 + description: The oauth redirect uri that the client uses during the oauth request + title: LoginCliRequest + additionalProperties: false + mgmt.v1alpha1.LoginCliResponse: + type: object + properties: + accessToken: + allOf: + - title: access_token + description: The access token that is returned on successful login + - $ref: '#/components/schemas/mgmt.v1alpha1.AccessToken' + title: LoginCliResponse + additionalProperties: false + mgmt.v1alpha1.RefreshCliRequest: + type: object + properties: + refreshToken: + type: string + title: refresh_token + minLength: 1 + description: The token used to retrieve a new access token. + title: RefreshCliRequest + additionalProperties: false + mgmt.v1alpha1.RefreshCliResponse: + type: object + properties: + accessToken: + allOf: + - title: access_token + description: The access token that is returned on successful refresh + - $ref: '#/components/schemas/mgmt.v1alpha1.AccessToken' + title: RefreshCliResponse + additionalProperties: false + mgmt.v1alpha1.AwsS3ConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - credentials + - not: + anyOf: + - required: + - credentials + - anyOf: + - required: + - endpoint + - not: + anyOf: + - required: + - endpoint + - anyOf: + - required: + - pathPrefix + - not: + anyOf: + - required: + - pathPrefix + - anyOf: + - required: + - region + - not: + anyOf: + - required: + - region + properties: + bucketArn: + type: string + title: bucket_arn + pathPrefix: + type: string + title: path_prefix + credentials: + allOf: + - title: credentials + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3Credentials' + region: + type: string + title: region + endpoint: + type: string + title: endpoint + bucket: + type: string + title: bucket + minLength: 1 + title: AwsS3ConnectionConfig + additionalProperties: false + mgmt.v1alpha1.AwsS3Credentials: + type: object + allOf: + - anyOf: + - required: + - accessKeyId + - not: + anyOf: + - required: + - accessKeyId + - anyOf: + - required: + - fromEc2Role + - not: + anyOf: + - required: + - fromEc2Role + - anyOf: + - required: + - profile + - not: + anyOf: + - required: + - profile + - anyOf: + - required: + - roleArn + - not: + anyOf: + - required: + - roleArn + - anyOf: + - required: + - roleExternalId + - not: + anyOf: + - required: + - roleExternalId + - anyOf: + - required: + - secretAccessKey + - not: + anyOf: + - required: + - secretAccessKey + - anyOf: + - required: + - sessionToken + - not: + anyOf: + - required: + - sessionToken + properties: + profile: + type: string + title: profile + accessKeyId: + type: string + title: access_key_id + secretAccessKey: + type: string + title: secret_access_key + sessionToken: + type: string + title: session_token + fromEc2Role: + type: boolean + title: from_ec2_role + roleArn: + type: string + title: role_arn + roleExternalId: + type: string + title: role_external_id + title: AwsS3Credentials + additionalProperties: false + description: |- + S3 Credentials that are used by the worker process. + Note: this may be optionally provided if the worker that is being hosted has environment credentials to the S3 bucket instead. + mgmt.v1alpha1.CheckConnectionConfigByIdRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + description: The connection id to validate + title: CheckConnectionConfigByIdRequest + additionalProperties: false + mgmt.v1alpha1.CheckConnectionConfigByIdResponse: + type: object + allOf: + - anyOf: + - required: + - connectionError + - not: + anyOf: + - required: + - connectionError + anyOf: + - required: + - connectionError + - not: + anyOf: + - required: + - connectionError + properties: + isConnected: + type: boolean + title: is_connected + description: Whether or not the API was able to ping the connection + connectionError: + type: string + title: connection_error + description: This is the error that was received if the API was unable to connect + privileges: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionRolePrivilege' + title: privileges + description: The privileges the role has to the connection + title: CheckConnectionConfigByIdResponse + additionalProperties: false + mgmt.v1alpha1.CheckConnectionConfigRequest: + type: object + properties: + connectionConfig: + allOf: + - title: connection_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' + title: CheckConnectionConfigRequest + additionalProperties: false + mgmt.v1alpha1.CheckConnectionConfigResponse: + type: object + allOf: + - anyOf: + - required: + - connectionError + - not: + anyOf: + - required: + - connectionError + anyOf: + - required: + - connectionError + - not: + anyOf: + - required: + - connectionError + properties: + isConnected: + type: boolean + title: is_connected + description: Whether or not the API was able to ping the connection + connectionError: + type: string + title: connection_error + description: This is the error that was received if the API was unable to connect + privileges: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionRolePrivilege' + title: privileges + title: CheckConnectionConfigResponse + additionalProperties: false + mgmt.v1alpha1.CheckSqlQueryRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + description: The connection id that the query will be checked against + query: + type: string + title: query + minLength: 1 + description: The full query that will be run through a PREPARE statement + title: CheckSqlQueryRequest + additionalProperties: false + mgmt.v1alpha1.CheckSqlQueryResponse: + type: object + allOf: + - anyOf: + - required: + - erorrMessage + - not: + anyOf: + - required: + - erorrMessage + anyOf: + - required: + - erorrMessage + - not: + anyOf: + - required: + - erorrMessage + properties: + isValid: + type: boolean + title: is_valid + description: >- + The query is run through PREPARE. Returns valid if it correctly + compiled + erorrMessage: + type: string + title: erorr_message + description: >- + The error message returned by the sql client if the prepare did not + return successfully + title: CheckSqlQueryResponse + additionalProperties: false + mgmt.v1alpha1.ClientTlsConfig: + type: object + allOf: + - anyOf: + - required: + - clientCert + - not: + anyOf: + - required: + - clientCert + - anyOf: + - required: + - clientKey + - not: + anyOf: + - required: + - clientKey + - anyOf: + - required: + - rootCert + - not: + anyOf: + - required: + - rootCert + properties: + rootCert: + type: string + title: root_cert + description: Root Certificate in PEM Format + clientCert: + type: string + title: client_cert + description: Client Certificate in PEM format. Must also provide key. + clientKey: + type: string + title: client_key + description: Client Key in PEM format. Must also provide cert. + title: ClientTlsConfig + additionalProperties: false + description: Config for providing client-side TLS certificates + mgmt.v1alpha1.Connection: + type: object + properties: + id: + type: string + title: id + description: The unique identifier of the connection + name: + type: string + title: name + description: The unique, friendly name of the connection + connectionConfig: + allOf: + - title: connection_config + description: Contains the connection configuration and connection type + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' + createdByUserId: + type: string + title: created_by_user_id + description: The user id of the user that created the connection + createdAt: + allOf: + - title: created_at + description: When the connection was created + - $ref: '#/components/schemas/google.protobuf.Timestamp' + updatedByUserId: + type: string + title: updated_by_user_id + description: Who last updated the connection + updatedAt: + allOf: + - title: updated_at + description: When the connection was last updated + - $ref: '#/components/schemas/google.protobuf.Timestamp' + accountId: + type: string + title: account_id + description: The unique account that owns this connection + title: Connection + additionalProperties: false + mgmt.v1alpha1.ConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - localDirConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - openaiConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - localDirConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - openaiConfig + - required: + - pgConfig + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - localDirConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - openaiConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - localDirConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - openaiConfig + - required: + - pgConfig + properties: + pgConfig: + allOf: + - title: pg_config + description: Configures a PostgreSQL connection + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresConnectionConfig' + awsS3Config: + allOf: + - title: aws_s3_config + description: Configures an AWS S3 Connection + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3ConnectionConfig' + mysqlConfig: + allOf: + - title: mysql_config + description: Configures a MySQL connection + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlConnectionConfig' + localDirConfig: + allOf: + - title: local_dir_config + description: >- + Configures a connection to a directory available on the local + file system + - $ref: >- + #/components/schemas/mgmt.v1alpha1.LocalDirectoryConnectionConfig + openaiConfig: + allOf: + - title: openai_config + description: Connection config for an OpenAI (or compatible) Connection + - $ref: '#/components/schemas/mgmt.v1alpha1.OpenAiConnectionConfig' + mongoConfig: + allOf: + - title: mongo_config + description: Configures a MongoDB Connection + - $ref: '#/components/schemas/mgmt.v1alpha1.MongoConnectionConfig' + gcpCloudstorageConfig: + allOf: + - title: gcp_cloudstorage_config + description: Configures a GCP Cloud Storage Connection + - $ref: >- + #/components/schemas/mgmt.v1alpha1.GcpCloudStorageConnectionConfig + dynamodbConfig: + allOf: + - title: dynamodb_config + description: Configures a DynamoDB Connection + - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBConnectionConfig' + mssqlConfig: + allOf: + - title: mssql_config + description: Configures a Microsoft SQL Server (mssql) Connection + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlConnectionConfig' + title: ConnectionConfig + additionalProperties: false + description: Configuration for all of the supported Neosync connection types + mgmt.v1alpha1.ConnectionRolePrivilege: + type: object + properties: + grantee: + type: string + title: grantee + description: The role that was given the permissions + schema: + type: string + title: schema + description: 'The database schema. Ex: public' + table: + type: string + title: table + description: The name of the table in the schema + privilegeType: + type: array + items: + type: string + title: privilege_type + description: The privileges given to that role + title: ConnectionRolePrivilege + additionalProperties: false + mgmt.v1alpha1.CreateConnectionRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + description: The friendly name of the connection + connectionConfig: + allOf: + - title: connection_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' + title: CreateConnectionRequest + additionalProperties: false + mgmt.v1alpha1.CreateConnectionResponse: + type: object + properties: + connection: + allOf: + - title: connection + - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' + title: CreateConnectionResponse + additionalProperties: false + mgmt.v1alpha1.DeleteConnectionRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: DeleteConnectionRequest + additionalProperties: false + mgmt.v1alpha1.DeleteConnectionResponse: + type: object + title: DeleteConnectionResponse + additionalProperties: false + mgmt.v1alpha1.DynamoDBConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - credentials + - not: + anyOf: + - required: + - credentials + - anyOf: + - required: + - endpoint + - not: + anyOf: + - required: + - endpoint + - anyOf: + - required: + - region + - not: + anyOf: + - required: + - region + properties: + credentials: + allOf: + - title: credentials + description: >- + Optional credentials that may be provided and will be used to + connect to the DynamoDB Instance. + If self-hosting, this may be provided by the environment in lieu of specifying these here + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3Credentials' + region: + type: string + title: region + description: >- + Optionally specify the region that the dynamodb instance lives in if + not provided by the environment. + endpoint: + type: string + title: endpoint + description: Optionally specify the endpoint that will be used by the AWS SDK. + title: DynamoDBConnectionConfig + additionalProperties: false + description: Configuration for a DynaomDB Connection + mgmt.v1alpha1.GcpCloudStorageConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - pathPrefix + - not: + anyOf: + - required: + - pathPrefix + - anyOf: + - required: + - serviceAccountCredentials + - not: + anyOf: + - required: + - serviceAccountCredentials + properties: + bucket: + type: string + title: bucket + minLength: 1 + description: The GCP Cloud Storage bucket that will be accessed. + pathPrefix: + type: string + title: path_prefix + description: The path prefix that will be appended to each file + serviceAccountCredentials: + type: string + title: service_account_credentials + description: stringified json of the service account credentials file + title: GcpCloudStorageConnectionConfig + additionalProperties: false + description: Configuration for GCP Cloud Storage Buckets + mgmt.v1alpha1.GetConnectionRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: GetConnectionRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionResponse: + type: object + properties: + connection: + allOf: + - title: connection + - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' + title: GetConnectionResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionsRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetConnectionsRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionsResponse: + type: object + properties: + connections: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.Connection' + title: connections + title: GetConnectionsResponse + additionalProperties: false + mgmt.v1alpha1.IsConnectionNameAvailableRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + connectionName: + type: string + title: connection_name + pattern: ^[a-z0-9-]{3,100}$ + title: IsConnectionNameAvailableRequest + additionalProperties: false + mgmt.v1alpha1.IsConnectionNameAvailableResponse: + type: object + properties: + isAvailable: + type: boolean + title: is_available + title: IsConnectionNameAvailableResponse + additionalProperties: false + mgmt.v1alpha1.LocalDirectoryConnectionConfig: + type: object + properties: + path: + type: string + title: path + minLength: 1 + description: >- + The absolute path to a directory that is available on the local file + system to the API and Worker nodes + title: LocalDirectoryConnectionConfig + additionalProperties: false + description: >- + Configures a connection to a directory available on the local file + system + mgmt.v1alpha1.MongoConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - url + - not: + anyOf: + - required: + - url + anyOf: + - required: + - url + - not: + anyOf: + - required: + - url + properties: + url: + type: string + title: url + description: The full mongo connection url + tunnel: + allOf: + - title: tunnel + description: >- + Provide tunnel configuration that can be used to access a + connection that is not publicly accessible to the internet + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' + clientTls: + allOf: + - title: client_tls + description: Provide client-side TLS Certificates + - $ref: '#/components/schemas/mgmt.v1alpha1.ClientTlsConfig' + title: MongoConnectionConfig + additionalProperties: false + mgmt.v1alpha1.MssqlConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - url + - not: + anyOf: + - required: + - url + anyOf: + - required: + - url + - not: + anyOf: + - required: + - url + properties: + url: + type: string + title: url + description: The URL with sqlserver scheme. + connectionOptions: + allOf: + - title: connection_options + - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' + tunnel: + allOf: + - title: tunnel + description: >- + Provide tunnel configuration that can be used to access a + postgres connection that is not publicly accessible to the + internet + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' + title: MssqlConnectionConfig + additionalProperties: false + description: Configuration for a Mssql Connection + mgmt.v1alpha1.MysqlConnection: + type: object + properties: + user: + type: string + title: user + pass: + type: string + title: pass + protocol: + type: string + title: protocol + host: + type: string + title: host + port: + type: integer + title: port + name: + type: string + title: name + title: MysqlConnection + additionalProperties: false + mgmt.v1alpha1.MysqlConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - connection + - required: + - url + - not: + anyOf: + - required: + - connection + - required: + - url + anyOf: + - required: + - connection + - required: + - url + - not: + anyOf: + - required: + - connection + - required: + - url + properties: + url: + type: string + title: url + connection: + allOf: + - title: connection + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlConnection' + tunnel: + allOf: + - title: tunnel + description: >- + Provide tunnel configuration that can be used to access a + postgres connection that is not publicly accessible to the + internet + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' + connectionOptions: + allOf: + - title: connection_options + - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' + title: MysqlConnectionConfig + additionalProperties: false + mgmt.v1alpha1.OpenAiConnectionConfig: + type: object + properties: + apiKey: + type: string + title: api_key + description: OpenAI Api Key + apiUrl: + type: string + title: api_url + description: OpenAI URL + title: OpenAiConnectionConfig + additionalProperties: false + description: Configures a connection to OpenAI or OpenAI compatible API. + mgmt.v1alpha1.PostgresConnection: + type: object + allOf: + - anyOf: + - required: + - sslMode + - not: + anyOf: + - required: + - sslMode + anyOf: + - required: + - sslMode + - not: + anyOf: + - required: + - sslMode + properties: + host: + type: string + title: host + port: + type: integer + title: port + name: + type: string + title: name + user: + type: string + title: user + pass: + type: string + title: pass + sslMode: + type: string + title: ssl_mode + title: PostgresConnection + additionalProperties: false + mgmt.v1alpha1.PostgresConnectionConfig: + type: object + allOf: + - anyOf: + - required: + - connection + - required: + - url + - not: + anyOf: + - required: + - connection + - required: + - url + anyOf: + - required: + - connection + - required: + - url + - not: + anyOf: + - required: + - connection + - required: + - url + properties: + url: + type: string + title: url + connection: + allOf: + - title: connection + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresConnection' + tunnel: + allOf: + - title: tunnel + description: >- + Provide tunnel configuration that can be used to access a + postgres connection that is not publicly accessible to the + internet + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' + connectionOptions: + allOf: + - title: connection_options + - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' + clientTls: + allOf: + - title: client_tls + description: Provide client-side TLS Certificates + - $ref: '#/components/schemas/mgmt.v1alpha1.ClientTlsConfig' + title: PostgresConnectionConfig + additionalProperties: false + mgmt.v1alpha1.SSHAuthentication: + type: object + allOf: + - anyOf: + - required: + - passphrase + - required: + - privateKey + - not: + anyOf: + - required: + - passphrase + - required: + - privateKey + anyOf: + - required: + - passphrase + - required: + - privateKey + - not: + anyOf: + - required: + - passphrase + - required: + - privateKey + properties: + passphrase: + allOf: + - title: passphrase + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHPassphrase' + privateKey: + allOf: + - title: private_key + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHPrivateKey' + title: SSHAuthentication + additionalProperties: false + description: SSH Authentication + mgmt.v1alpha1.SSHPassphrase: + type: object + properties: + value: + type: string + title: value + minLength: 1 + description: >- + The password to be used to connect to the SSH server eventually we + can expand this to allow pulling from other sources. + title: SSHPassphrase + additionalProperties: false + description: >- + Contains the configuration needed to retrieve the SSH passphrase for the + tunnel + mgmt.v1alpha1.SSHPrivateKey: + type: object + allOf: + - anyOf: + - required: + - passphrase + - not: + anyOf: + - required: + - passphrase + anyOf: + - required: + - passphrase + - not: + anyOf: + - required: + - passphrase + properties: + value: + type: string + title: value + minLength: 1 + description: The private key in PEM format. + passphrase: + type: string + title: passphrase + description: If the private key is encrypted, this value should decrypt it. + title: SSHPrivateKey + additionalProperties: false + description: >- + Contains the configuration needed to retrieve the SSH private key for + the tunnel + mgmt.v1alpha1.SSHTunnel: + type: object + allOf: + - anyOf: + - required: + - knownHostPublicKey + - not: + anyOf: + - required: + - knownHostPublicKey + anyOf: + - required: + - knownHostPublicKey + - not: + anyOf: + - required: + - knownHostPublicKey + properties: + host: + type: string + title: host + minLength: 1 + description: The host of the SSH server + port: + type: integer + title: port + description: The port of the SSH server, typically 22 + user: + type: string + title: user + minLength: 1 + description: The user that will be used to authenticate + knownHostPublicKey: + type: string + title: known_host_public_key + minLength: 1 + description: >- + Optionally provide the public key of the known host of the SSH + tunnel that we are connecting to. + If this is not provided, the server will blindly connect to the host with the given credentials. + This is not recommended for production use! + authentication: + allOf: + - title: authentication + description: >- + Provide the authentication required to successfully connect to + the SSH server for tunneling + - $ref: '#/components/schemas/mgmt.v1alpha1.SSHAuthentication' + title: SSHTunnel + additionalProperties: false + mgmt.v1alpha1.SqlConnectionOptions: + type: object + allOf: + - anyOf: + - required: + - maxConnectionLimit + - not: + anyOf: + - required: + - maxConnectionLimit + anyOf: + - required: + - maxConnectionLimit + - not: + anyOf: + - required: + - maxConnectionLimit + properties: + maxConnectionLimit: + type: integer + title: max_connection_limit + description: Limits the number of open connections in the pool. + title: SqlConnectionOptions + additionalProperties: false + mgmt.v1alpha1.UpdateConnectionRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + connectionConfig: + allOf: + - title: connection_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' + title: UpdateConnectionRequest + additionalProperties: false + mgmt.v1alpha1.UpdateConnectionResponse: + type: object + properties: + connection: + allOf: + - title: connection + - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' + title: UpdateConnectionResponse + additionalProperties: false + google.protobuf.NullValue: + type: string + title: NullValue + enum: + - NULL_VALUE + description: >- + `NullValue` is a singleton enumeration to represent the null value for + the + `Value` type union. + + The JSON representation for `NullValue` is JSON `null`. + google.protobuf.ListValue: + type: object + properties: + values: + type: array + items: + $ref: '#/components/schemas/google.protobuf.Value' + title: values + description: Repeated field of dynamically typed values. + title: ListValue + additionalProperties: false + description: |- + `ListValue` is a wrapper around a repeated field of values. + + The JSON representation for `ListValue` is JSON array. + google.protobuf.Struct: + type: object + properties: + fields: + type: object + title: fields + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/google.protobuf.Value' + description: Unordered map of dynamically typed values. + title: Struct + additionalProperties: false + description: |- + `Struct` represents a structured data value, consisting of fields + which map to dynamically typed values. In some languages, `Struct` + might be supported by a native representation. For example, in + scripting languages like JS a struct is represented as an + object. The details of that representation are described together + with the proto support for the language. + + The JSON representation for `Struct` is JSON object. + google.protobuf.Struct.FieldsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/google.protobuf.Value' + title: FieldsEntry + additionalProperties: false + google.protobuf.Value: + oneOf: + - type: 'null' + - type: number + - type: string + - type: boolean + - type: array + - type: object + additionalProperties: true + description: |- + `Value` represents a dynamically typed value which can be either + null, a number, a string, a boolean, a recursive struct value, or a + list of values. A producer of value is expected to set one of these + variants. Absence of any variant indicates an error. + + The JSON representation for `Value` is JSON value. + mgmt.v1alpha1.AwsDynamoDBStreamConfig: + type: object + title: AwsDynamoDBStreamConfig + additionalProperties: false + mgmt.v1alpha1.AwsS3SchemaConfig: + type: object + allOf: + - anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + properties: + jobId: + type: string + title: job_id + format: uuid + jobRunId: + type: string + title: job_run_id + minLength: 1 + title: AwsS3SchemaConfig + additionalProperties: false + mgmt.v1alpha1.AwsS3StreamConfig: + type: object + allOf: + - anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + properties: + jobId: + type: string + title: job_id + format: uuid + jobRunId: + type: string + title: job_run_id + minLength: 1 + title: AwsS3StreamConfig + additionalProperties: false + mgmt.v1alpha1.ConnectionSchemaConfig: + type: object + allOf: + - anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - pgConfig + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mongoConfig + - required: + - mssqlConfig + - required: + - mysqlConfig + - required: + - pgConfig + properties: + pgConfig: + allOf: + - title: pg_config + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSchemaConfig' + awsS3Config: + allOf: + - title: aws_s3_config + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3SchemaConfig' + mysqlConfig: + allOf: + - title: mysql_config + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSchemaConfig' + mongoConfig: + allOf: + - title: mongo_config + - $ref: '#/components/schemas/mgmt.v1alpha1.MongoSchemaConfig' + gcpCloudstorageConfig: + allOf: + - title: gcp_cloudstorage_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GcpCloudStorageSchemaConfig' + dynamodbConfig: + allOf: + - title: dynamodb_config + - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSchemaConfig' + mssqlConfig: + allOf: + - title: mssql_config + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSchemaConfig' + title: ConnectionSchemaConfig + additionalProperties: false + mgmt.v1alpha1.ConnectionStreamConfig: + type: object + allOf: + - anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mysqlConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mysqlConfig + - required: + - pgConfig + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mysqlConfig + - required: + - pgConfig + - not: + anyOf: + - required: + - awsS3Config + - required: + - dynamodbConfig + - required: + - gcpCloudstorageConfig + - required: + - mysqlConfig + - required: + - pgConfig + properties: + pgConfig: + allOf: + - title: pg_config + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresStreamConfig' + awsS3Config: + allOf: + - title: aws_s3_config + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3StreamConfig' + mysqlConfig: + allOf: + - title: mysql_config + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlStreamConfig' + gcpCloudstorageConfig: + allOf: + - title: gcp_cloudstorage_config + - $ref: '#/components/schemas/mgmt.v1alpha1.GcpCloudStorageStreamConfig' + dynamodbConfig: + allOf: + - title: dynamodb_config + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsDynamoDBStreamConfig' + title: ConnectionStreamConfig + additionalProperties: false + mgmt.v1alpha1.DatabaseColumn: + type: object + allOf: + - anyOf: + - required: + - columnDefault + - not: + anyOf: + - required: + - columnDefault + - anyOf: + - required: + - generatedType + - not: + anyOf: + - required: + - generatedType + - anyOf: + - required: + - identityGeneration + - not: + anyOf: + - required: + - identityGeneration + properties: + schema: + type: string + title: schema + description: 'The database schema. Ex: public' + table: + type: string + title: table + description: The name of the table in the schema + column: + type: string + title: column + description: The name of the column + dataType: + type: string + title: data_type + description: The datatype of the column + isNullable: + type: string + title: is_nullable + description: The isNullable Flag of the column + columnDefault: + type: string + title: column_default + description: The default value of the column if available + generatedType: + type: string + title: generated_type + description: >- + Populated if the column is generated. The value is the type of + generated column it is. For example, postgres is 's' for stored + May be other values in the future, or other DB providers may use a different value types. + identityGeneration: + type: string + title: identity_generation + description: >- + Populated if the column is an identity. The value is the type of the + identity column it is. For example, postgres is 'd' for generated by + default, or 'a' for generated always. + title: DatabaseColumn + additionalProperties: false + mgmt.v1alpha1.DatabaseTable: + type: object + properties: + schema: + type: string + title: schema + minLength: 1 + table: + type: string + title: table + minLength: 1 + title: DatabaseTable + additionalProperties: false + mgmt.v1alpha1.DynamoDBSchemaConfig: + type: object + title: DynamoDBSchemaConfig + additionalProperties: false + mgmt.v1alpha1.ForeignConstraint: + type: object + properties: + column: + type: string + title: column + description: '@deprecated - use columns' + isNullable: + type: boolean + title: is_nullable + description: '@deprecated - use not_nullable' + foreignKey: + allOf: + - title: foreign_key + - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignKey' + columns: + type: array + items: + type: string + title: columns + notNullable: + type: array + items: + type: boolean + title: not_nullable + title: ForeignConstraint + additionalProperties: false + mgmt.v1alpha1.ForeignConstraintTables: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraint' + title: constraints + title: ForeignConstraintTables + additionalProperties: false + mgmt.v1alpha1.ForeignKey: + type: object + properties: + table: + type: string + title: table + column: + type: string + title: column + description: '@deprecated - use columns' + columns: + type: array + items: + type: string + title: columns + title: ForeignKey + additionalProperties: false + mgmt.v1alpha1.GcpCloudStorageSchemaConfig: + type: object + allOf: + - anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + properties: + jobId: + type: string + title: job_id + format: uuid + jobRunId: + type: string + title: job_run_id + minLength: 1 + title: GcpCloudStorageSchemaConfig + additionalProperties: false + mgmt.v1alpha1.GcpCloudStorageStreamConfig: + type: object + allOf: + - anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + anyOf: + - required: + - jobId + - required: + - jobRunId + - not: + anyOf: + - required: + - jobId + - required: + - jobRunId + properties: + jobId: + type: string + title: job_id + format: uuid + jobRunId: + type: string + title: job_run_id + minLength: 1 + title: GcpCloudStorageStreamConfig + additionalProperties: false + mgmt.v1alpha1.GetAiGeneratedDataRequest: + type: object + allOf: + - anyOf: + - required: + - userPrompt + - not: + anyOf: + - required: + - userPrompt + anyOf: + - required: + - userPrompt + - not: + anyOf: + - required: + - userPrompt + properties: + aiConnectionId: + type: string + title: ai_connection_id + format: uuid + count: + oneOf: + - type: string + - type: number + title: count + maximum: 10 + minimum: 1 + modelName: + type: string + title: model_name + minLength: 1 + userPrompt: + type: string + title: user_prompt + dataConnectionId: + type: string + title: data_connection_id + format: uuid + table: + allOf: + - title: table + - $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseTable' + title: GetAiGeneratedDataRequest + additionalProperties: false + mgmt.v1alpha1.GetAiGeneratedDataResponse: + type: object + properties: + records: + type: array + items: + $ref: '#/components/schemas/google.protobuf.Struct' + title: records + description: A list of generated records + title: GetAiGeneratedDataResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionDataStreamRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + streamConfig: + allOf: + - title: stream_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionStreamConfig' + schema: + type: string + title: schema + table: + type: string + title: table + title: GetConnectionDataStreamRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionDataStreamResponse: + type: object + properties: + row: + type: object + title: row + additionalProperties: + type: string + title: value + format: byte + description: >- + A map of column name to the bytes value of the data that was found + for that column and row + title: GetConnectionDataStreamResponse + additionalProperties: false + description: Each stream response is a single row in the requested schema and table + mgmt.v1alpha1.GetConnectionDataStreamResponse.RowEntry: + type: object + properties: + key: + type: string + title: key + value: + type: string + title: value + format: byte + title: RowEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionForeignConstraintsRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + title: GetConnectionForeignConstraintsRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionForeignConstraintsResponse: + type: object + properties: + tableConstraints: + type: object + title: table_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' + description: >- + the key here is .
and the list of tables that it + depends on, also `.
` format. + title: GetConnectionForeignConstraintsResponse + additionalProperties: false + description: Dependency constraints for a specific table + mgmt.v1alpha1.GetConnectionForeignConstraintsResponse.TableConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' + title: TableConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionInitStatementsRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + options: + allOf: + - title: options + - $ref: '#/components/schemas/mgmt.v1alpha1.InitStatementOptions' + title: GetConnectionInitStatementsRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionInitStatementsResponse: + type: object + properties: + tableInitStatements: + type: object + title: table_init_statements + additionalProperties: + type: string + title: value + description: >- + the key here is .
and value is the table init + statement. + tableTruncateStatements: + type: object + title: table_truncate_statements + additionalProperties: + type: string + title: value + description: >- + the key here is .
and value is the table truncate + statement. + schemaInitStatements: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.SchemaInitStatements' + title: schema_init_statements + title: GetConnectionInitStatementsResponse + additionalProperties: false + description: Init statement for a specific table + mgmt.v1alpha1.GetConnectionInitStatementsResponse.TableInitStatementsEntry: + type: object + properties: + key: + type: string + title: key + value: + type: string + title: value + title: TableInitStatementsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionInitStatementsResponse.TableTruncateStatementsEntry: + type: object + properties: + key: + type: string + title: key + value: + type: string + title: value + title: TableTruncateStatementsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionPrimaryConstraintsRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + title: GetConnectionPrimaryConstraintsRequest + additionalProperties: false + description: Primary constraints for a specific table + mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse: + type: object + properties: + tableConstraints: + type: object + title: table_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' + description: the key here is .
and value is the primary constraint + title: GetConnectionPrimaryConstraintsResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse.TableConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' + title: TableConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaMapRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + schemaConfig: + allOf: + - title: schema_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionSchemaConfig' + title: GetConnectionSchemaMapRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaMapResponse: + type: object + properties: + schemaMap: + type: object + title: schema_map + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' + description: >- + Returns the database columns separated by the fully qualified + .
+ title: GetConnectionSchemaMapResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaMapResponse.SchemaMapEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' + title: SchemaMapEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaMapsRequest: + type: object + properties: + requests: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapRequest' + title: requests + description: List of connection schema maps to request + title: GetConnectionSchemaMapsRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaMapsResponse: + type: object + properties: + responses: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapResponse' + title: responses + description: List of responses in the same order as the input + connectionIds: + type: array + items: + type: string + title: connection_ids + description: Parallel array of each connection id that matches with the response + title: GetConnectionSchemaMapsResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + schemaConfig: + allOf: + - title: schema_config + - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionSchemaConfig' + title: GetConnectionSchemaRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionSchemaResponse: + type: object + properties: + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseColumn' + title: schemas + title: GetConnectionSchemaResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionTableConstraintsRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + title: GetConnectionTableConstraintsRequest + additionalProperties: false + mgmt.v1alpha1.GetConnectionTableConstraintsResponse: + type: object + properties: + foreignKeyConstraints: + type: object + title: foreign_key_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' + description: >- + the key here is .
and the list of tables that it + depends on, also `.
` format. + primaryKeyConstraints: + type: object + title: primary_key_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' + description: the key here is .
and value is the primary constraint + uniqueConstraints: + type: object + title: unique_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraints' + description: the key here is .
and value is the unique constraint + title: GetConnectionTableConstraintsResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionTableConstraintsResponse.ForeignKeyConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' + title: ForeignKeyConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionTableConstraintsResponse.PrimaryKeyConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' + title: PrimaryKeyConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionTableConstraintsResponse.UniqueConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraints' + title: UniqueConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetConnectionUniqueConstraintsRequest: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + title: GetConnectionUniqueConstraintsRequest + additionalProperties: false + description: Unique constraints for a specific table + mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse: + type: object + properties: + tableConstraints: + type: object + title: table_constraints + additionalProperties: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' + description: the key here is .
and value is the unique constraint + title: GetConnectionUniqueConstraintsResponse + additionalProperties: false + mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse.TableConstraintsEntry: + type: object + properties: + key: + type: string + title: key + value: + allOf: + - title: value + - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' + title: TableConstraintsEntry + additionalProperties: false + mgmt.v1alpha1.GetTableRowCountRequest: + type: object + allOf: + - anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + properties: + connectionId: + type: string + title: connection_id + schema: + type: string + title: schema + table: + type: string + title: table + whereClause: + type: string + title: where_clause + title: GetTableRowCountRequest + additionalProperties: false + mgmt.v1alpha1.GetTableRowCountResponse: + type: object + properties: + count: + oneOf: + - type: string + - type: number + title: count + title: GetTableRowCountResponse + additionalProperties: false + mgmt.v1alpha1.InitStatementOptions: + type: object + properties: + initSchema: + type: boolean + title: init_schema + truncateBeforeInsert: + type: boolean + title: truncate_before_insert + truncateCascade: + type: boolean + title: truncate_cascade + title: InitStatementOptions + additionalProperties: false + mgmt.v1alpha1.MongoSchemaConfig: + type: object + title: MongoSchemaConfig + additionalProperties: false + mgmt.v1alpha1.MssqlSchemaConfig: + type: object + title: MssqlSchemaConfig + additionalProperties: false + mgmt.v1alpha1.MysqlSchemaConfig: + type: object + title: MysqlSchemaConfig + additionalProperties: false + mgmt.v1alpha1.MysqlStreamConfig: + type: object + title: MysqlStreamConfig + additionalProperties: false + mgmt.v1alpha1.PostgresSchemaConfig: + type: object + title: PostgresSchemaConfig + additionalProperties: false + mgmt.v1alpha1.PostgresStreamConfig: + type: object + title: PostgresStreamConfig + additionalProperties: false + mgmt.v1alpha1.PrimaryConstraint: + type: object + properties: + columns: + type: array + items: + type: string + title: columns + title: PrimaryConstraint + additionalProperties: false + mgmt.v1alpha1.SchemaInitStatements: + type: object + properties: + label: + type: string + title: label + statements: + type: array + items: + type: string + title: statements + title: SchemaInitStatements + additionalProperties: false + mgmt.v1alpha1.UniqueConstraint: + type: object + properties: + columns: + type: array + items: + type: string + title: columns + title: UniqueConstraint + additionalProperties: false + mgmt.v1alpha1.UniqueConstraints: + type: object + properties: + constraints: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' + title: constraints + title: UniqueConstraints + additionalProperties: false + mgmt.v1alpha1.ActivityStatus: + type: string + title: ActivityStatus + enum: + - ACTIVITY_STATUS_UNSPECIFIED + - ACTIVITY_STATUS_SCHEDULED + - ACTIVITY_STATUS_STARTED + - ACTIVITY_STATUS_CANCELED + - ACTIVITY_STATUS_FAILED + mgmt.v1alpha1.AwsS3DestinationConnectionOptions.StorageClass: + type: string + title: StorageClass + enum: + - STORAGE_CLASS_UNSPECIFIED + - STORAGE_CLASS_STANDARD + - STORAGE_CLASS_REDUCED_REDUNDANCY + - STORAGE_CLASS_GLACIER + - STORAGE_CLASS_STANDARD_IA + - STORAGE_CLASS_ONEZONE_IA + - STORAGE_CLASS_INTELLIGENT_TIERING + - STORAGE_CLASS_DEEP_ARCHIVE + mgmt.v1alpha1.JobRunStatus: + type: string + title: JobRunStatus + enum: + - JOB_RUN_STATUS_UNSPECIFIED + - JOB_RUN_STATUS_PENDING + - JOB_RUN_STATUS_RUNNING + - JOB_RUN_STATUS_COMPLETE + - JOB_RUN_STATUS_ERROR + - JOB_RUN_STATUS_CANCELED + - JOB_RUN_STATUS_TERMINATED + - JOB_RUN_STATUS_FAILED + - JOB_RUN_STATUS_TIMED_OUT + description: An enumeration of job run statuses. + mgmt.v1alpha1.JobStatus: + type: string + title: JobStatus + enum: + - JOB_STATUS_UNSPECIFIED + - JOB_STATUS_ENABLED + - JOB_STATUS_PAUSED + - JOB_STATUS_DISABLED + mgmt.v1alpha1.LogLevel: + type: string + title: LogLevel + enum: + - LOG_LEVEL_UNSPECIFIED + - LOG_LEVEL_DEBUG + - LOG_LEVEL_INFO + - LOG_LEVEL_WARN + - LOG_LEVEL_ERROR + mgmt.v1alpha1.LogWindow: + type: string + title: LogWindow + enum: + - LOG_WINDOW_NO_TIME_UNSPECIFIED + - LOG_WINDOW_FIFTEEN_MIN + - LOG_WINDOW_ONE_HOUR + - LOG_WINDOW_ONE_DAY + mgmt.v1alpha1.TransformerSource: + type: string + title: TransformerSource + enum: + - TRANSFORMER_SOURCE_UNSPECIFIED + - TRANSFORMER_SOURCE_PASSTHROUGH + - TRANSFORMER_SOURCE_GENERATE_DEFAULT + - TRANSFORMER_SOURCE_TRANSFORM_JAVASCRIPT + - TRANSFORMER_SOURCE_GENERATE_EMAIL + - TRANSFORMER_SOURCE_TRANSFORM_EMAIL + - TRANSFORMER_SOURCE_GENERATE_BOOL + - TRANSFORMER_SOURCE_GENERATE_CARD_NUMBER + - TRANSFORMER_SOURCE_GENERATE_CITY + - TRANSFORMER_SOURCE_GENERATE_E164_PHONE_NUMBER + - TRANSFORMER_SOURCE_GENERATE_FIRST_NAME + - TRANSFORMER_SOURCE_GENERATE_FLOAT64 + - TRANSFORMER_SOURCE_GENERATE_FULL_ADDRESS + - TRANSFORMER_SOURCE_GENERATE_FULL_NAME + - TRANSFORMER_SOURCE_GENERATE_GENDER + - TRANSFORMER_SOURCE_GENERATE_INT64_PHONE_NUMBER + - TRANSFORMER_SOURCE_GENERATE_INT64 + - TRANSFORMER_SOURCE_GENERATE_RANDOM_INT64 + - TRANSFORMER_SOURCE_GENERATE_LAST_NAME + - TRANSFORMER_SOURCE_GENERATE_SHA256HASH + - TRANSFORMER_SOURCE_GENERATE_SSN + - TRANSFORMER_SOURCE_GENERATE_STATE + - TRANSFORMER_SOURCE_GENERATE_STREET_ADDRESS + - TRANSFORMER_SOURCE_GENERATE_STRING_PHONE_NUMBER + - TRANSFORMER_SOURCE_GENERATE_STRING + - TRANSFORMER_SOURCE_GENERATE_RANDOM_STRING + - TRANSFORMER_SOURCE_GENERATE_UNIXTIMESTAMP + - TRANSFORMER_SOURCE_GENERATE_USERNAME + - TRANSFORMER_SOURCE_GENERATE_UTCTIMESTAMP + - TRANSFORMER_SOURCE_GENERATE_UUID + - TRANSFORMER_SOURCE_GENERATE_ZIPCODE + - TRANSFORMER_SOURCE_TRANSFORM_E164_PHONE_NUMBER + - TRANSFORMER_SOURCE_TRANSFORM_FIRST_NAME + - TRANSFORMER_SOURCE_TRANSFORM_FLOAT64 + - TRANSFORMER_SOURCE_TRANSFORM_FULL_NAME + - TRANSFORMER_SOURCE_TRANSFORM_INT64_PHONE_NUMBER + - TRANSFORMER_SOURCE_TRANSFORM_INT64 + - TRANSFORMER_SOURCE_TRANSFORM_LAST_NAME + - TRANSFORMER_SOURCE_TRANSFORM_PHONE_NUMBER + - TRANSFORMER_SOURCE_TRANSFORM_STRING + - TRANSFORMER_SOURCE_GENERATE_NULL + - TRANSFORMER_SOURCE_GENERATE_CATEGORICAL + - TRANSFORMER_SOURCE_TRANSFORM_CHARACTER_SCRAMBLE + - TRANSFORMER_SOURCE_USER_DEFINED + - TRANSFORMER_SOURCE_GENERATE_JAVASCRIPT + - TRANSFORMER_SOURCE_GENERATE_COUNTRY + - TRANSFORMER_SOURCE_TRANSFORM_PII_TEXT + mgmt.v1alpha1.ActivityFailure: + type: object + properties: + message: + type: string + title: message + title: ActivityFailure + additionalProperties: false + mgmt.v1alpha1.ActivityOptions: + type: object + allOf: + - anyOf: + - required: + - scheduleToCloseTimeout + - not: + anyOf: + - required: + - scheduleToCloseTimeout + - anyOf: + - required: + - startToCloseTimeout + - not: + anyOf: + - required: + - startToCloseTimeout + properties: + scheduleToCloseTimeout: + oneOf: + - type: string + - type: number + title: schedule_to_close_timeout + minimum: 1 + description: >- + Total time that a workflow is willing to wait for an activity to + complete, including retries. + Measured in seconds + startToCloseTimeout: + oneOf: + - type: string + - type: number + title: start_to_close_timeout + minimum: 1 + description: |- + Max time of a single Temporal Activity execution attempt. + This timeout should be as short as the longest psosible execution of any activity (e.g. table sync). + Important to know that this is per retry attempt. Defaults to the schedule to close timeout if not provided. + Measured in seconds + retryPolicy: + allOf: + - title: retry_policy + description: |- + Optionally define a retry policy for the activity + If max attempts is not set, the activity will retry indefinitely until the start to close timeout lapses + - $ref: '#/components/schemas/mgmt.v1alpha1.RetryPolicy' + title: ActivityOptions + additionalProperties: false + description: >- + Config that contains various timeouts that are configured in the + underlying temporal workflow(s) and activities + mgmt.v1alpha1.AiGenerateSourceOptions: + type: object + allOf: + - anyOf: + - required: + - fkSourceConnectionId + - not: + anyOf: + - required: + - fkSourceConnectionId + - anyOf: + - required: + - generateBatchSize + - not: + anyOf: + - required: + - generateBatchSize + - anyOf: + - required: + - userPrompt + - not: + anyOf: + - required: + - userPrompt + properties: + aiConnectionId: + type: string + title: ai_connection_id + format: uuid + description: >- + The connection id that corresponds with an AI-based Neosync + connection + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceSchemaOption' + title: schemas + minItems: 1 + description: >- + The list of schemas (and their tables) along with any configuration + options that will be used to generate data for. + fkSourceConnectionId: + type: string + title: fk_source_connection_id + format: uuid + description: >- + An optional connection id that will be used as the basis for the + shape of data to be generated. + modelName: + type: string + title: model_name + minLength: 1 + description: The name of the model to use + userPrompt: + type: string + title: user_prompt + description: Optionally provide a user prompt to give more context to the schema + generateBatchSize: + oneOf: + - type: string + - type: number + title: generate_batch_size + maximum: 100 + minimum: 1 + description: >- + The batch size that will be used to generate X number of records. + This is global and will be applied to all tables configured. + title: AiGenerateSourceOptions + additionalProperties: false + mgmt.v1alpha1.AiGenerateSourceSchemaOption: + type: object + properties: + schema: + type: string + title: schema + minLength: 1 + description: The dataabase schema + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceTableOption' + title: tables + minItems: 1 + description: >- + The list of tables (and their configuration) that reside within the + schema to receive generated data + title: AiGenerateSourceSchemaOption + additionalProperties: false + mgmt.v1alpha1.AiGenerateSourceTableOption: + type: object + properties: + table: + type: string + title: table + minLength: 1 + description: >- + The table that will be used to. 1. The schema of the table will be + injected into the prompt, of which the resulting data will then be + inserted. + rowCount: + oneOf: + - type: string + - type: number + title: row_count + maximum: 1000 + minimum: 1 + description: The total number of records to be generated. + title: AiGenerateSourceTableOption + additionalProperties: false + mgmt.v1alpha1.AwsS3DestinationConnectionOptions: + type: object + allOf: + - anyOf: + - required: + - maxInFlight + - not: + anyOf: + - required: + - maxInFlight + - anyOf: + - required: + - timeout + - not: + anyOf: + - required: + - timeout + properties: + storageClass: + allOf: + - title: storage_class + description: >- + The storage class that will be used when objects are written to + S3 + - $ref: >- + #/components/schemas/mgmt.v1alpha1.AwsS3DestinationConnectionOptions.StorageClass + maxInFlight: + type: integer + title: max_in_flight + description: >- + The maximum number of batched messages to have in flight at a given + time. Increase this to improve throughput. + timeout: + type: string + title: timeout + description: >- + The maximum period (duration string) to wait on an upload before + abandoning it and reattempting. + batch: + allOf: + - title: batch + description: >- + Configure batching options to more efficiently store records in + S3 + - $ref: '#/components/schemas/mgmt.v1alpha1.BatchConfig' + title: AwsS3DestinationConnectionOptions + additionalProperties: false + mgmt.v1alpha1.AwsS3SourceConnectionOptions: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + title: AwsS3SourceConnectionOptions + additionalProperties: false + mgmt.v1alpha1.BatchConfig: + type: object + allOf: + - anyOf: + - required: + - count + - not: + anyOf: + - required: + - count + - anyOf: + - required: + - period + - not: + anyOf: + - required: + - period + properties: + count: + type: integer + title: count + description: The max allowed in a batch before it is flushed. 0 to disable. + period: + type: string + title: period + description: >- + A duration string in which an incomplete batch should be flushed + regardless of the count. + Examples are 1s, 1m, 500ms + title: BatchConfig + additionalProperties: false + mgmt.v1alpha1.CancelJobRunRequest: + type: object + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + title: CancelJobRunRequest + additionalProperties: false + mgmt.v1alpha1.CancelJobRunResponse: + type: object + title: CancelJobRunResponse + additionalProperties: false + mgmt.v1alpha1.ColumnError: + type: object + properties: + schema: + type: string + title: schema + table: + type: string + title: table + column: + type: string + title: column + errors: + type: array + items: + type: string + title: errors + title: ColumnError + additionalProperties: false + mgmt.v1alpha1.CreateJobDestination: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + options: + allOf: + - title: options + - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' + title: CreateJobDestination + additionalProperties: false + mgmt.v1alpha1.CreateJobDestinationConnectionsRequest: + type: object + properties: + jobId: + type: string + title: job_id + format: uuid + destinations: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobDestination' + title: destinations + title: CreateJobDestinationConnectionsRequest + additionalProperties: false + mgmt.v1alpha1.CreateJobDestinationConnectionsResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: CreateJobDestinationConnectionsResponse + additionalProperties: false + mgmt.v1alpha1.CreateJobRequest: + type: object + allOf: + - anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + properties: + accountId: + type: string + title: account_id + format: uuid + description: The unique account identifier that this job will be associated with + jobName: + type: string + title: job_name + pattern: ^[a-z0-9-]{3,100}$ + description: The unique, friendly name of the job. This is unique per account + cronSchedule: + type: string + title: cron_schedule + description: >- + Optionally provide a cron schedule. Goes into effect if the job + status is set to enabled + mappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' + title: mappings + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' + destinations: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobDestination' + title: destinations + initiateJobRun: + type: boolean + title: initiate_job_run + description: >- + Initially trigger a run of this job regardless of its status or cron + schedule + workflowOptions: + allOf: + - title: workflow_options + description: >- + Specify timeouts and other workflow options for the underlying + temporal workflow + - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' + syncOptions: + allOf: + - title: sync_options + description: >- + Specify timeout and retry options for data synchronization + activities + Data sync activities are any piece of work that involves actually synchronizing data from a source to a destination + For the data sync and generate jobs, this will be applied per table + - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' + virtualForeignKeys: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' + title: virtual_foreign_keys + title: CreateJobRequest + additionalProperties: false + mgmt.v1alpha1.CreateJobResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: CreateJobResponse + additionalProperties: false + mgmt.v1alpha1.CreateJobRunRequest: + type: object + properties: + jobId: + type: string + title: job_id + format: uuid + title: CreateJobRunRequest + additionalProperties: false + mgmt.v1alpha1.CreateJobRunResponse: + type: object + title: CreateJobRunResponse + additionalProperties: false + mgmt.v1alpha1.DatabaseError: + type: object + properties: + errors: + type: array + items: + type: string + title: errors + title: DatabaseError + additionalProperties: false + mgmt.v1alpha1.DeleteJobDestinationConnectionRequest: + type: object + properties: + destinationId: + type: string + title: destination_id + format: uuid + title: DeleteJobDestinationConnectionRequest + additionalProperties: false + mgmt.v1alpha1.DeleteJobDestinationConnectionResponse: + type: object + title: DeleteJobDestinationConnectionResponse + additionalProperties: false + mgmt.v1alpha1.DeleteJobRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: DeleteJobRequest + additionalProperties: false + mgmt.v1alpha1.DeleteJobResponse: + type: object + title: DeleteJobResponse + additionalProperties: false + mgmt.v1alpha1.DeleteJobRunRequest: + type: object + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + title: DeleteJobRunRequest + additionalProperties: false + mgmt.v1alpha1.DeleteJobRunResponse: + type: object + title: DeleteJobRunResponse + additionalProperties: false + mgmt.v1alpha1.DynamoDBDestinationConnectionOptions: + type: object + properties: + tableMappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBDestinationTableMapping' + title: table_mappings + description: >- + List of table mappings when piping data from a dynamoDB table to + another dynamoDB table + title: DynamoDBDestinationConnectionOptions + additionalProperties: false + description: Configuration for DynamoDB Destination Connection Job Options + mgmt.v1alpha1.DynamoDBDestinationTableMapping: + type: object + properties: + sourceTable: + type: string + title: source_table + description: The name of the incoming source table + destinationTable: + type: string + title: destination_table + description: The name of the outgoing destination table + title: DynamoDBDestinationTableMapping + additionalProperties: false + description: >- + Configuration for mapping a source table to a destination table for + DynamoDB + mgmt.v1alpha1.DynamoDBSourceConnectionOptions: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + description: The unique connection id to a dynamodb connection configuration + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceTableOption' + title: tables + description: |- + List of table option configurations for any mapped source table. + Any table listed in this must also be present as a job mapping table to be applied. + unmappedTransforms: + allOf: + - title: unmapped_transforms + description: Default transformations for any unmapped keys + - $ref: >- + #/components/schemas/mgmt.v1alpha1.DynamoDBSourceUnmappedTransformConfig + enableConsistentRead: + type: boolean + title: enable_consistent_read + description: |- + Enforces strong read consistency + False: Eventually Consistent Reads, True: Strongly Consistent Reads + https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html + title: DynamoDBSourceConnectionOptions + additionalProperties: false + description: DynamoDB connection options for a job source + mgmt.v1alpha1.DynamoDBSourceSchemaSubset: + type: object + properties: + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceTableOption' + title: tables + title: DynamoDBSourceSchemaSubset + additionalProperties: false + mgmt.v1alpha1.DynamoDBSourceTableOption: + type: object + allOf: + - anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + properties: + table: + type: string + title: table + minLength: 1 + description: The table that this configuration will be applied to + whereClause: + type: string + title: where_clause + description: >- + An optional PartiQL query that may be used for subsetting the + DynamoDB table. + This is not a parameterized query and must be valid. Intended to be everything after the WHERE keyword. + title: DynamoDBSourceTableOption + additionalProperties: false + mgmt.v1alpha1.DynamoDBSourceUnmappedTransformConfig: + type: object + properties: + b: + allOf: + - title: b + description: Byte + - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' + boolean: + allOf: + - title: boolean + description: Boolean + - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' + 'n': + allOf: + - title: 'n' + description: Number + - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' + s: + allOf: + - title: s + description: String + - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' + title: DynamoDBSourceUnmappedTransformConfig + additionalProperties: false + mgmt.v1alpha1.GcpCloudStorageDestinationConnectionOptions: + type: object + title: GcpCloudStorageDestinationConnectionOptions + additionalProperties: false + description: >- + Configuration for Google Cloud Storage Destination Connection Job + Options + mgmt.v1alpha1.GenerateSourceOptions: + type: object + allOf: + - anyOf: + - required: + - fkSourceConnectionId + - not: + anyOf: + - required: + - fkSourceConnectionId + anyOf: + - required: + - fkSourceConnectionId + - not: + anyOf: + - required: + - fkSourceConnectionId + properties: + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceSchemaOption' + title: schemas + minItems: 1 + fkSourceConnectionId: + type: string + title: fk_source_connection_id + format: uuid + title: GenerateSourceOptions + additionalProperties: false + mgmt.v1alpha1.GenerateSourceSchemaOption: + type: object + properties: + schema: + type: string + title: schema + minLength: 1 + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceTableOption' + title: tables + minItems: 1 + title: GenerateSourceSchemaOption + additionalProperties: false + mgmt.v1alpha1.GenerateSourceTableOption: + type: object + properties: + table: + type: string + title: table + minLength: 1 + rowCount: + oneOf: + - type: string + - type: number + title: row_count + minimum: 1 + title: GenerateSourceTableOption + additionalProperties: false + mgmt.v1alpha1.GetJobNextRunsRequest: + type: object + properties: + jobId: + type: string + title: job_id + title: GetJobNextRunsRequest + additionalProperties: false + mgmt.v1alpha1.GetJobNextRunsResponse: + type: object + properties: + nextRuns: + allOf: + - title: next_runs + - $ref: '#/components/schemas/mgmt.v1alpha1.JobNextRuns' + title: GetJobNextRunsResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRecentRunsRequest: + type: object + properties: + jobId: + type: string + title: job_id + format: uuid + title: GetJobRecentRunsRequest + additionalProperties: false + mgmt.v1alpha1.GetJobRecentRunsResponse: + type: object + properties: + recentRuns: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobRecentRun' + title: recent_runs + title: GetJobRecentRunsResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: GetJobRequest + additionalProperties: false + mgmt.v1alpha1.GetJobResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: GetJobResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRunEventsRequest: + type: object + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + title: GetJobRunEventsRequest + additionalProperties: false + mgmt.v1alpha1.GetJobRunEventsResponse: + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEvent' + title: events + isRunComplete: + type: boolean + title: is_run_complete + title: GetJobRunEventsResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRunLogsStreamRequest: + type: object + allOf: + - anyOf: + - required: + - maxLogLines + - not: + anyOf: + - required: + - maxLogLines + anyOf: + - required: + - maxLogLines + - not: + anyOf: + - required: + - maxLogLines + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + window: + allOf: + - title: window + description: The time window in which to retrieve the logs + - $ref: '#/components/schemas/mgmt.v1alpha1.LogWindow' + shouldTail: + type: boolean + title: should_tail + description: >- + Whether or not to tail the stream. Note: only works with k8s-pods + and is not currently supported with Loki logs + maxLogLines: + oneOf: + - type: string + - type: number + title: max_log_lines + minimum: 1 + description: Optionally provide a max log limit + logLevels: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.LogLevel' + title: log_levels + description: >- + Provide a list of log levels to filter by. If any of these are + UNSPECIFIED, all log levels are returned. + title: GetJobRunLogsStreamRequest + additionalProperties: false + mgmt.v1alpha1.GetJobRunLogsStreamResponse: + type: object + allOf: + - anyOf: + - required: + - timestamp + - not: + anyOf: + - required: + - timestamp + anyOf: + - required: + - timestamp + - not: + anyOf: + - required: + - timestamp + properties: + logLine: + type: string + title: log_line + timestamp: + allOf: + - title: timestamp + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: GetJobRunLogsStreamResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRunRequest: + type: object + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + title: GetJobRunRequest + additionalProperties: false + mgmt.v1alpha1.GetJobRunResponse: + type: object + properties: + jobRun: + allOf: + - title: job_run + - $ref: '#/components/schemas/mgmt.v1alpha1.JobRun' + title: GetJobRunResponse + additionalProperties: false + mgmt.v1alpha1.GetJobRunsRequest: + type: object + allOf: + - anyOf: + - required: + - accountId + - required: + - jobId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + anyOf: + - required: + - accountId + - required: + - jobId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + properties: + jobId: + type: string + title: job_id + format: uuid + accountId: + type: string + title: account_id + format: uuid + title: GetJobRunsRequest + additionalProperties: false + mgmt.v1alpha1.GetJobRunsResponse: + type: object + properties: + jobRuns: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobRun' + title: job_runs + title: GetJobRunsResponse + additionalProperties: false + mgmt.v1alpha1.GetJobStatusRequest: + type: object + properties: + jobId: + type: string + title: job_id + title: GetJobStatusRequest + additionalProperties: false + mgmt.v1alpha1.GetJobStatusResponse: + type: object + properties: + status: + allOf: + - title: status + - $ref: '#/components/schemas/mgmt.v1alpha1.JobStatus' + title: GetJobStatusResponse + additionalProperties: false + mgmt.v1alpha1.GetJobStatusesRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetJobStatusesRequest + additionalProperties: false + mgmt.v1alpha1.GetJobStatusesResponse: + type: object + properties: + statuses: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobStatusRecord' + title: statuses + title: GetJobStatusesResponse + additionalProperties: false + mgmt.v1alpha1.GetJobsRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetJobsRequest + additionalProperties: false + mgmt.v1alpha1.GetJobsResponse: + type: object + properties: + jobs: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: jobs + title: GetJobsResponse + additionalProperties: false + mgmt.v1alpha1.GetRunContextRequest: + type: object + properties: + id: + allOf: + - title: id + - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' + title: GetRunContextRequest + additionalProperties: false + mgmt.v1alpha1.GetRunContextResponse: + type: object + properties: + value: + type: string + title: value + format: byte + title: GetRunContextResponse + additionalProperties: false + mgmt.v1alpha1.IsJobNameAvailableRequest: + type: object + properties: + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + accountId: + type: string + title: account_id + format: uuid + title: IsJobNameAvailableRequest + additionalProperties: false + mgmt.v1alpha1.IsJobNameAvailableResponse: + type: object + properties: + isAvailable: + type: boolean + title: is_available + title: IsJobNameAvailableResponse + additionalProperties: false + mgmt.v1alpha1.Job: + type: object + allOf: + - anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + properties: + id: + type: string + title: id + description: The unique identifier of the job + createdByUserId: + type: string + title: created_by_user_id + createdAt: + allOf: + - title: created_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + updatedByUserId: + type: string + title: updated_by_user_id + updatedAt: + allOf: + - title: updated_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + name: + type: string + title: name + description: The unique, friendly name of the job + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' + destinations: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobDestination' + title: destinations + mappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' + title: mappings + cronSchedule: + type: string + title: cron_schedule + accountId: + type: string + title: account_id + description: The account identifier that a job is associated with + syncOptions: + allOf: + - title: sync_options + description: >- + Specify timeout and retry options for data synchronization + activities + Data sync activities are any piece of work that involves actually synchronizing data from a source to a destination + For the data sync and generate jobs, this will be applied per table + - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' + workflowOptions: + allOf: + - title: workflow_options + description: >- + Specify timeouts and other workflow options for the underlying + temporal workflow + - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' + virtualForeignKeys: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' + title: virtual_foreign_keys + title: Job + additionalProperties: false + mgmt.v1alpha1.JobDestination: + type: object + properties: + connectionId: + type: string + title: connection_id + options: + allOf: + - title: options + - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' + id: + type: string + title: id + title: JobDestination + additionalProperties: false + mgmt.v1alpha1.JobDestinationOptions: + type: object + allOf: + - anyOf: + - required: + - awsS3Options + - required: + - dynamodbOptions + - required: + - gcpCloudstorageOptions + - required: + - mongodbOptions + - required: + - mssqlOptions + - required: + - mysqlOptions + - required: + - postgresOptions + - not: + anyOf: + - required: + - awsS3Options + - required: + - dynamodbOptions + - required: + - gcpCloudstorageOptions + - required: + - mongodbOptions + - required: + - mssqlOptions + - required: + - mysqlOptions + - required: + - postgresOptions + anyOf: + - required: + - awsS3Options + - required: + - dynamodbOptions + - required: + - gcpCloudstorageOptions + - required: + - mongodbOptions + - required: + - mssqlOptions + - required: + - mysqlOptions + - required: + - postgresOptions + - not: + anyOf: + - required: + - awsS3Options + - required: + - dynamodbOptions + - required: + - gcpCloudstorageOptions + - required: + - mongodbOptions + - required: + - mssqlOptions + - required: + - mysqlOptions + - required: + - postgresOptions + properties: + postgresOptions: + allOf: + - title: postgres_options + - $ref: >- + #/components/schemas/mgmt.v1alpha1.PostgresDestinationConnectionOptions + awsS3Options: + allOf: + - title: aws_s3_options + - $ref: >- + #/components/schemas/mgmt.v1alpha1.AwsS3DestinationConnectionOptions + mysqlOptions: + allOf: + - title: mysql_options + - $ref: >- + #/components/schemas/mgmt.v1alpha1.MysqlDestinationConnectionOptions + mongodbOptions: + allOf: + - title: mongodb_options + - $ref: >- + #/components/schemas/mgmt.v1alpha1.MongoDBDestinationConnectionOptions + gcpCloudstorageOptions: + allOf: + - title: gcp_cloudstorage_options + description: Destination Connecton options for Google Cloud Storage + - $ref: >- + #/components/schemas/mgmt.v1alpha1.GcpCloudStorageDestinationConnectionOptions + dynamodbOptions: + allOf: + - title: dynamodb_options + description: Destination Connection options for DynamoDB + - $ref: >- + #/components/schemas/mgmt.v1alpha1.DynamoDBDestinationConnectionOptions + mssqlOptions: + allOf: + - title: mssql_options + description: Destination Connection options for Microsoft SQL Server + - $ref: >- + #/components/schemas/mgmt.v1alpha1.MssqlDestinationConnectionOptions + title: JobDestinationOptions + additionalProperties: false + mgmt.v1alpha1.JobMapping: + type: object + properties: + schema: + type: string + title: schema + table: + type: string + title: table + column: + type: string + title: column + transformer: + allOf: + - title: transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' + title: JobMapping + additionalProperties: false + mgmt.v1alpha1.JobMappingTransformer: + type: object + properties: + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + title: JobMappingTransformer + additionalProperties: false + mgmt.v1alpha1.JobNextRuns: + type: object + properties: + nextRunTimes: + type: array + items: + $ref: '#/components/schemas/google.protobuf.Timestamp' + title: next_run_times + title: JobNextRuns + additionalProperties: false + mgmt.v1alpha1.JobRecentRun: + type: object + properties: + startTime: + allOf: + - title: start_time + - $ref: '#/components/schemas/google.protobuf.Timestamp' + jobRunId: + type: string + title: job_run_id + title: JobRecentRun + additionalProperties: false + mgmt.v1alpha1.JobRun: + type: object + allOf: + - anyOf: + - required: + - completedAt + - not: + anyOf: + - required: + - completedAt + anyOf: + - required: + - completedAt + - not: + anyOf: + - required: + - completedAt + properties: + id: + type: string + title: id + description: >- + The id of the job run. This will currently be equivalent to the + temporal workflow id + jobId: + type: string + title: job_id + description: The unique identifier of the job id this run is associated with + name: + type: string + title: name + description: The name of the job run. + status: + allOf: + - title: status + description: the status of the job run + - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunStatus' + startedAt: + allOf: + - title: started_at + description: A timestamp of when the run started + - $ref: '#/components/schemas/google.protobuf.Timestamp' + completedAt: + allOf: + - title: completed_at + description: >- + Available if the run completed or has not yet been archived by + the system + - $ref: '#/components/schemas/google.protobuf.Timestamp' + pendingActivities: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.PendingActivity' + title: pending_activities + description: >- + Pending activities are only returned when retrieving a specific job + run and will not be returned when requesting job runs in list format + title: JobRun + additionalProperties: false + mgmt.v1alpha1.JobRunEvent: + type: object + properties: + id: + oneOf: + - type: string + - type: number + title: id + type: + type: string + title: type + startTime: + allOf: + - title: start_time + - $ref: '#/components/schemas/google.protobuf.Timestamp' + closeTime: + allOf: + - title: close_time + - $ref: '#/components/schemas/google.protobuf.Timestamp' + metadata: + allOf: + - title: metadata + - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventMetadata' + tasks: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventTask' + title: tasks + title: JobRunEvent + additionalProperties: false + mgmt.v1alpha1.JobRunEventMetadata: + type: object + allOf: + - anyOf: + - required: + - syncMetadata + - not: + anyOf: + - required: + - syncMetadata + anyOf: + - required: + - syncMetadata + - not: + anyOf: + - required: + - syncMetadata + properties: + syncMetadata: + allOf: + - title: sync_metadata + - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunSyncMetadata' + title: JobRunEventMetadata + additionalProperties: false + mgmt.v1alpha1.JobRunEventTask: + type: object + properties: + id: + oneOf: + - type: string + - type: number + title: id + type: + type: string + title: type + eventTime: + allOf: + - title: event_time + - $ref: '#/components/schemas/google.protobuf.Timestamp' + error: + allOf: + - title: error + - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventTaskError' + title: JobRunEventTask + additionalProperties: false + mgmt.v1alpha1.JobRunEventTaskError: + type: object + properties: + message: + type: string + title: message + retryState: + type: string + title: retry_state + title: JobRunEventTaskError + additionalProperties: false + mgmt.v1alpha1.JobRunSyncMetadata: + type: object + properties: + schema: + type: string + title: schema + table: + type: string + title: table + title: JobRunSyncMetadata + additionalProperties: false + mgmt.v1alpha1.JobSource: + type: object + properties: + options: + allOf: + - title: options + - $ref: '#/components/schemas/mgmt.v1alpha1.JobSourceOptions' + title: JobSource + required: + - options + - options + additionalProperties: false + mgmt.v1alpha1.JobSourceOptions: + type: object + allOf: + - anyOf: + - required: + - aiGenerate + - required: + - awsS3 + - required: + - dynamodb + - required: + - generate + - required: + - mongodb + - required: + - mssql + - required: + - mysql + - required: + - postgres + - not: + anyOf: + - required: + - aiGenerate + - required: + - awsS3 + - required: + - dynamodb + - required: + - generate + - required: + - mongodb + - required: + - mssql + - required: + - mysql + - required: + - postgres + anyOf: + - required: + - aiGenerate + - required: + - awsS3 + - required: + - dynamodb + - required: + - generate + - required: + - mongodb + - required: + - mssql + - required: + - mysql + - required: + - postgres + - not: + anyOf: + - required: + - aiGenerate + - required: + - awsS3 + - required: + - dynamodb + - required: + - generate + - required: + - mongodb + - required: + - mssql + - required: + - mysql + - required: + - postgres + properties: + postgres: + allOf: + - title: postgres + - $ref: >- + #/components/schemas/mgmt.v1alpha1.PostgresSourceConnectionOptions + awsS3: + allOf: + - title: aws_s3 + - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3SourceConnectionOptions' + mysql: + allOf: + - title: mysql + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceConnectionOptions' + generate: + allOf: + - title: generate + - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceOptions' + aiGenerate: + allOf: + - title: ai_generate + - $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceOptions' + mongodb: + allOf: + - title: mongodb + - $ref: >- + #/components/schemas/mgmt.v1alpha1.MongoDBSourceConnectionOptions + dynamodb: + allOf: + - title: dynamodb + - $ref: >- + #/components/schemas/mgmt.v1alpha1.DynamoDBSourceConnectionOptions + mssql: + allOf: + - title: mssql + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceConnectionOptions' + title: JobSourceOptions + additionalProperties: false + mgmt.v1alpha1.JobSourceSqlSubetSchemas: + type: object + allOf: + - anyOf: + - required: + - dynamodbSubset + - required: + - mssqlSubset + - required: + - mysqlSubset + - required: + - postgresSubset + - not: + anyOf: + - required: + - dynamodbSubset + - required: + - mssqlSubset + - required: + - mysqlSubset + - required: + - postgresSubset + anyOf: + - required: + - dynamodbSubset + - required: + - mssqlSubset + - required: + - mysqlSubset + - required: + - postgresSubset + - not: + anyOf: + - required: + - dynamodbSubset + - required: + - mssqlSubset + - required: + - mysqlSubset + - required: + - postgresSubset + properties: + postgresSubset: + allOf: + - title: postgres_subset + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaSubset' + mysqlSubset: + allOf: + - title: mysql_subset + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaSubset' + dynamodbSubset: + allOf: + - title: dynamodb_subset + - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceSchemaSubset' + mssqlSubset: + allOf: + - title: mssql_subset + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaSubset' + title: JobSourceSqlSubetSchemas + additionalProperties: false + mgmt.v1alpha1.JobStatusRecord: + type: object + properties: + jobId: + type: string + title: job_id + status: + allOf: + - title: status + - $ref: '#/components/schemas/mgmt.v1alpha1.JobStatus' + title: JobStatusRecord + additionalProperties: false + mgmt.v1alpha1.MongoDBDestinationConnectionOptions: + type: object + title: MongoDBDestinationConnectionOptions + additionalProperties: false + mgmt.v1alpha1.MongoDBSourceConnectionOptions: + type: object + properties: + connectionId: + type: string + title: connection_id + format: uuid + description: The unique connection id to a mongo connection configuration + title: MongoDBSourceConnectionOptions + additionalProperties: false + description: MongoDB connection options for a job source + mgmt.v1alpha1.MssqlDestinationConnectionOptions: + type: object + properties: + truncateTable: + allOf: + - title: truncate_table + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlTruncateTableConfig' + initTableSchema: + type: boolean + title: init_table_schema + description: Currently not supported and a placeholder for future implementation + onConflict: + allOf: + - title: on_conflict + description: >- + Currently not supported and a placeholder for future + implementation + - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlOnConflictConfig' + skipForeignKeyViolations: + type: boolean + title: skip_foreign_key_violations + description: >- + Insert all valid records, skipping any that violate foreign key + constraints. + title: MssqlDestinationConnectionOptions + additionalProperties: false + mgmt.v1alpha1.MssqlOnConflictConfig: + type: object + properties: + doNothing: + type: boolean + title: do_nothing + title: MssqlOnConflictConfig + additionalProperties: false + mgmt.v1alpha1.MssqlSourceConnectionOptions: + type: object + properties: + haltOnNewColumnAddition: + type: boolean + title: halt_on_new_column_addition + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaOption' + title: schemas + connectionId: + type: string + title: connection_id + format: uuid + subsetByForeignKeyConstraints: + type: boolean + title: subset_by_foreign_key_constraints + title: MssqlSourceConnectionOptions + additionalProperties: false + mgmt.v1alpha1.MssqlSourceSchemaOption: + type: object + properties: + schema: + type: string + title: schema + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceTableOption' + title: tables + title: MssqlSourceSchemaOption + additionalProperties: false + mgmt.v1alpha1.MssqlSourceSchemaSubset: + type: object + properties: + mssqlSchemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaOption' + title: mssql_schemas + title: MssqlSourceSchemaSubset + additionalProperties: false + mgmt.v1alpha1.MssqlSourceTableOption: + type: object + allOf: + - anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + properties: + table: + type: string + title: table + whereClause: + type: string + title: where_clause + title: MssqlSourceTableOption + additionalProperties: false + mgmt.v1alpha1.MssqlTruncateTableConfig: + type: object + properties: + truncateBeforeInsert: + type: boolean + title: truncate_before_insert + title: MssqlTruncateTableConfig + additionalProperties: false + mgmt.v1alpha1.MysqlDestinationConnectionOptions: + type: object + properties: + truncateTable: + allOf: + - title: truncate_table + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlTruncateTableConfig' + initTableSchema: + type: boolean + title: init_table_schema + onConflict: + allOf: + - title: on_conflict + - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlOnConflictConfig' + skipForeignKeyViolations: + type: boolean + title: skip_foreign_key_violations + description: >- + Insert all valid records, skipping any that violate foreign key + constraints. + title: MysqlDestinationConnectionOptions + additionalProperties: false + mgmt.v1alpha1.MysqlOnConflictConfig: + type: object + properties: + doNothing: + type: boolean + title: do_nothing + title: MysqlOnConflictConfig + additionalProperties: false + mgmt.v1alpha1.MysqlSourceConnectionOptions: + type: object + properties: + haltOnNewColumnAddition: + type: boolean + title: halt_on_new_column_addition + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaOption' + title: schemas + connectionId: + type: string + title: connection_id + format: uuid + subsetByForeignKeyConstraints: + type: boolean + title: subset_by_foreign_key_constraints + title: MysqlSourceConnectionOptions + additionalProperties: false + mgmt.v1alpha1.MysqlSourceSchemaOption: + type: object + properties: + schema: + type: string + title: schema + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceTableOption' + title: tables + title: MysqlSourceSchemaOption + additionalProperties: false + mgmt.v1alpha1.MysqlSourceSchemaSubset: + type: object + properties: + mysqlSchemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaOption' + title: mysql_schemas + title: MysqlSourceSchemaSubset + additionalProperties: false + mgmt.v1alpha1.MysqlSourceTableOption: + type: object + allOf: + - anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + properties: + table: + type: string + title: table + whereClause: + type: string + title: where_clause + title: MysqlSourceTableOption + additionalProperties: false + mgmt.v1alpha1.MysqlTruncateTableConfig: + type: object + properties: + truncateBeforeInsert: + type: boolean + title: truncate_before_insert + title: MysqlTruncateTableConfig + additionalProperties: false + mgmt.v1alpha1.PauseJobRequest: + type: object + allOf: + - anyOf: + - required: + - note + - not: + anyOf: + - required: + - note + anyOf: + - required: + - note + - not: + anyOf: + - required: + - note + properties: + id: + type: string + title: id + format: uuid + pause: + type: boolean + title: pause + note: + type: string + title: note + title: PauseJobRequest + additionalProperties: false + mgmt.v1alpha1.PauseJobResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: PauseJobResponse + additionalProperties: false + mgmt.v1alpha1.PendingActivity: + type: object + allOf: + - anyOf: + - required: + - lastFailure + - not: + anyOf: + - required: + - lastFailure + anyOf: + - required: + - lastFailure + - not: + anyOf: + - required: + - lastFailure + properties: + status: + allOf: + - title: status + - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityStatus' + activityName: + type: string + title: activity_name + lastFailure: + allOf: + - title: last_failure + - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityFailure' + title: PendingActivity + additionalProperties: false + mgmt.v1alpha1.PostgresDestinationConnectionOptions: + type: object + properties: + truncateTable: + allOf: + - title: truncate_table + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresTruncateTableConfig' + initTableSchema: + type: boolean + title: init_table_schema + onConflict: + allOf: + - title: on_conflict + - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresOnConflictConfig' + skipForeignKeyViolations: + type: boolean + title: skip_foreign_key_violations + description: >- + Insert all valid records, skipping any that violate foreign key + constraints. + title: PostgresDestinationConnectionOptions + additionalProperties: false + mgmt.v1alpha1.PostgresOnConflictConfig: + type: object + properties: + doNothing: + type: boolean + title: do_nothing + title: PostgresOnConflictConfig + additionalProperties: false + mgmt.v1alpha1.PostgresSourceConnectionOptions: + type: object + properties: + haltOnNewColumnAddition: + type: boolean + title: halt_on_new_column_addition + schemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaOption' + title: schemas + connectionId: + type: string + title: connection_id + format: uuid + subsetByForeignKeyConstraints: + type: boolean + title: subset_by_foreign_key_constraints + title: PostgresSourceConnectionOptions + additionalProperties: false + mgmt.v1alpha1.PostgresSourceSchemaOption: + type: object + properties: + schema: + type: string + title: schema + tables: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceTableOption' + title: tables + title: PostgresSourceSchemaOption + additionalProperties: false + mgmt.v1alpha1.PostgresSourceSchemaSubset: + type: object + properties: + postgresSchemas: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaOption' + title: postgres_schemas + title: PostgresSourceSchemaSubset + additionalProperties: false + mgmt.v1alpha1.PostgresSourceTableOption: + type: object + allOf: + - anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + anyOf: + - required: + - whereClause + - not: + anyOf: + - required: + - whereClause + properties: + table: + type: string + title: table + whereClause: + type: string + title: where_clause + title: PostgresSourceTableOption + additionalProperties: false + mgmt.v1alpha1.PostgresTruncateTableConfig: + type: object + properties: + truncateBeforeInsert: + type: boolean + title: truncate_before_insert + cascade: + type: boolean + title: cascade + title: PostgresTruncateTableConfig + additionalProperties: false + mgmt.v1alpha1.RetryPolicy: + type: object + allOf: + - anyOf: + - required: + - maximumAttempts + - not: + anyOf: + - required: + - maximumAttempts + anyOf: + - required: + - maximumAttempts + - not: + anyOf: + - required: + - maximumAttempts + properties: + maximumAttempts: + type: integer + title: maximum_attempts + description: >- + Maximum number of attempts. When exceeded the retries stop even if + not expired yet. + If not set or set to 0, it means unlimited, and rely on activity ScheduleToCloseTimeout to stop. + title: RetryPolicy + additionalProperties: false + description: Defines the retry policy for an activity + mgmt.v1alpha1.RunContextKey: + type: object + properties: + jobRunId: + type: string + title: job_run_id + minLength: 1 + description: The Neosync Run ID + externalId: + type: string + title: external_id + minLength: 1 + description: An opaque identifier that will be used to store specific items + accountId: + type: string + title: account_id + minLength: 1 + description: The Neosync Account ID + title: RunContextKey + additionalProperties: false + mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + description: The unique identifier of the job to update subsets for + schemas: + allOf: + - title: schemas + description: The subset configuration + - $ref: '#/components/schemas/mgmt.v1alpha1.JobSourceSqlSubetSchemas' + subsetByForeignKeyConstraints: + type: boolean + title: subset_by_foreign_key_constraints + description: >- + Whether or not to have subsets follow foreign key constraints (for + connections that support it) + title: SetJobSourceSqlConnectionSubsetsRequest + additionalProperties: false + mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: SetJobSourceSqlConnectionSubsetsResponse + additionalProperties: false + mgmt.v1alpha1.SetJobSyncOptionsRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + description: The unique identifier of the job + syncOptions: + allOf: + - title: sync_options + description: >- + The sync options object. The entire object must be provided and + will fully overwrite the previous result + - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' + title: SetJobSyncOptionsRequest + additionalProperties: false + mgmt.v1alpha1.SetJobSyncOptionsResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: SetJobSyncOptionsResponse + additionalProperties: false + mgmt.v1alpha1.SetJobWorkflowOptionsRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + description: The unique identifier of the job + worfklowOptions: + allOf: + - title: worfklow_options + description: >- + The workflow options object. The entire object must be provided + and will fully overwrite the previous result + - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' + title: SetJobWorkflowOptionsRequest + additionalProperties: false + mgmt.v1alpha1.SetJobWorkflowOptionsResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: SetJobWorkflowOptionsResponse + additionalProperties: false + mgmt.v1alpha1.SetRunContextRequest: + type: object + properties: + id: + allOf: + - title: id + - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' + value: + type: string + title: value + format: byte + description: An opaque value that is to be determined by the key + title: SetRunContextRequest + additionalProperties: false + mgmt.v1alpha1.SetRunContextResponse: + type: object + title: SetRunContextResponse + additionalProperties: false + mgmt.v1alpha1.SetRunContextsRequest: + type: object + properties: + id: + allOf: + - title: id + - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' + value: + type: string + title: value + format: byte + description: An opaque value that is to be determined by the key + title: SetRunContextsRequest + additionalProperties: false + mgmt.v1alpha1.SetRunContextsResponse: + type: object + title: SetRunContextsResponse + additionalProperties: false + mgmt.v1alpha1.TerminateJobRunRequest: + type: object + properties: + jobRunId: + type: string + title: job_run_id + accountId: + type: string + title: account_id + format: uuid + title: TerminateJobRunRequest + additionalProperties: false + mgmt.v1alpha1.TerminateJobRunResponse: + type: object + title: TerminateJobRunResponse + additionalProperties: false + mgmt.v1alpha1.UpdateJobDestinationConnectionRequest: + type: object + properties: + jobId: + type: string + title: job_id + format: uuid + connectionId: + type: string + title: connection_id + format: uuid + options: + allOf: + - title: options + - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' + destinationId: + type: string + title: destination_id + title: UpdateJobDestinationConnectionRequest + additionalProperties: false + mgmt.v1alpha1.UpdateJobDestinationConnectionResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: UpdateJobDestinationConnectionResponse + additionalProperties: false + mgmt.v1alpha1.UpdateJobScheduleRequest: + type: object + allOf: + - anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + anyOf: + - required: + - cronSchedule + - not: + anyOf: + - required: + - cronSchedule + properties: + id: + type: string + title: id + format: uuid + cronSchedule: + type: string + title: cron_schedule + title: UpdateJobScheduleRequest + additionalProperties: false + mgmt.v1alpha1.UpdateJobScheduleResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: UpdateJobScheduleResponse + additionalProperties: false + mgmt.v1alpha1.UpdateJobSourceConnectionRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' + mappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' + title: mappings + virtualForeignKeys: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' + title: virtual_foreign_keys + title: UpdateJobSourceConnectionRequest + additionalProperties: false + mgmt.v1alpha1.UpdateJobSourceConnectionResponse: + type: object + properties: + job: + allOf: + - title: job + - $ref: '#/components/schemas/mgmt.v1alpha1.Job' + title: UpdateJobSourceConnectionResponse + additionalProperties: false + mgmt.v1alpha1.ValidateJobMappingsRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + description: The unique account identifier that this job will be associated with + mappings: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' + title: mappings + connectionId: + type: string + title: connection_id + virtualForeignKeys: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' + title: virtual_foreign_keys + title: ValidateJobMappingsRequest + additionalProperties: false + mgmt.v1alpha1.ValidateJobMappingsResponse: + type: object + properties: + columnErrors: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.ColumnError' + title: column_errors + databaseErrors: + allOf: + - title: database_errors + - $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseError' + title: ValidateJobMappingsResponse + additionalProperties: false + mgmt.v1alpha1.VirtualForeignConstraint: + type: object + properties: + schema: + type: string + title: schema + table: + type: string + title: table + columns: + type: array + items: + type: string + title: columns + foreignKey: + allOf: + - title: foreign_key + - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignKey' + title: VirtualForeignConstraint + additionalProperties: false + mgmt.v1alpha1.VirtualForeignKey: + type: object + properties: + schema: + type: string + title: schema + table: + type: string + title: table + columns: + type: array + items: + type: string + title: columns + title: VirtualForeignKey + additionalProperties: false + mgmt.v1alpha1.WorkflowOptions: + type: object + allOf: + - anyOf: + - required: + - runTimeout + - not: + anyOf: + - required: + - runTimeout + anyOf: + - required: + - runTimeout + - not: + anyOf: + - required: + - runTimeout + properties: + runTimeout: + oneOf: + - type: string + - type: number + title: run_timeout + description: |- + The timeout for a single workflow run. + Measured in seconds + title: WorkflowOptions + additionalProperties: false + description: >- + Config that contains various timeouts that are configured in the + underlying temporal workflow + More options will come in the future as needed + mgmt.v1alpha1.RangedMetricName: + type: string + title: RangedMetricName + enum: + - RANGED_METRIC_NAME_UNSPECIFIED + - RANGED_METRIC_NAME_INPUT_RECEIVED + mgmt.v1alpha1.Date: + type: object + properties: + year: + type: integer + title: year + maximum: 9999 + description: >- + Year of the date. Must be from 1 to 9999, or 0 to specify a date + without + a year. + month: + type: integer + title: month + maximum: 31 + description: >- + Month of a year. Must be from 1 to 12, or 0 to specify a year + without a + month and day. + day: + type: integer + title: day + maximum: 31 + description: >- + Day of a month. Must be from 1 to 31 and valid for the year and + month, or 0 + to specify a year by itself or a year and month where the day isn't + significant. + title: Date + additionalProperties: false + description: >- + Represents a whole or partial calendar date, such as a birthday. The + time of + day and time zone are either specified elsewhere or are insignificant. The + date is relative to the Gregorian Calendar. This can represent one of the + following: + + * A full date, with non-zero year, month, and day values + * A month and day value, with a zero year, such as an anniversary + * A year on its own, with zero month and day values + * A year and month value, with a zero day, such as a credit card expiration + date + + Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and + `google.protobuf.Timestamp`. + mgmt.v1alpha1.DayResult: + type: object + properties: + date: + allOf: + - title: date + - $ref: '#/components/schemas/mgmt.v1alpha1.Date' + count: + oneOf: + - type: string + - type: number + title: count + title: DayResult + additionalProperties: false + mgmt.v1alpha1.GetDailyMetricCountRequest: + type: object + allOf: + - anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + properties: + start: + allOf: + - title: start + description: The start day + - $ref: '#/components/schemas/mgmt.v1alpha1.Date' + end: + allOf: + - title: end + description: The end day + - $ref: '#/components/schemas/mgmt.v1alpha1.Date' + metric: + allOf: + - title: metric + description: The metric to return + - $ref: '#/components/schemas/mgmt.v1alpha1.RangedMetricName' + accountId: + type: string + title: account_id + format: uuid + description: The account identifier that will be used to filter by + jobId: + type: string + title: job_id + format: uuid + description: The job identifier that will be used to filter by + runId: + type: string + title: run_id + format: uuid + description: The run identifier that will be used to filter by + title: GetDailyMetricCountRequest + additionalProperties: false + mgmt.v1alpha1.GetDailyMetricCountResponse: + type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.DayResult' + title: results + title: GetDailyMetricCountResponse + additionalProperties: false + mgmt.v1alpha1.GetMetricCountRequest: + type: object + allOf: + - anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + - not: + anyOf: + - required: + - accountId + - required: + - jobId + - required: + - runId + properties: + start: + allOf: + - title: start + description: '@deprecated - use start_day' + - $ref: '#/components/schemas/google.protobuf.Timestamp' + end: + allOf: + - title: end + description: '@deprecated - use end_day' + - $ref: '#/components/schemas/google.protobuf.Timestamp' + metric: + allOf: + - title: metric + description: The metric to return + - $ref: '#/components/schemas/mgmt.v1alpha1.RangedMetricName' + accountId: + type: string + title: account_id + format: uuid + description: The account identifier that will be used to filter by + jobId: + type: string + title: job_id + format: uuid + description: The job identifier that will be used to filter by + runId: + type: string + title: run_id + format: uuid + description: The run identifier that will be used to filter by + startDay: + allOf: + - title: start_day + - $ref: '#/components/schemas/mgmt.v1alpha1.Date' + endDay: + allOf: + - title: end_day + - $ref: '#/components/schemas/mgmt.v1alpha1.Date' + title: GetMetricCountRequest + additionalProperties: false + mgmt.v1alpha1.GetMetricCountResponse: + type: object + properties: + count: + oneOf: + - type: string + - type: number + title: count + description: >- + The summed up count of the metric based on the input query and + timerange specified + title: GetMetricCountResponse + additionalProperties: false + mgmt.v1alpha1.SupportedJobType: + type: string + title: SupportedJobType + enum: + - SUPPORTED_JOB_TYPE_UNSPECIFIED + - SUPPORTED_JOB_TYPE_SYNC + - SUPPORTED_JOB_TYPE_GENERATE + mgmt.v1alpha1.TransformerDataType: + type: string + title: TransformerDataType + enum: + - TRANSFORMER_DATA_TYPE_UNSPECIFIED + - TRANSFORMER_DATA_TYPE_STRING + - TRANSFORMER_DATA_TYPE_INT64 + - TRANSFORMER_DATA_TYPE_BOOLEAN + - TRANSFORMER_DATA_TYPE_FLOAT64 + - TRANSFORMER_DATA_TYPE_NULL + - TRANSFORMER_DATA_TYPE_ANY + - TRANSFORMER_DATA_TYPE_TIME + - TRANSFORMER_DATA_TYPE_UUID + mgmt.v1alpha1.CreateUserDefinedTransformerRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + description: + type: string + title: description + type: + type: string + title: type + description: '@deprecated' + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' + transformerConfig: + allOf: + - title: transformer_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + title: CreateUserDefinedTransformerRequest + additionalProperties: false + mgmt.v1alpha1.CreateUserDefinedTransformerResponse: + type: object + properties: + transformer: + allOf: + - title: transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' + title: CreateUserDefinedTransformerResponse + additionalProperties: false + mgmt.v1alpha1.DeleteUserDefinedTransformerRequest: + type: object + properties: + transformerId: + type: string + title: transformer_id + format: uuid + title: DeleteUserDefinedTransformerRequest + additionalProperties: false + mgmt.v1alpha1.DeleteUserDefinedTransformerResponse: + type: object + title: DeleteUserDefinedTransformerResponse + additionalProperties: false + mgmt.v1alpha1.GetSystemTransformerBySourceRequest: + type: object + properties: + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' + title: GetSystemTransformerBySourceRequest + additionalProperties: false + mgmt.v1alpha1.GetSystemTransformerBySourceResponse: + type: object + properties: + transformer: + allOf: + - title: transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.SystemTransformer' + title: GetSystemTransformerBySourceResponse + additionalProperties: false + mgmt.v1alpha1.GetSystemTransformersRequest: + type: object + title: GetSystemTransformersRequest + additionalProperties: false + mgmt.v1alpha1.GetSystemTransformersResponse: + type: object + properties: + transformers: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.SystemTransformer' + title: transformers + title: GetSystemTransformersResponse + additionalProperties: false + mgmt.v1alpha1.GetUserDefinedTransformerByIdRequest: + type: object + properties: + transformerId: + type: string + title: transformer_id + format: uuid + title: GetUserDefinedTransformerByIdRequest + additionalProperties: false + mgmt.v1alpha1.GetUserDefinedTransformerByIdResponse: + type: object + properties: + transformer: + allOf: + - title: transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' + title: GetUserDefinedTransformerByIdResponse + additionalProperties: false + mgmt.v1alpha1.GetUserDefinedTransformersRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetUserDefinedTransformersRequest + additionalProperties: false + mgmt.v1alpha1.GetUserDefinedTransformersResponse: + type: object + properties: + transformers: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' + title: transformers + title: GetUserDefinedTransformersResponse + additionalProperties: false + mgmt.v1alpha1.IsTransformerNameAvailableRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + transformerName: + type: string + title: transformer_name + pattern: ^[a-z0-9-]{3,100}$ + title: IsTransformerNameAvailableRequest + additionalProperties: false + mgmt.v1alpha1.IsTransformerNameAvailableResponse: + type: object + properties: + isAvailable: + type: boolean + title: is_available + title: IsTransformerNameAvailableResponse + additionalProperties: false + mgmt.v1alpha1.SystemTransformer: + type: object + properties: + name: + type: string + title: name + description: + type: string + title: description + dataType: + allOf: + - title: data_type + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + dataTypes: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' + title: data_types + supportedJobTypes: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.SupportedJobType' + title: supported_job_types + title: SystemTransformer + additionalProperties: false + mgmt.v1alpha1.UpdateUserDefinedTransformerRequest: + type: object + properties: + transformerId: + type: string + title: transformer_id + format: uuid + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + description: + type: string + title: description + transformerConfig: + allOf: + - title: transformer_config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + title: UpdateUserDefinedTransformerRequest + additionalProperties: false + mgmt.v1alpha1.UpdateUserDefinedTransformerResponse: + type: object + properties: + transformer: + allOf: + - title: transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' + title: UpdateUserDefinedTransformerResponse + additionalProperties: false + mgmt.v1alpha1.UserDefinedTransformer: + type: object + properties: + id: + type: string + title: id + format: uuid + name: + type: string + title: name + description: + type: string + title: description + dataType: + allOf: + - title: data_type + description: >- + This property is readonly and is calculated based off the origin + system transformer + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' + source: + allOf: + - title: source + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' + createdAt: + allOf: + - title: created_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + updatedAt: + allOf: + - title: updated_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + accountId: + type: string + title: account_id + dataTypes: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' + title: data_types + title: UserDefinedTransformer + additionalProperties: false + mgmt.v1alpha1.ValidateUserJavascriptCodeRequest: + type: object + properties: + accountId: + type: string + title: account_id + description: "@deprecated - an account isn't required to validate js code" + code: + type: string + title: code + minLength: 1 + title: ValidateUserJavascriptCodeRequest + additionalProperties: false + mgmt.v1alpha1.ValidateUserJavascriptCodeResponse: + type: object + properties: + valid: + type: boolean + title: valid + title: ValidateUserJavascriptCodeResponse + additionalProperties: false + mgmt.v1alpha1.ValidateUserRegexCodeRequest: + type: object + properties: + accountId: + type: string + title: account_id + description: "@deprecated - an account isn't required to validate js code" + userProvidedRegex: + type: string + title: user_provided_regex + title: ValidateUserRegexCodeRequest + additionalProperties: false + mgmt.v1alpha1.ValidateUserRegexCodeResponse: + type: object + properties: + valid: + type: boolean + title: valid + title: ValidateUserRegexCodeResponse + additionalProperties: false + mgmt.v1alpha1.AccountStatus: + type: string + title: AccountStatus + enum: + - ACCOUNT_STATUS_REASON_UNSPECIFIED + - ACCOUNT_STATUS_EXCEEDS_ALLOWED_LIMIT + - ACCOUNT_STATUS_REQUESTED_EXCEEDS_LIMIT + - ACCOUNT_STATUS_ACCOUNT_IN_EXPIRED_STATE + mgmt.v1alpha1.BillingStatus: + type: string + title: BillingStatus + enum: + - BILLING_STATUS_UNSPECIFIED + - BILLING_STATUS_ACTIVE + - BILLING_STATUS_EXPIRED + mgmt.v1alpha1.UserAccountType: + type: string + title: UserAccountType + enum: + - USER_ACCOUNT_TYPE_UNSPECIFIED + - USER_ACCOUNT_TYPE_PERSONAL + - USER_ACCOUNT_TYPE_TEAM + - USER_ACCOUNT_TYPE_ENTERPRISE + mgmt.v1alpha1.AcceptTeamAccountInviteRequest: + type: object + properties: + token: + type: string + title: token + minLength: 1 + title: AcceptTeamAccountInviteRequest + additionalProperties: false + mgmt.v1alpha1.AcceptTeamAccountInviteResponse: + type: object + properties: + account: + allOf: + - title: account + - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' + title: AcceptTeamAccountInviteResponse + additionalProperties: false + mgmt.v1alpha1.AccountInvite: + type: object + properties: + id: + type: string + title: id + accountId: + type: string + title: account_id + senderUserId: + type: string + title: sender_user_id + email: + type: string + title: email + token: + type: string + title: token + accepted: + type: boolean + title: accepted + createdAt: + allOf: + - title: created_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + updatedAt: + allOf: + - title: updated_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + expiresAt: + allOf: + - title: expires_at + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: AccountInvite + additionalProperties: false + mgmt.v1alpha1.AccountOnboardingConfig: + type: object + properties: + hasCreatedSourceConnection: + type: boolean + title: has_created_source_connection + description: '@deprecated - use has_completed_onboarding' + hasCreatedDestinationConnection: + type: boolean + title: has_created_destination_connection + description: '@deprecated - use has_completed_onboarding' + hasCreatedJob: + type: boolean + title: has_created_job + description: '@deprecated - use has_completed_onboarding' + hasInvitedMembers: + type: boolean + title: has_invited_members + description: '@deprecated - use has_completed_onboarding' + hasCompletedOnboarding: + type: boolean + title: has_completed_onboarding + title: AccountOnboardingConfig + additionalProperties: false + mgmt.v1alpha1.AccountTemporalConfig: + type: object + properties: + url: + type: string + title: url + minLength: 1 + namespace: + type: string + title: namespace + minLength: 1 + syncJobQueueName: + type: string + title: sync_job_queue_name + minLength: 1 + title: AccountTemporalConfig + additionalProperties: false + mgmt.v1alpha1.AccountUser: + type: object + properties: + id: + type: string + title: id + name: + type: string + title: name + image: + type: string + title: image + email: + type: string + title: email + title: AccountUser + additionalProperties: false + mgmt.v1alpha1.ConvertPersonalToTeamAccountRequest: + type: object + allOf: + - anyOf: + - required: + - accountId + - not: + anyOf: + - required: + - accountId + anyOf: + - required: + - accountId + - not: + anyOf: + - required: + - accountId + properties: + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + description: The name of the team account + accountId: + type: string + title: account_id + format: uuid + description: >- + Optionally provide the personal account to convert. This may be used + in break-glass scenarios where there are multiple personal accounts + And we want to convert one of them. If not provided, it will find the first one and convert it, leaving the other. + title: ConvertPersonalToTeamAccountRequest + additionalProperties: false + mgmt.v1alpha1.ConvertPersonalToTeamAccountResponse: + type: object + allOf: + - anyOf: + - required: + - checkoutSessionUrl + - not: + anyOf: + - required: + - checkoutSessionUrl + anyOf: + - required: + - checkoutSessionUrl + - not: + anyOf: + - required: + - checkoutSessionUrl + properties: + accountId: + type: string + title: account_id + description: >- + The id of the team account (will be the same identifier as the + personal account) + checkoutSessionUrl: + type: string + title: checkout_session_url + description: >- + If NeosyncCloud, will respond with a checkout session url so they + can setup billing + newPersonalAccountId: + type: string + title: new_personal_account_id + description: The identifier of the newly created personal account + title: ConvertPersonalToTeamAccountResponse + additionalProperties: false + mgmt.v1alpha1.CreateTeamAccountRequest: + type: object + properties: + name: + type: string + title: name + pattern: ^[a-z0-9-]{3,100}$ + description: The name of the team account + title: CreateTeamAccountRequest + additionalProperties: false + mgmt.v1alpha1.CreateTeamAccountResponse: + type: object + allOf: + - anyOf: + - required: + - checkoutSessionUrl + - not: + anyOf: + - required: + - checkoutSessionUrl + anyOf: + - required: + - checkoutSessionUrl + - not: + anyOf: + - required: + - checkoutSessionUrl + properties: + accountId: + type: string + title: account_id + checkoutSessionUrl: + type: string + title: checkout_session_url + description: >- + If NeosyncCloud, will respond with a checkout session url so they + can setup billing + title: CreateTeamAccountResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountBillingCheckoutSessionRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountBillingCheckoutSessionRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountBillingCheckoutSessionResponse: + type: object + properties: + checkoutSessionUrl: + type: string + title: checkout_session_url + description: The url that will be redirected to + title: GetAccountBillingCheckoutSessionResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountBillingPortalSessionRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountBillingPortalSessionRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountBillingPortalSessionResponse: + type: object + properties: + portalSessionUrl: + type: string + title: portal_session_url + description: The url that will be redirected to + title: GetAccountBillingPortalSessionResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountOnboardingConfigRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountOnboardingConfigRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountOnboardingConfigResponse: + type: object + properties: + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' + title: GetAccountOnboardingConfigResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountStatusRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountStatusRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountStatusResponse: + type: object + allOf: + - anyOf: + - required: + - allowedRecordCount + - not: + anyOf: + - required: + - allowedRecordCount + anyOf: + - required: + - allowedRecordCount + - not: + anyOf: + - required: + - allowedRecordCount + properties: + usedRecordCount: + oneOf: + - type: string + - type: number + title: used_record_count + description: >- + A count of the currently used records for the current billing + period. + This may go over the allowed record count depending on when the record count is polled by the metric system. + allowedRecordCount: + oneOf: + - type: string + - type: number + title: allowed_record_count + description: The allowed record count. It will be null if there is no limit. + subscriptionStatus: + allOf: + - title: subscription_status + description: >- + The current subscription status determined by the billing + system. + - $ref: '#/components/schemas/mgmt.v1alpha1.BillingStatus' + title: GetAccountStatusResponse + additionalProperties: false + mgmt.v1alpha1.GetAccountTemporalConfigRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetAccountTemporalConfigRequest + additionalProperties: false + mgmt.v1alpha1.GetAccountTemporalConfigResponse: + type: object + properties: + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' + title: GetAccountTemporalConfigResponse + additionalProperties: false + mgmt.v1alpha1.GetBillingAccountsRequest: + type: object + properties: + accountIds: + type: array + items: + type: string + title: account_ids + description: Optional list of account identifiers to filter the response by + title: GetBillingAccountsRequest + additionalProperties: false + mgmt.v1alpha1.GetBillingAccountsResponse: + type: object + properties: + accounts: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' + title: accounts + title: GetBillingAccountsResponse + additionalProperties: false + mgmt.v1alpha1.GetSystemInformationRequest: + type: object + title: GetSystemInformationRequest + additionalProperties: false + mgmt.v1alpha1.GetSystemInformationResponse: + type: object + properties: + version: + type: string + title: version + description: The Git tagged version + commit: + type: string + title: commit + description: The Git commit + compiler: + type: string + title: compiler + description: The Go compiler flag that was used to build this version of Neosync + platform: + type: string + title: platform + description: The Go platform flag that was used to build this version of Neosync + buildDate: + allOf: + - title: build_date + - $ref: '#/components/schemas/google.protobuf.Timestamp' + title: GetSystemInformationResponse + additionalProperties: false + mgmt.v1alpha1.GetTeamAccountInvitesRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetTeamAccountInvitesRequest + additionalProperties: false + mgmt.v1alpha1.GetTeamAccountInvitesResponse: + type: object + properties: + invites: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AccountInvite' + title: invites + title: GetTeamAccountInvitesResponse + additionalProperties: false + mgmt.v1alpha1.GetTeamAccountMembersRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: GetTeamAccountMembersRequest + additionalProperties: false + mgmt.v1alpha1.GetTeamAccountMembersResponse: + type: object + properties: + users: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.AccountUser' + title: users + title: GetTeamAccountMembersResponse + additionalProperties: false + mgmt.v1alpha1.GetUserAccountsRequest: + type: object + title: GetUserAccountsRequest + additionalProperties: false + mgmt.v1alpha1.GetUserAccountsResponse: + type: object + properties: + accounts: + type: array + items: + $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' + title: accounts + title: GetUserAccountsResponse + additionalProperties: false + mgmt.v1alpha1.GetUserRequest: + type: object + title: GetUserRequest + additionalProperties: false + mgmt.v1alpha1.GetUserResponse: + type: object + properties: + userId: + type: string + title: user_id + title: GetUserResponse + additionalProperties: false + mgmt.v1alpha1.InviteUserToTeamAccountRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + email: + type: string + title: email + minLength: 1 + title: InviteUserToTeamAccountRequest + additionalProperties: false + mgmt.v1alpha1.InviteUserToTeamAccountResponse: + type: object + properties: + invite: + allOf: + - title: invite + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountInvite' + title: InviteUserToTeamAccountResponse + additionalProperties: false + mgmt.v1alpha1.IsAccountStatusValidRequest: + type: object + allOf: + - anyOf: + - required: + - requestedRecordCount + - not: + anyOf: + - required: + - requestedRecordCount + anyOf: + - required: + - requestedRecordCount + - not: + anyOf: + - required: + - requestedRecordCount + properties: + accountId: + type: string + title: account_id + format: uuid + requestedRecordCount: + oneOf: + - type: string + - type: number + title: requested_record_count + description: >- + An optional count of records to be added to the current usage for + validation. + title: IsAccountStatusValidRequest + additionalProperties: false + mgmt.v1alpha1.IsAccountStatusValidResponse: + type: object + allOf: + - anyOf: + - required: + - allowedRecordCount + - not: + anyOf: + - required: + - allowedRecordCount + - anyOf: + - required: + - reason + - not: + anyOf: + - required: + - reason + properties: + isValid: + type: boolean + title: is_valid + reason: + type: string + title: reason + description: If the account is not valid, a reason for why may be provided. + shouldPoll: + type: boolean + title: should_poll + description: >- + Whether or not the process should decide to continue polling for + validitiy updates + usedRecordCount: + oneOf: + - type: string + - type: number + title: used_record_count + description: >- + A count of the currently used records for the current billing + period. + This may go over the allowed record count depending on when the record count is polled by the metric system. + allowedRecordCount: + oneOf: + - type: string + - type: number + title: allowed_record_count + description: The allowed record count. It will be null if there is no limit. + accountStatus: + allOf: + - title: account_status + description: The current status of the account. Default is valid. + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountStatus' + title: IsAccountStatusValidResponse + additionalProperties: false + mgmt.v1alpha1.IsUserInAccountRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + title: IsUserInAccountRequest + additionalProperties: false + mgmt.v1alpha1.IsUserInAccountResponse: + type: object + properties: + ok: + type: boolean + title: ok + title: IsUserInAccountResponse + additionalProperties: false + mgmt.v1alpha1.RemoveTeamAccountInviteRequest: + type: object + properties: + id: + type: string + title: id + format: uuid + title: RemoveTeamAccountInviteRequest + additionalProperties: false + mgmt.v1alpha1.RemoveTeamAccountInviteResponse: + type: object + title: RemoveTeamAccountInviteResponse + additionalProperties: false + mgmt.v1alpha1.RemoveTeamAccountMemberRequest: + type: object + properties: + userId: + type: string + title: user_id + format: uuid + accountId: + type: string + title: account_id + format: uuid + title: RemoveTeamAccountMemberRequest + additionalProperties: false + mgmt.v1alpha1.RemoveTeamAccountMemberResponse: + type: object + title: RemoveTeamAccountMemberResponse + additionalProperties: false + mgmt.v1alpha1.SetAccountOnboardingConfigRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' + title: SetAccountOnboardingConfigRequest + additionalProperties: false + mgmt.v1alpha1.SetAccountOnboardingConfigResponse: + type: object + properties: + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' + title: SetAccountOnboardingConfigResponse + additionalProperties: false + mgmt.v1alpha1.SetAccountTemporalConfigRequest: + type: object + properties: + accountId: + type: string + title: account_id + format: uuid + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' + title: SetAccountTemporalConfigRequest + additionalProperties: false + mgmt.v1alpha1.SetAccountTemporalConfigResponse: + type: object + properties: + config: + allOf: + - title: config + - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' + title: SetAccountTemporalConfigResponse + additionalProperties: false + mgmt.v1alpha1.SetBillingMeterEventRequest: + type: object + allOf: + - anyOf: + - required: + - timestamp + - not: + anyOf: + - required: + - timestamp + anyOf: + - required: + - timestamp + - not: + anyOf: + - required: + - timestamp + properties: + accountId: + type: string + title: account_id + format: uuid + description: The account id to apply this metered event to + eventName: + type: string + title: event_name + minLength: 1 + description: The metered event name + value: + type: string + title: value + minLength: 1 + description: The value of the meter for the given time + eventId: + type: string + title: event_id + minLength: 1 + description: The unique identifier of this metered event + timestamp: + oneOf: + - type: string + - type: number + title: timestamp + description: >- + The time of the event in Unix Epoch format. Defaults to the current + timestamp if not specified. + title: SetBillingMeterEventRequest + additionalProperties: false + mgmt.v1alpha1.SetBillingMeterEventResponse: + type: object + title: SetBillingMeterEventResponse + additionalProperties: false + mgmt.v1alpha1.SetPersonalAccountRequest: + type: object + title: SetPersonalAccountRequest + additionalProperties: false + mgmt.v1alpha1.SetPersonalAccountResponse: + type: object + properties: + accountId: + type: string + title: account_id + title: SetPersonalAccountResponse + additionalProperties: false + mgmt.v1alpha1.SetUserRequest: + type: object + title: SetUserRequest + additionalProperties: false + mgmt.v1alpha1.SetUserResponse: + type: object + properties: + userId: + type: string + title: user_id + title: SetUserResponse + additionalProperties: false + mgmt.v1alpha1.UserAccount: + type: object + properties: + id: + type: string + title: id + description: The unique identifier of the account + name: + type: string + title: name + description: The account slug + type: + allOf: + - title: type + description: The type of account + - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccountType' + hasStripeCustomerId: + type: boolean + title: has_stripe_customer_id + description: Whether or not the account has an associated stripe customer id + title: UserAccount + additionalProperties: false +x-tagGroups: + - name: mgmt.v1alpha1 + tags: + - mgmt.v1alpha1.AnonymizationService + - mgmt.v1alpha1.ApiKeyService + - mgmt.v1alpha1.AuthService + - mgmt.v1alpha1.ConnectionService + - mgmt.v1alpha1.ConnectionDataService + - mgmt.v1alpha1.JobService + - mgmt.v1alpha1.MetricsService + - mgmt.v1alpha1.TransformersService + - mgmt.v1alpha1.UserAccountService diff --git a/schema_only.sql b/schema_only.sql new file mode 100644 index 0000000000..6865a4da0a --- /dev/null +++ b/schema_only.sql @@ -0,0 +1,4 @@ +Msg 102, Level 15, State 1, Server 07735386916f, Line 1 +Incorrect syntax near '.'. +Msg 102, Level 15, State 1, Server 07735386916f, Line 1 +Incorrect syntax near '.'. From 5481e618d8a468c7c651420380ad54b4b9626df6 Mon Sep 17 00:00:00 2001 From: Evis Drenova Date: Thu, 24 Oct 2024 17:01:29 -0700 Subject: [PATCH 2/3] update link --- docs/final_openapi.yaml | 11600 -------------------------------------- schema_only.sql | 4 - 2 files changed, 11604 deletions(-) delete mode 100644 docs/final_openapi.yaml delete mode 100644 schema_only.sql diff --git a/docs/final_openapi.yaml b/docs/final_openapi.yaml deleted file mode 100644 index 9fe43a6efb..0000000000 --- a/docs/final_openapi.yaml +++ /dev/null @@ -1,11600 +0,0 @@ -openapi: 3.0.1 -info: - title: mgmt.v1alpha1 - version: '1' -tags: - - name: mgmt.v1alpha1.AnonymizationService - x-displayName: mgmt.v1alpha1.AnonymizationService - - name: mgmt.v1alpha1.ApiKeyService - description: >- - Service that manages the lifecycle of API Keys that are associated with a - specific Account. - x-displayName: mgmt.v1alpha1.ApiKeyService - - name: mgmt.v1alpha1.AuthService - description: |- - Service that handles generic Authentication for Neosync - Today this is mostly used by the CLI to receive authentication information - x-displayName: mgmt.v1alpha1.AuthService - - name: mgmt.v1alpha1.ConnectionService - description: |- - Service for managing datasource connections. - This is a primary data model in Neosync and is used in reference when hooking up Jobs to synchronize and generate data. - x-displayName: mgmt.v1alpha1.ConnectionService - - name: mgmt.v1alpha1.ConnectionDataService - description: |- - Service for managing connection data. - This is used in handle data from a connection - x-displayName: mgmt.v1alpha1.ConnectionDataService - - name: mgmt.v1alpha1.JobService - x-displayName: mgmt.v1alpha1.JobService - - name: mgmt.v1alpha1.MetricsService - x-displayName: mgmt.v1alpha1.MetricsService - - name: mgmt.v1alpha1.TransformersService - x-displayName: mgmt.v1alpha1.TransformersService - - name: mgmt.v1alpha1.UserAccountService - x-displayName: mgmt.v1alpha1.UserAccountService -paths: - /mgmt.v1alpha1.AnonymizationService/AnonymizeMany: - post: - tags: - - mgmt.v1alpha1.AnonymizationService - summary: AnonymizeMany - description: >- - Anonymizes many JSON strings by applying specified transformation - mappings. - operationId: mgmt.v1alpha1.AnonymizationService.AnonymizeMany - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AnonymizationService/AnonymizeSingle: - post: - tags: - - mgmt.v1alpha1.AnonymizationService - summary: AnonymizeSingle - description: >- - Anonymizes a single JSON strings by applying specified transformation - mappings. - operationId: mgmt.v1alpha1.AnonymizationService.AnonymizeSingle - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeSingleRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeSingleResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ApiKeyService/GetAccountApiKeys: - post: - tags: - - mgmt.v1alpha1.ApiKeyService - summary: GetAccountApiKeys - description: Retrieves a list of Account API Keys - operationId: mgmt.v1alpha1.ApiKeyService.GetAccountApiKeys - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeysRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeysResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ApiKeyService/GetAccountApiKey: - post: - tags: - - mgmt.v1alpha1.ApiKeyService - summary: GetAccountApiKey - description: Retrieves a single API Key - operationId: mgmt.v1alpha1.ApiKeyService.GetAccountApiKey - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeyRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountApiKeyResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ApiKeyService/CreateAccountApiKey: - post: - tags: - - mgmt.v1alpha1.ApiKeyService - summary: CreateAccountApiKey - description: |- - Creates a single API Key - This method will return the decrypted contents of the API key - operationId: mgmt.v1alpha1.ApiKeyService.CreateAccountApiKey - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateAccountApiKeyRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateAccountApiKeyResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ApiKeyService/RegenerateAccountApiKey: - post: - tags: - - mgmt.v1alpha1.ApiKeyService - summary: RegenerateAccountApiKey - description: |- - Regenerates a single API Key with a new expiration time - This method will return the decrypted contents of the API key - operationId: mgmt.v1alpha1.ApiKeyService.RegenerateAccountApiKey - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RegenerateAccountApiKeyRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RegenerateAccountApiKeyResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ApiKeyService/DeleteAccountApiKey: - post: - tags: - - mgmt.v1alpha1.ApiKeyService - summary: DeleteAccountApiKey - description: Deletes an API Key from the system. - operationId: mgmt.v1alpha1.ApiKeyService.DeleteAccountApiKey - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteAccountApiKeyRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteAccountApiKeyResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/LoginCli: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: LoginCli - description: Used by the CLI to login to Neosync with OAuth. - operationId: mgmt.v1alpha1.AuthService.LoginCli - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.LoginCliRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.LoginCliResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/RefreshCli: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: RefreshCli - description: |- - Used by the CLI to refresh an expired Neosync accesss token. - This should only be used if an access token was previously retrieved from the `LoginCli` or `RefreshCli` methods. - operationId: mgmt.v1alpha1.AuthService.RefreshCli - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.RefreshCliRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.RefreshCliResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/CheckToken: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: CheckToken - description: Empty endpoint to simply check if the provided access token is valid - operationId: mgmt.v1alpha1.AuthService.CheckToken - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CheckTokenRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CheckTokenResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/GetCliIssuer: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: GetCliIssuer - description: |- - Used by the CLI to retrieve Auth Issuer information - @deprecated - operationId: mgmt.v1alpha1.AuthService.GetCliIssuer - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetCliIssuerRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetCliIssuerResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/GetAuthorizeUrl: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: GetAuthorizeUrl - description: Used by the CLI to retrieve an Authorize URL for use with OAuth login. - operationId: mgmt.v1alpha1.AuthService.GetAuthorizeUrl - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthorizeUrlRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthorizeUrlResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.AuthService/GetAuthStatus: - post: - tags: - - mgmt.v1alpha1.AuthService - summary: GetAuthStatus - description: >- - Returns the auth status of the API server. Whether or not the backend - has authentication enabled. - This is used by clients to make decisions on whether or not they should send access tokens to the API. - operationId: mgmt.v1alpha1.AuthService.GetAuthStatus - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthStatusRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAuthStatusResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/GetConnections: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: GetConnections - description: Returns a list of connections associated with the account - operationId: mgmt.v1alpha1.ConnectionService.GetConnections - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/GetConnection: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: GetConnection - description: Returns a single connection - operationId: mgmt.v1alpha1.ConnectionService.GetConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/CreateConnection: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: CreateConnection - description: Creates a new connection - operationId: mgmt.v1alpha1.ConnectionService.CreateConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateConnectionRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateConnectionResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/UpdateConnection: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: UpdateConnection - description: Updates an existing connection - operationId: mgmt.v1alpha1.ConnectionService.UpdateConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.UpdateConnectionRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.UpdateConnectionResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/DeleteConnection: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: DeleteConnection - description: Removes a connection from the system. - operationId: mgmt.v1alpha1.ConnectionService.DeleteConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteConnectionRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteConnectionResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/IsConnectionNameAvailable: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: IsConnectionNameAvailable - description: >- - Connections have friendly names, this method checks if the requested - name is available in the system based on the account - operationId: mgmt.v1alpha1.ConnectionService.IsConnectionNameAvailable - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.IsConnectionNameAvailableRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.IsConnectionNameAvailableResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/CheckConnectionConfig: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: CheckConnectionConfig - description: |- - Checks if the connection config is connectable by the backend. - Used mostly to verify that a connection is valid prior to creating a Connection object. - operationId: mgmt.v1alpha1.ConnectionService.CheckConnectionConfig - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CheckConnectionConfigRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/CheckConnectionConfigById: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: CheckConnectionConfigById - description: |- - Checks if the connection id is connectable by the backend. - Used to verify that a connection is still connectable. - operationId: mgmt.v1alpha1.ConnectionService.CheckConnectionConfigById - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigByIdRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CheckConnectionConfigByIdResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionService/CheckSqlQuery: - post: - tags: - - mgmt.v1alpha1.ConnectionService - summary: CheckSqlQuery - description: >- - Checks a constructed SQL query against a sql-based connection to see if - it's valid based on that connection's data schema - This is useful when constructing subsets to see if the WHERE clause is correct - operationId: mgmt.v1alpha1.ConnectionService.CheckSqlQuery - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CheckSqlQueryRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CheckSqlQueryResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionDataStream: {} - /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchema: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionSchema - description: >- - Returns the schema for a specific connection. Used mostly for SQL-based - connections - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchema - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchemaMap: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionSchemaMap - description: >- - Returns the schema in map format. The keys are the fully qualified table - in the format .
- operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchemaMap - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionSchemaMaps: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionSchemaMaps - description: Returns the schema in map format for every request provided - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionSchemaMaps - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionTableConstraints: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionTableConstraints - description: >- - For a specific connection, returns the table constraints. Mostly useful - for SQL-based Connections. - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionTableConstraints - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionTableConstraintsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionTableConstraintsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionForeignConstraints: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionForeignConstraints - description: >- - For a specific connection, returns the foreign key constraints. Mostly - useful for SQL-based Connections. - Used primarily by the CLI sync command to determine stream order. - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionForeignConstraints - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionForeignConstraintsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionForeignConstraintsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionPrimaryConstraints: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionPrimaryConstraints - description: >- - For a specific connection, returns the primary key constraints. Mostly - useful for SQL-based Connections. - Used primarily by the CLI sync command to determine stream order. - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionPrimaryConstraints - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionPrimaryConstraintsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionInitStatements: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionInitStatements - description: >- - For a specific connection, returns the init table statements. Mostly - useful for SQL-based Connections. - Used primarily by the CLI sync command to create table schema init statement. - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionInitStatements - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionInitStatementsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionInitStatementsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetConnectionUniqueConstraints: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetConnectionUniqueConstraints - description: >- - For a specific connection, returns the unique constraints. Mostly useful - for SQL-based connections. - operationId: mgmt.v1alpha1.ConnectionDataService.GetConnectionUniqueConstraints - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionUniqueConstraintsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetAiGeneratedData: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetAiGeneratedData - description: >- - Query an AI connection by providing the necessary values. Typically used - for generating preview data - operationId: mgmt.v1alpha1.ConnectionDataService.GetAiGeneratedData - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAiGeneratedDataRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAiGeneratedDataResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.ConnectionDataService/GetTableRowCount: - post: - tags: - - mgmt.v1alpha1.ConnectionDataService - summary: GetTableRowCount - description: Query table with subset to get row count - operationId: mgmt.v1alpha1.ConnectionDataService.GetTableRowCount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetTableRowCountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetTableRowCountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobs: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobs - operationId: mgmt.v1alpha1.JobService.GetJobs - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJob: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJob - operationId: mgmt.v1alpha1.JobService.GetJob - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/CreateJob: - post: - tags: - - mgmt.v1alpha1.JobService - summary: CreateJob - operationId: mgmt.v1alpha1.JobService.CreateJob - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/DeleteJob: - post: - tags: - - mgmt.v1alpha1.JobService - summary: DeleteJob - operationId: mgmt.v1alpha1.JobService.DeleteJob - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/IsJobNameAvailable: - post: - tags: - - mgmt.v1alpha1.JobService - summary: IsJobNameAvailable - operationId: mgmt.v1alpha1.JobService.IsJobNameAvailable - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.IsJobNameAvailableRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.IsJobNameAvailableResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/UpdateJobSchedule: - post: - tags: - - mgmt.v1alpha1.JobService - summary: UpdateJobSchedule - operationId: mgmt.v1alpha1.JobService.UpdateJobSchedule - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.UpdateJobScheduleRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.UpdateJobScheduleResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/UpdateJobSourceConnection: - post: - tags: - - mgmt.v1alpha1.JobService - summary: UpdateJobSourceConnection - operationId: mgmt.v1alpha1.JobService.UpdateJobSourceConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateJobSourceConnectionRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateJobSourceConnectionResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/SetJobSourceSqlConnectionSubsets: - post: - tags: - - mgmt.v1alpha1.JobService - summary: SetJobSourceSqlConnectionSubsets - operationId: mgmt.v1alpha1.JobService.SetJobSourceSqlConnectionSubsets - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/UpdateJobDestinationConnection: - post: - tags: - - mgmt.v1alpha1.JobService - summary: UpdateJobDestinationConnection - operationId: mgmt.v1alpha1.JobService.UpdateJobDestinationConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateJobDestinationConnectionRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateJobDestinationConnectionResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/DeleteJobDestinationConnection: - post: - tags: - - mgmt.v1alpha1.JobService - summary: DeleteJobDestinationConnection - operationId: mgmt.v1alpha1.JobService.DeleteJobDestinationConnection - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.DeleteJobDestinationConnectionRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.DeleteJobDestinationConnectionResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/CreateJobDestinationConnections: - post: - tags: - - mgmt.v1alpha1.JobService - summary: CreateJobDestinationConnections - operationId: mgmt.v1alpha1.JobService.CreateJobDestinationConnections - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CreateJobDestinationConnectionsRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CreateJobDestinationConnectionsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/PauseJob: - post: - tags: - - mgmt.v1alpha1.JobService - summary: PauseJob - operationId: mgmt.v1alpha1.JobService.PauseJob - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.PauseJobRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.PauseJobResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobRecentRuns: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobRecentRuns - description: >- - Returns a list of recently invoked job runs baseds on the Temporal cron - scheduler. This will return a list of job runs that include archived - runs - operationId: mgmt.v1alpha1.JobService.GetJobRecentRuns - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRecentRunsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRecentRunsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobNextRuns: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobNextRuns - description: >- - Returns a list of runs that are scheduled for execution based on the - Temporal cron scheduler. - operationId: mgmt.v1alpha1.JobService.GetJobNextRuns - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobNextRunsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobNextRunsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobStatus: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobStatus - operationId: mgmt.v1alpha1.JobService.GetJobStatus - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobStatuses: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobStatuses - operationId: mgmt.v1alpha1.JobService.GetJobStatuses - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusesRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobStatusesResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobRuns: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobRuns - description: Returns a list of job runs by either account or job - operationId: mgmt.v1alpha1.JobService.GetJobRuns - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobRunEvents: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobRunEvents - operationId: mgmt.v1alpha1.JobService.GetJobRunEvents - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunEventsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunEventsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobRun: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetJobRun - description: Returns a specific job run, along with any of its pending activities - operationId: mgmt.v1alpha1.JobService.GetJobRun - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetJobRunResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/DeleteJobRun: - post: - tags: - - mgmt.v1alpha1.JobService - summary: DeleteJobRun - operationId: mgmt.v1alpha1.JobService.DeleteJobRun - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRunRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.DeleteJobRunResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/CreateJobRun: - post: - tags: - - mgmt.v1alpha1.JobService - summary: CreateJobRun - operationId: mgmt.v1alpha1.JobService.CreateJobRun - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRunRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobRunResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/CancelJobRun: - post: - tags: - - mgmt.v1alpha1.JobService - summary: CancelJobRun - operationId: mgmt.v1alpha1.JobService.CancelJobRun - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CancelJobRunRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CancelJobRunResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/TerminateJobRun: - post: - tags: - - mgmt.v1alpha1.JobService - summary: TerminateJobRun - operationId: mgmt.v1alpha1.JobService.TerminateJobRun - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.TerminateJobRunRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.TerminateJobRunResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetJobRunLogsStream: {} - /mgmt.v1alpha1.JobService/SetJobWorkflowOptions: - post: - tags: - - mgmt.v1alpha1.JobService - summary: SetJobWorkflowOptions - description: >- - Set any job workflow options. Must provide entire object as is it will - fully override the previous configuration - operationId: mgmt.v1alpha1.JobService.SetJobWorkflowOptions - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetJobWorkflowOptionsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetJobWorkflowOptionsResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/SetJobSyncOptions: - post: - tags: - - mgmt.v1alpha1.JobService - summary: SetJobSyncOptions - description: >- - Set the job sync options. Must provide entire object as it will fully - override the previous configuration - operationId: mgmt.v1alpha1.JobService.SetJobSyncOptions - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetJobSyncOptionsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetJobSyncOptionsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/ValidateJobMappings: - post: - tags: - - mgmt.v1alpha1.JobService - summary: ValidateJobMappings - description: validates that the jobmapping configured can run with table constraints - operationId: mgmt.v1alpha1.JobService.ValidateJobMappings - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.ValidateJobMappingsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.ValidateJobMappingsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/GetRunContext: - post: - tags: - - mgmt.v1alpha1.JobService - summary: GetRunContext - description: Gets a run context to be used by a workflow run - operationId: mgmt.v1alpha1.JobService.GetRunContext - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetRunContextRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetRunContextResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/SetRunContext: - post: - tags: - - mgmt.v1alpha1.JobService - summary: SetRunContext - description: Sets a run context to be used by a workflow run - operationId: mgmt.v1alpha1.JobService.SetRunContext - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetRunContextRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetRunContextResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.JobService/SetRunContexts: {} - /mgmt.v1alpha1.MetricsService/GetDailyMetricCount: - post: - tags: - - mgmt.v1alpha1.MetricsService - summary: GetDailyMetricCount - description: Retrieve a timed range of records - operationId: mgmt.v1alpha1.MetricsService.GetDailyMetricCount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetDailyMetricCountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetDailyMetricCountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.MetricsService/GetMetricCount: - post: - tags: - - mgmt.v1alpha1.MetricsService - summary: GetMetricCount - description: For the given metric and time range, returns the total count found - operationId: mgmt.v1alpha1.MetricsService.GetMetricCount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetMetricCountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetMetricCountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/GetSystemTransformers: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: GetSystemTransformers - operationId: mgmt.v1alpha1.TransformersService.GetSystemTransformers - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetSystemTransformersRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetSystemTransformersResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/GetSystemTransformerBySource: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: GetSystemTransformerBySource - operationId: mgmt.v1alpha1.TransformersService.GetSystemTransformerBySource - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetSystemTransformerBySourceRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetSystemTransformerBySourceResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/GetUserDefinedTransformers: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: GetUserDefinedTransformers - operationId: mgmt.v1alpha1.TransformersService.GetUserDefinedTransformers - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformersRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformersResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/GetUserDefinedTransformerById: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: GetUserDefinedTransformerById - operationId: mgmt.v1alpha1.TransformersService.GetUserDefinedTransformerById - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformerByIdRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetUserDefinedTransformerByIdResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/CreateUserDefinedTransformer: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: CreateUserDefinedTransformer - operationId: mgmt.v1alpha1.TransformersService.CreateUserDefinedTransformer - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CreateUserDefinedTransformerRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.CreateUserDefinedTransformerResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/DeleteUserDefinedTransformer: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: DeleteUserDefinedTransformer - operationId: mgmt.v1alpha1.TransformersService.DeleteUserDefinedTransformer - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.DeleteUserDefinedTransformerRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.DeleteUserDefinedTransformerResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/UpdateUserDefinedTransformer: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: UpdateUserDefinedTransformer - operationId: mgmt.v1alpha1.TransformersService.UpdateUserDefinedTransformer - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateUserDefinedTransformerRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.UpdateUserDefinedTransformerResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/IsTransformerNameAvailable: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: IsTransformerNameAvailable - operationId: mgmt.v1alpha1.TransformersService.IsTransformerNameAvailable - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.IsTransformerNameAvailableRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.IsTransformerNameAvailableResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/ValidateUserJavascriptCode: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: ValidateUserJavascriptCode - operationId: mgmt.v1alpha1.TransformersService.ValidateUserJavascriptCode - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.ValidateUserJavascriptCodeRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.ValidateUserJavascriptCodeResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.TransformersService/ValidateUserRegexCode: - post: - tags: - - mgmt.v1alpha1.TransformersService - summary: ValidateUserRegexCode - operationId: mgmt.v1alpha1.TransformersService.ValidateUserRegexCode - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.ValidateUserRegexCodeRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.ValidateUserRegexCodeResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetUser: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetUser - operationId: mgmt.v1alpha1.UserAccountService.GetUser - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetUserRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetUserResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/SetUser: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: SetUser - operationId: mgmt.v1alpha1.UserAccountService.SetUser - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetUserRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetUserResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetUserAccounts: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetUserAccounts - operationId: mgmt.v1alpha1.UserAccountService.GetUserAccounts - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetUserAccountsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetUserAccountsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/SetPersonalAccount: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: SetPersonalAccount - operationId: mgmt.v1alpha1.UserAccountService.SetPersonalAccount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetPersonalAccountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetPersonalAccountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/ConvertPersonalToTeamAccount: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: ConvertPersonalToTeamAccount - description: >- - Convert a personal account to a team account retaining all of the jobs - and connections. This will also create a new empty personal account. - operationId: mgmt.v1alpha1.UserAccountService.ConvertPersonalToTeamAccount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.ConvertPersonalToTeamAccountRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.ConvertPersonalToTeamAccountResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/CreateTeamAccount: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: CreateTeamAccount - description: Creates a new team account - operationId: mgmt.v1alpha1.UserAccountService.CreateTeamAccount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateTeamAccountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateTeamAccountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/IsUserInAccount: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: IsUserInAccount - operationId: mgmt.v1alpha1.UserAccountService.IsUserInAccount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.IsUserInAccountRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.IsUserInAccountResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetAccountTemporalConfig: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetAccountTemporalConfig - operationId: mgmt.v1alpha1.UserAccountService.GetAccountTemporalConfig - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountTemporalConfigRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountTemporalConfigResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/SetAccountTemporalConfig: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: SetAccountTemporalConfig - operationId: mgmt.v1alpha1.UserAccountService.SetAccountTemporalConfig - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetAccountTemporalConfigRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetAccountTemporalConfigResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetTeamAccountMembers: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetTeamAccountMembers - operationId: mgmt.v1alpha1.UserAccountService.GetTeamAccountMembers - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetTeamAccountMembersRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetTeamAccountMembersResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/RemoveTeamAccountMember: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: RemoveTeamAccountMember - operationId: mgmt.v1alpha1.UserAccountService.RemoveTeamAccountMember - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountMemberRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountMemberResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/InviteUserToTeamAccount: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: InviteUserToTeamAccount - operationId: mgmt.v1alpha1.UserAccountService.InviteUserToTeamAccount - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.InviteUserToTeamAccountRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.InviteUserToTeamAccountResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetTeamAccountInvites: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetTeamAccountInvites - operationId: mgmt.v1alpha1.UserAccountService.GetTeamAccountInvites - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetTeamAccountInvitesRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetTeamAccountInvitesResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/RemoveTeamAccountInvite: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: RemoveTeamAccountInvite - operationId: mgmt.v1alpha1.UserAccountService.RemoveTeamAccountInvite - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountInviteRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.RemoveTeamAccountInviteResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/AcceptTeamAccountInvite: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: AcceptTeamAccountInvite - operationId: mgmt.v1alpha1.UserAccountService.AcceptTeamAccountInvite - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.AcceptTeamAccountInviteRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.AcceptTeamAccountInviteResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetSystemInformation: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetSystemInformation - operationId: mgmt.v1alpha1.UserAccountService.GetSystemInformation - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetSystemInformationRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetSystemInformationResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetAccountOnboardingConfig: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetAccountOnboardingConfig - operationId: mgmt.v1alpha1.UserAccountService.GetAccountOnboardingConfig - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountOnboardingConfigRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountOnboardingConfigResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/SetAccountOnboardingConfig: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: SetAccountOnboardingConfig - operationId: mgmt.v1alpha1.UserAccountService.SetAccountOnboardingConfig - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetAccountOnboardingConfigRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetAccountOnboardingConfigResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetAccountStatus: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetAccountStatus - description: >- - Returns different metrics on the account status for the active billing - period - operationId: mgmt.v1alpha1.UserAccountService.GetAccountStatus - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountStatusRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetAccountStatusResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/IsAccountStatusValid: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: IsAccountStatusValid - description: Distils the account status down to whether not it is in a valid state. - operationId: mgmt.v1alpha1.UserAccountService.IsAccountStatusValid - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.IsAccountStatusValidRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.IsAccountStatusValidResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetAccountBillingCheckoutSession: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetAccountBillingCheckoutSession - description: Returns a new checkout session for the account to subscribe - operationId: mgmt.v1alpha1.UserAccountService.GetAccountBillingCheckoutSession - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountBillingCheckoutSessionRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountBillingCheckoutSessionResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetAccountBillingPortalSession: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetAccountBillingPortalSession - description: >- - Returns a new billing portal session if the account has a billing - customer id - operationId: mgmt.v1alpha1.UserAccountService.GetAccountBillingPortalSession - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountBillingPortalSessionRequest - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.GetAccountBillingPortalSessionResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/GetBillingAccounts: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: GetBillingAccounts - description: Returns user accounts that have a billing id. - operationId: mgmt.v1alpha1.UserAccountService.GetBillingAccounts - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetBillingAccountsRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.GetBillingAccountsResponse' - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] - /mgmt.v1alpha1.UserAccountService/SetBillingMeterEvent: - post: - tags: - - mgmt.v1alpha1.UserAccountService - summary: SetBillingMeterEvent - description: Sends a new metered event to the billing system - operationId: mgmt.v1alpha1.UserAccountService.SetBillingMeterEvent - parameters: - - name: Connect-Protocol-Version - in: header - required: true - schema: - $ref: '#/components/schemas/connect-protocol-version' - - name: Connect-Timeout-Ms - in: header - schema: - $ref: '#/components/schemas/connect-timeout-header' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/mgmt.v1alpha1.SetBillingMeterEventRequest' - required: true - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: >- - #/components/schemas/mgmt.v1alpha1.SetBillingMeterEventResponse - default: - description: Error - content: - application/json: - schema: - $ref: '#/components/schemas/connect.error' - security: [] -components: - schemas: - mgmt.v1alpha1.GenerateEmailType: - type: string - title: GenerateEmailType - enum: - - GENERATE_EMAIL_TYPE_UNSPECIFIED - - GENERATE_EMAIL_TYPE_UUID_V4 - - GENERATE_EMAIL_TYPE_FULLNAME - mgmt.v1alpha1.InvalidEmailAction: - type: string - title: InvalidEmailAction - enum: - - INVALID_EMAIL_ACTION_UNSPECIFIED - - INVALID_EMAIL_ACTION_REJECT - - INVALID_EMAIL_ACTION_NULL - - INVALID_EMAIL_ACTION_PASSTHROUGH - - INVALID_EMAIL_ACTION_GENERATE - description: >- - Action enumeration that dictates what the transform_email transformer - should do in the case that it encounters an email that does not conform - to RFC 5322 - mgmt.v1alpha1.PiiAnonymizer.Hash.HashType: - type: string - title: HashType - enum: - - HASH_TYPE_UNSPECIFIED - - HASH_TYPE_MD5 - - HASH_TYPE_SHA256 - - HASH_TYPE_SHA512 - mgmt.v1alpha1.AnonymizeManyErrors: - type: object - properties: - inputIndex: - oneOf: - - type: string - - type: number - title: input_index - description: Index of input data that caused error - errorMessage: - type: string - title: error_message - description: Error message - title: AnonymizeManyErrors - additionalProperties: false - mgmt.v1alpha1.AnonymizeManyRequest: - type: object - allOf: - - anyOf: - - required: - - defaultTransformers - - not: - anyOf: - - required: - - defaultTransformers - anyOf: - - required: - - defaultTransformers - - not: - anyOf: - - required: - - defaultTransformers - properties: - inputData: - type: array - items: - type: string - minLength: 1 - maxItems: 25 - minItems: 1 - title: input_data - maxItems: 25 - minItems: 1 - description: Array of stringified JSON data to be anonymized (up to 25 items) - transformerMappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerMapping' - title: transformer_mappings - description: Array of Transformer mappings - defaultTransformers: - allOf: - - title: default_transformers - description: Optional default transformations for any unmapped keys - - $ref: '#/components/schemas/mgmt.v1alpha1.DefaultTransformersConfig' - haltOnFailure: - type: boolean - title: halt_on_failure - description: |- - Flag to indicate whether to stop processing when an error occurs - true: stops on first error encounter - title: AnonymizeManyRequest - additionalProperties: false - mgmt.v1alpha1.AnonymizeManyResponse: - type: object - properties: - outputData: - type: array - items: - type: string - title: output_data - description: Array of anonymized JSON data - errors: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AnonymizeManyErrors' - title: errors - description: Array of errors that occured during anonymization - title: AnonymizeManyResponse - additionalProperties: false - mgmt.v1alpha1.AnonymizeSingleRequest: - type: object - allOf: - - anyOf: - - required: - - defaultTransformers - - not: - anyOf: - - required: - - defaultTransformers - anyOf: - - required: - - defaultTransformers - - not: - anyOf: - - required: - - defaultTransformers - properties: - inputData: - type: string - title: input_data - description: Stringified JSON data to be anonymized - transformerMappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerMapping' - title: transformer_mappings - description: Array of Transformer mappings - defaultTransformers: - allOf: - - title: default_transformers - description: Optional default transformations for any unmapped keys - - $ref: '#/components/schemas/mgmt.v1alpha1.DefaultTransformersConfig' - title: AnonymizeSingleRequest - additionalProperties: false - mgmt.v1alpha1.AnonymizeSingleResponse: - type: object - properties: - outputData: - type: string - title: output_data - description: Anonymized JSON data - title: AnonymizeSingleResponse - additionalProperties: false - mgmt.v1alpha1.DefaultTransformersConfig: - type: object - properties: - boolean: - allOf: - - title: boolean - description: Boolean - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - 'n': - allOf: - - title: 'n' - description: Number - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - s: - allOf: - - title: s - description: String - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - title: DefaultTransformersConfig - additionalProperties: false - mgmt.v1alpha1.GenerateBool: - type: object - title: GenerateBool - additionalProperties: false - mgmt.v1alpha1.GenerateCardNumber: - type: object - properties: - validLuhn: - type: boolean - title: valid_luhn - title: GenerateCardNumber - additionalProperties: false - mgmt.v1alpha1.GenerateCategorical: - type: object - properties: - categories: - type: string - title: categories - title: GenerateCategorical - additionalProperties: false - mgmt.v1alpha1.GenerateCity: - type: object - title: GenerateCity - additionalProperties: false - mgmt.v1alpha1.GenerateCountry: - type: object - properties: - generateFullName: - type: boolean - title: generate_full_name - description: >- - An option to return the full country name of the randomly selected - country or return the default of a 2-letter country code. - title: GenerateCountry - additionalProperties: false - mgmt.v1alpha1.GenerateDefault: - type: object - title: GenerateDefault - additionalProperties: false - mgmt.v1alpha1.GenerateE164PhoneNumber: - type: object - properties: - min: - oneOf: - - type: string - - type: number - title: min - max: - oneOf: - - type: string - - type: number - title: max - title: GenerateE164PhoneNumber - additionalProperties: false - mgmt.v1alpha1.GenerateEmail: - type: object - allOf: - - anyOf: - - required: - - emailType - - not: - anyOf: - - required: - - emailType - anyOf: - - required: - - emailType - - not: - anyOf: - - required: - - emailType - properties: - emailType: - allOf: - - title: email_type - description: >- - Optionally specify the type of email to generate. The types - specified determine the contents on the left side of the @. - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmailType' - title: GenerateEmail - additionalProperties: false - mgmt.v1alpha1.GenerateFirstName: - type: object - title: GenerateFirstName - additionalProperties: false - mgmt.v1alpha1.GenerateFloat64: - type: object - properties: - randomizeSign: - type: boolean - title: randomize_sign - min: - oneOf: - - type: string - - type: number - title: min - max: - oneOf: - - type: string - - type: number - title: max - precision: - oneOf: - - type: string - - type: number - title: precision - title: GenerateFloat64 - additionalProperties: false - mgmt.v1alpha1.GenerateFullAddress: - type: object - title: GenerateFullAddress - additionalProperties: false - mgmt.v1alpha1.GenerateFullName: - type: object - title: GenerateFullName - additionalProperties: false - mgmt.v1alpha1.GenerateGender: - type: object - properties: - abbreviate: - type: boolean - title: abbreviate - title: GenerateGender - additionalProperties: false - mgmt.v1alpha1.GenerateInt64: - type: object - properties: - randomizeSign: - type: boolean - title: randomize_sign - min: - oneOf: - - type: string - - type: number - title: min - max: - oneOf: - - type: string - - type: number - title: max - title: GenerateInt64 - additionalProperties: false - mgmt.v1alpha1.GenerateInt64PhoneNumber: - type: object - title: GenerateInt64PhoneNumber - additionalProperties: false - mgmt.v1alpha1.GenerateJavascript: - type: object - properties: - code: - type: string - title: code - title: GenerateJavascript - additionalProperties: false - mgmt.v1alpha1.GenerateLastName: - type: object - title: GenerateLastName - additionalProperties: false - mgmt.v1alpha1.GenerateSSN: - type: object - title: GenerateSSN - additionalProperties: false - mgmt.v1alpha1.GenerateSha256Hash: - type: object - title: GenerateSha256Hash - additionalProperties: false - mgmt.v1alpha1.GenerateState: - type: object - properties: - generateFullName: - type: boolean - title: generate_full_name - description: >- - An option to return the full state name of the randomly selected - state or return the default of a 2-letter state code. - title: GenerateState - additionalProperties: false - mgmt.v1alpha1.GenerateStreetAddress: - type: object - title: GenerateStreetAddress - additionalProperties: false - mgmt.v1alpha1.GenerateString: - type: object - properties: - min: - oneOf: - - type: string - - type: number - title: min - max: - oneOf: - - type: string - - type: number - title: max - title: GenerateString - additionalProperties: false - mgmt.v1alpha1.GenerateStringPhoneNumber: - type: object - properties: - min: - oneOf: - - type: string - - type: number - title: min - max: - oneOf: - - type: string - - type: number - title: max - title: GenerateStringPhoneNumber - additionalProperties: false - mgmt.v1alpha1.GenerateUnixTimestamp: - type: object - title: GenerateUnixTimestamp - additionalProperties: false - mgmt.v1alpha1.GenerateUsername: - type: object - title: GenerateUsername - additionalProperties: false - mgmt.v1alpha1.GenerateUtcTimestamp: - type: object - title: GenerateUtcTimestamp - additionalProperties: false - mgmt.v1alpha1.GenerateUuid: - type: object - properties: - includeHyphens: - type: boolean - title: include_hyphens - title: GenerateUuid - additionalProperties: false - mgmt.v1alpha1.GenerateZipcode: - type: object - title: GenerateZipcode - additionalProperties: false - mgmt.v1alpha1.Null: - type: object - title: 'Null' - additionalProperties: false - mgmt.v1alpha1.Passthrough: - type: object - title: Passthrough - additionalProperties: false - mgmt.v1alpha1.PiiAnonymizer: - type: object - allOf: - - anyOf: - - required: - - hash - - required: - - mask - - required: - - redact - - required: - - replace - - not: - anyOf: - - required: - - hash - - required: - - mask - - required: - - redact - - required: - - replace - anyOf: - - required: - - hash - - required: - - mask - - required: - - redact - - required: - - replace - - not: - anyOf: - - required: - - hash - - required: - - mask - - required: - - redact - - required: - - replace - properties: - replace: - allOf: - - title: replace - description: >- - Configures the anonymizer to replace the identified PII with a - specific value - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Replace' - redact: - allOf: - - title: redact - description: >- - Configures the anonymizer to completely remove the identified - PII - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Redact' - mask: - allOf: - - title: mask - description: Configures the anonymizer to mask the identified PII - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Mask' - hash: - allOf: - - title: hash - description: Configures the anonymizer to hash the identified PII - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Hash' - title: PiiAnonymizer - additionalProperties: false - mgmt.v1alpha1.PiiAnonymizer.Hash: - type: object - allOf: - - anyOf: - - required: - - algo - - not: - anyOf: - - required: - - algo - anyOf: - - required: - - algo - - not: - anyOf: - - required: - - algo - properties: - algo: - allOf: - - title: algo - description: The hashing algorithm to use. - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer.Hash.HashType' - title: Hash - additionalProperties: false - mgmt.v1alpha1.PiiAnonymizer.Mask: - type: object - allOf: - - anyOf: - - required: - - charsToMask - - not: - anyOf: - - required: - - charsToMask - - anyOf: - - required: - - fromEnd - - not: - anyOf: - - required: - - fromEnd - - anyOf: - - required: - - maskingChar - - not: - anyOf: - - required: - - maskingChar - properties: - maskingChar: - type: string - title: masking_char - description: Provide a character that will be used for the replacement. - charsToMask: - type: integer - title: chars_to_mask - description: How many characters to mask. - fromEnd: - type: boolean - title: from_end - description: Whether to mask the PII from start or end - title: Mask - additionalProperties: false - mgmt.v1alpha1.PiiAnonymizer.Redact: - type: object - title: Redact - additionalProperties: false - mgmt.v1alpha1.PiiAnonymizer.Replace: - type: object - allOf: - - anyOf: - - required: - - value - - not: - anyOf: - - required: - - value - anyOf: - - required: - - value - - not: - anyOf: - - required: - - value - properties: - value: - type: string - title: value - description: >- - The value to replace. If not provided, a template token of the - anonymizer is used. - title: Replace - additionalProperties: false - mgmt.v1alpha1.PiiDenyRecognizer: - type: object - properties: - name: - type: string - title: name - pattern: ^[a-z0-9-_]{1,100}$ - description: Friendly name of this entity - denyWords: - type: array - items: - type: string - minLength: 1 - title: deny_words - description: List of words that will be treated as PII. - title: PiiDenyRecognizer - additionalProperties: false - mgmt.v1alpha1.TransformCharacterScramble: - type: object - allOf: - - anyOf: - - required: - - userProvidedRegex - - not: - anyOf: - - required: - - userProvidedRegex - anyOf: - - required: - - userProvidedRegex - - not: - anyOf: - - required: - - userProvidedRegex - properties: - userProvidedRegex: - type: string - title: user_provided_regex - description: >- - a user provided regular expression that they wish to validate if it - compiles in GO - title: TransformCharacterScramble - additionalProperties: false - mgmt.v1alpha1.TransformE164PhoneNumber: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformE164PhoneNumber - additionalProperties: false - mgmt.v1alpha1.TransformEmail: - type: object - allOf: - - anyOf: - - required: - - emailType - - not: - anyOf: - - required: - - emailType - - anyOf: - - required: - - invalidEmailAction - - not: - anyOf: - - required: - - invalidEmailAction - properties: - preserveDomain: - type: boolean - title: preserve_domain - description: >- - Whether or not to preserve the original domain, barring what has - been specified in the excluded_domains property. - preserveLength: - type: boolean - title: preserve_length - description: >- - Whether or not to preserve the original length of the email. This - causes the transformed email to retain the original length. - excludedDomains: - type: array - items: - type: string - title: excluded_domains - description: >- - A lsit of email domains that should be excluded. This changes based - on the preserve_domain flag. See the docs for more details. - emailType: - allOf: - - title: email_type - description: >- - Optionally specify the type of email to generate. The types - specified determine the contents on the left side of the @. - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmailType' - invalidEmailAction: - allOf: - - title: invalid_email_action - description: >- - Optionally specify an action in the result of an invalid email. - An invalid email is one that does not conform to RFC 5322. - - $ref: '#/components/schemas/mgmt.v1alpha1.InvalidEmailAction' - title: TransformEmail - additionalProperties: false - mgmt.v1alpha1.TransformFirstName: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformFirstName - additionalProperties: false - mgmt.v1alpha1.TransformFloat64: - type: object - properties: - randomizationRangeMin: - oneOf: - - type: string - - type: number - title: randomization_range_min - randomizationRangeMax: - oneOf: - - type: string - - type: number - title: randomization_range_max - title: TransformFloat64 - additionalProperties: false - mgmt.v1alpha1.TransformFullName: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformFullName - additionalProperties: false - mgmt.v1alpha1.TransformInt64: - type: object - properties: - randomizationRangeMin: - oneOf: - - type: string - - type: number - title: randomization_range_min - randomizationRangeMax: - oneOf: - - type: string - - type: number - title: randomization_range_max - title: TransformInt64 - additionalProperties: false - mgmt.v1alpha1.TransformInt64PhoneNumber: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformInt64PhoneNumber - additionalProperties: false - mgmt.v1alpha1.TransformJavascript: - type: object - properties: - code: - type: string - title: code - title: TransformJavascript - additionalProperties: false - mgmt.v1alpha1.TransformLastName: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformLastName - additionalProperties: false - mgmt.v1alpha1.TransformPhoneNumber: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformPhoneNumber - additionalProperties: false - mgmt.v1alpha1.TransformPiiText: - type: object - properties: - scoreThreshold: - type: number - title: score_threshold - description: Minimal detection score for determining PII. 0.0-1.0 - defaultAnonymizer: - allOf: - - title: default_anonymizer - description: >- - The default anonmyization config used for all instances of - detected PII. - - $ref: '#/components/schemas/mgmt.v1alpha1.PiiAnonymizer' - denyRecognizers: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.PiiDenyRecognizer' - title: deny_recognizers - description: Configure deny lists where each word is treated as PII. - title: TransformPiiText - additionalProperties: false - description: NeosyncCloud/Enterprise only transformer for anonymizing PII Text - mgmt.v1alpha1.TransformString: - type: object - properties: - preserveLength: - type: boolean - title: preserve_length - title: TransformString - additionalProperties: false - mgmt.v1alpha1.TransformerConfig: - type: object - allOf: - - anyOf: - - required: - - generateBoolConfig - - required: - - generateCardNumberConfig - - required: - - generateCategoricalConfig - - required: - - generateCityConfig - - required: - - generateCountryConfig - - required: - - generateDefaultConfig - - required: - - generateE164PhoneNumberConfig - - required: - - generateEmailConfig - - required: - - generateFirstNameConfig - - required: - - generateFloat64Config - - required: - - generateFullAddressConfig - - required: - - generateFullNameConfig - - required: - - generateGenderConfig - - required: - - generateInt64Config - - required: - - generateInt64PhoneNumberConfig - - required: - - generateJavascriptConfig - - required: - - generateLastNameConfig - - required: - - generateSha256hashConfig - - required: - - generateSsnConfig - - required: - - generateStateConfig - - required: - - generateStreetAddressConfig - - required: - - generateStringConfig - - required: - - generateStringPhoneNumberConfig - - required: - - generateUnixtimestampConfig - - required: - - generateUsernameConfig - - required: - - generateUtctimestampConfig - - required: - - generateUuidConfig - - required: - - generateZipcodeConfig - - required: - - nullconfig - - required: - - passthroughConfig - - required: - - transformCharacterScrambleConfig - - required: - - transformE164PhoneNumberConfig - - required: - - transformEmailConfig - - required: - - transformFirstNameConfig - - required: - - transformFloat64Config - - required: - - transformFullNameConfig - - required: - - transformInt64Config - - required: - - transformInt64PhoneNumberConfig - - required: - - transformJavascriptConfig - - required: - - transformLastNameConfig - - required: - - transformPhoneNumberConfig - - required: - - transformPiiTextConfig - - required: - - transformStringConfig - - required: - - userDefinedTransformerConfig - - not: - anyOf: - - required: - - generateBoolConfig - - required: - - generateCardNumberConfig - - required: - - generateCategoricalConfig - - required: - - generateCityConfig - - required: - - generateCountryConfig - - required: - - generateDefaultConfig - - required: - - generateE164PhoneNumberConfig - - required: - - generateEmailConfig - - required: - - generateFirstNameConfig - - required: - - generateFloat64Config - - required: - - generateFullAddressConfig - - required: - - generateFullNameConfig - - required: - - generateGenderConfig - - required: - - generateInt64Config - - required: - - generateInt64PhoneNumberConfig - - required: - - generateJavascriptConfig - - required: - - generateLastNameConfig - - required: - - generateSha256hashConfig - - required: - - generateSsnConfig - - required: - - generateStateConfig - - required: - - generateStreetAddressConfig - - required: - - generateStringConfig - - required: - - generateStringPhoneNumberConfig - - required: - - generateUnixtimestampConfig - - required: - - generateUsernameConfig - - required: - - generateUtctimestampConfig - - required: - - generateUuidConfig - - required: - - generateZipcodeConfig - - required: - - nullconfig - - required: - - passthroughConfig - - required: - - transformCharacterScrambleConfig - - required: - - transformE164PhoneNumberConfig - - required: - - transformEmailConfig - - required: - - transformFirstNameConfig - - required: - - transformFloat64Config - - required: - - transformFullNameConfig - - required: - - transformInt64Config - - required: - - transformInt64PhoneNumberConfig - - required: - - transformJavascriptConfig - - required: - - transformLastNameConfig - - required: - - transformPhoneNumberConfig - - required: - - transformPiiTextConfig - - required: - - transformStringConfig - - required: - - userDefinedTransformerConfig - anyOf: - - required: - - generateBoolConfig - - required: - - generateCardNumberConfig - - required: - - generateCategoricalConfig - - required: - - generateCityConfig - - required: - - generateCountryConfig - - required: - - generateDefaultConfig - - required: - - generateE164PhoneNumberConfig - - required: - - generateEmailConfig - - required: - - generateFirstNameConfig - - required: - - generateFloat64Config - - required: - - generateFullAddressConfig - - required: - - generateFullNameConfig - - required: - - generateGenderConfig - - required: - - generateInt64Config - - required: - - generateInt64PhoneNumberConfig - - required: - - generateJavascriptConfig - - required: - - generateLastNameConfig - - required: - - generateSha256hashConfig - - required: - - generateSsnConfig - - required: - - generateStateConfig - - required: - - generateStreetAddressConfig - - required: - - generateStringConfig - - required: - - generateStringPhoneNumberConfig - - required: - - generateUnixtimestampConfig - - required: - - generateUsernameConfig - - required: - - generateUtctimestampConfig - - required: - - generateUuidConfig - - required: - - generateZipcodeConfig - - required: - - nullconfig - - required: - - passthroughConfig - - required: - - transformCharacterScrambleConfig - - required: - - transformE164PhoneNumberConfig - - required: - - transformEmailConfig - - required: - - transformFirstNameConfig - - required: - - transformFloat64Config - - required: - - transformFullNameConfig - - required: - - transformInt64Config - - required: - - transformInt64PhoneNumberConfig - - required: - - transformJavascriptConfig - - required: - - transformLastNameConfig - - required: - - transformPhoneNumberConfig - - required: - - transformPiiTextConfig - - required: - - transformStringConfig - - required: - - userDefinedTransformerConfig - - not: - anyOf: - - required: - - generateBoolConfig - - required: - - generateCardNumberConfig - - required: - - generateCategoricalConfig - - required: - - generateCityConfig - - required: - - generateCountryConfig - - required: - - generateDefaultConfig - - required: - - generateE164PhoneNumberConfig - - required: - - generateEmailConfig - - required: - - generateFirstNameConfig - - required: - - generateFloat64Config - - required: - - generateFullAddressConfig - - required: - - generateFullNameConfig - - required: - - generateGenderConfig - - required: - - generateInt64Config - - required: - - generateInt64PhoneNumberConfig - - required: - - generateJavascriptConfig - - required: - - generateLastNameConfig - - required: - - generateSha256hashConfig - - required: - - generateSsnConfig - - required: - - generateStateConfig - - required: - - generateStreetAddressConfig - - required: - - generateStringConfig - - required: - - generateStringPhoneNumberConfig - - required: - - generateUnixtimestampConfig - - required: - - generateUsernameConfig - - required: - - generateUtctimestampConfig - - required: - - generateUuidConfig - - required: - - generateZipcodeConfig - - required: - - nullconfig - - required: - - passthroughConfig - - required: - - transformCharacterScrambleConfig - - required: - - transformE164PhoneNumberConfig - - required: - - transformEmailConfig - - required: - - transformFirstNameConfig - - required: - - transformFloat64Config - - required: - - transformFullNameConfig - - required: - - transformInt64Config - - required: - - transformInt64PhoneNumberConfig - - required: - - transformJavascriptConfig - - required: - - transformLastNameConfig - - required: - - transformPhoneNumberConfig - - required: - - transformPiiTextConfig - - required: - - transformStringConfig - - required: - - userDefinedTransformerConfig - properties: - generateEmailConfig: - allOf: - - title: generate_email_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateEmail' - transformEmailConfig: - allOf: - - title: transform_email_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformEmail' - generateBoolConfig: - allOf: - - title: generate_bool_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateBool' - generateCardNumberConfig: - allOf: - - title: generate_card_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCardNumber' - generateCityConfig: - allOf: - - title: generate_city_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCity' - generateE164PhoneNumberConfig: - allOf: - - title: generate_e164_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateE164PhoneNumber' - generateFirstNameConfig: - allOf: - - title: generate_first_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFirstName' - generateFloat64Config: - allOf: - - title: generate_float64_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFloat64' - generateFullAddressConfig: - allOf: - - title: generate_full_address_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFullAddress' - generateFullNameConfig: - allOf: - - title: generate_full_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateFullName' - generateGenderConfig: - allOf: - - title: generate_gender_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateGender' - generateInt64PhoneNumberConfig: - allOf: - - title: generate_int64_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateInt64PhoneNumber' - generateInt64Config: - allOf: - - title: generate_int64_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateInt64' - generateLastNameConfig: - allOf: - - title: generate_last_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateLastName' - generateSha256hashConfig: - allOf: - - title: generate_sha256hash_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSha256Hash' - generateSsnConfig: - allOf: - - title: generate_ssn_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSSN' - generateStateConfig: - allOf: - - title: generate_state_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateState' - generateStreetAddressConfig: - allOf: - - title: generate_street_address_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateStreetAddress' - generateStringPhoneNumberConfig: - allOf: - - title: generate_string_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateStringPhoneNumber' - generateStringConfig: - allOf: - - title: generate_string_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateString' - generateUnixtimestampConfig: - allOf: - - title: generate_unixtimestamp_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUnixTimestamp' - generateUsernameConfig: - allOf: - - title: generate_username_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUsername' - generateUtctimestampConfig: - allOf: - - title: generate_utctimestamp_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUtcTimestamp' - generateUuidConfig: - allOf: - - title: generate_uuid_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateUuid' - generateZipcodeConfig: - allOf: - - title: generate_zipcode_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateZipcode' - transformE164PhoneNumberConfig: - allOf: - - title: transform_e164_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformE164PhoneNumber' - transformFirstNameConfig: - allOf: - - title: transform_first_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFirstName' - transformFloat64Config: - allOf: - - title: transform_float64_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFloat64' - transformFullNameConfig: - allOf: - - title: transform_full_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformFullName' - transformInt64PhoneNumberConfig: - allOf: - - title: transform_int64_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformInt64PhoneNumber' - transformInt64Config: - allOf: - - title: transform_int64_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformInt64' - transformLastNameConfig: - allOf: - - title: transform_last_name_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformLastName' - transformPhoneNumberConfig: - allOf: - - title: transform_phone_number_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPhoneNumber' - transformStringConfig: - allOf: - - title: transform_string_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformString' - passthroughConfig: - allOf: - - title: passthrough_config - - $ref: '#/components/schemas/mgmt.v1alpha1.Passthrough' - nullconfig: - allOf: - - title: nullconfig - - $ref: '#/components/schemas/mgmt.v1alpha1.Null' - userDefinedTransformerConfig: - allOf: - - title: user_defined_transformer_config - - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformerConfig' - generateDefaultConfig: - allOf: - - title: generate_default_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateDefault' - transformJavascriptConfig: - allOf: - - title: transform_javascript_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformJavascript' - generateCategoricalConfig: - allOf: - - title: generate_categorical_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCategorical' - transformCharacterScrambleConfig: - allOf: - - title: transform_character_scramble_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformCharacterScramble' - generateJavascriptConfig: - allOf: - - title: generate_javascript_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateJavascript' - generateCountryConfig: - allOf: - - title: generate_country_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateCountry' - transformPiiTextConfig: - allOf: - - title: transform_pii_text_config - description: >- - NeosyncCloud/Enterprise only transformer for anonymizing PII - Text - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformPiiText' - title: TransformerConfig - additionalProperties: false - mgmt.v1alpha1.TransformerMapping: - type: object - properties: - expression: - type: string - title: expression - description: JQ Expression or Field Path to apply the transformation to - transformer: - allOf: - - title: transformer - description: Configuration of Transformer to apply - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - title: TransformerMapping - required: - - expression - - transformer - - transformer - additionalProperties: false - mgmt.v1alpha1.UserDefinedTransformerConfig: - type: object - properties: - id: - type: string - title: id - format: uuid - title: UserDefinedTransformerConfig - additionalProperties: false - connect-protocol-version: - type: number - title: Connect-Protocol-Version - enum: - - 1 - description: Define the version of the Connect protocol - const: 1 - connect-timeout-header: - type: number - title: Connect-Timeout-Ms - description: Define the timeout, in ms - connect.error: - type: object - properties: - code: - type: string - examples: - - CodeNotFound - enum: - - CodeCanceled - - CodeUnknown - - CodeInvalidArgument - - CodeDeadlineExceeded - - CodeNotFound - - CodeAlreadyExists - - CodePermissionDenied - - CodeResourceExhausted - - CodeFailedPrecondition - - CodeAborted - - CodeOutOfRange - - CodeInternal - - CodeUnavailable - - CodeDataLoss - - CodeUnauthenticated - description: >- - The status code, which should be an enum value of - [google.rpc.Code][google.rpc.Code]. - message: - type: string - description: >- - A developer-facing error message, which should be in English. Any - user-facing error message should be localized and sent in the - [google.rpc.Status.details][google.rpc.Status.details] field, or - localized by the client. - detail: - $ref: '#/components/schemas/google.protobuf.Any' - title: Connect Error - additionalProperties: true - description: >- - Error type returned by Connect: - https://connectrpc.com/docs/go/errors/#http-representation - google.protobuf.Any: - type: object - properties: - type: - type: string - value: - type: string - format: binary - debug: - type: object - additionalProperties: true - additionalProperties: true - description: >- - Contains an arbitrary serialized message along with a @type that - describes the type of the serialized message. - google.protobuf.Timestamp: - type: string - format: date-time - description: >- - A Timestamp represents a point in time independent of any time zone or - local - calendar, encoded as a count of seconds and fractions of seconds at - nanosecond resolution. The count is relative to an epoch at UTC midnight on - January 1, 1970, in the proleptic Gregorian calendar which extends the - Gregorian calendar backwards to year one. - - All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap - second table is needed for interpretation, using a [24-hour linear - smear](https://developers.google.com/time/smear). - - The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By - restricting to that range, we ensure that we can convert to and from [RFC - 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. - - # Examples - - Example 1: Compute Timestamp from POSIX `time()`. - - Timestamp timestamp; - timestamp.set_seconds(time(NULL)); - timestamp.set_nanos(0); - - Example 2: Compute Timestamp from POSIX `gettimeofday()`. - - struct timeval tv; - gettimeofday(&tv, NULL); - - Timestamp timestamp; - timestamp.set_seconds(tv.tv_sec); - timestamp.set_nanos(tv.tv_usec * 1000); - - Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - - FILETIME ft; - GetSystemTimeAsFileTime(&ft); - UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; - - // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z - // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. - Timestamp timestamp; - timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - - Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - - long millis = System.currentTimeMillis(); - - Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) - .setNanos((int) ((millis % 1000) * 1000000)).build(); - - Example 5: Compute Timestamp from Java `Instant.now()`. - - Instant now = Instant.now(); - - Timestamp timestamp = - Timestamp.newBuilder().setSeconds(now.getEpochSecond()) - .setNanos(now.getNano()).build(); - - Example 6: Compute Timestamp from current time in Python. - - timestamp = Timestamp() - timestamp.GetCurrentTime() - - # JSON Mapping - - In JSON format, the Timestamp type is encoded as a string in the - [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the - format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" - where {year} is always expressed using four digits while {month}, {day}, - {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional - seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), - are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone - is required. A proto3 JSON serializer should always use UTC (as indicated by - "Z") when printing the Timestamp type and a proto3 JSON parser should be - able to accept both UTC and other timezones (as indicated by an offset). - - For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past - 01:30 UTC on January 15, 2017. - - In JavaScript, one can convert a Date object to this format using the - standard - [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) - method. In Python, a standard `datetime.datetime` object can be converted - to this format using - [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with - the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use - the Joda Time's [`ISODateTimeFormat.dateTime()`]( - http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() - ) to obtain a formatter capable of generating timestamps in this format. - mgmt.v1alpha1.AccountApiKey: - type: object - allOf: - - anyOf: - - required: - - keyValue - - not: - anyOf: - - required: - - keyValue - anyOf: - - required: - - keyValue - - not: - anyOf: - - required: - - keyValue - properties: - id: - type: string - title: id - name: - type: string - title: name - description: The friendly name of the API Key - accountId: - type: string - title: account_id - createdById: - type: string - title: created_by_id - createdAt: - allOf: - - title: created_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - updatedById: - type: string - title: updated_by_id - updatedAt: - allOf: - - title: updated_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - keyValue: - type: string - title: key_value - description: >- - key_value is only returned on initial creation or when it is - regenerated - userId: - type: string - title: user_id - expiresAt: - allOf: - - title: expires_at - description: >- - The timestamp of what the API key expires and will not longer be - usable. - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: AccountApiKey - additionalProperties: false - mgmt.v1alpha1.CreateAccountApiKeyRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - expiresAt: - allOf: - - title: expires_at - description: 'Validate between now and one year: now < x < 365 days' - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: CreateAccountApiKeyRequest - required: - - expiresAt - - expiresAt - additionalProperties: false - mgmt.v1alpha1.CreateAccountApiKeyResponse: - type: object - properties: - apiKey: - allOf: - - title: api_key - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' - title: CreateAccountApiKeyResponse - additionalProperties: false - mgmt.v1alpha1.DeleteAccountApiKeyRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: DeleteAccountApiKeyRequest - additionalProperties: false - mgmt.v1alpha1.DeleteAccountApiKeyResponse: - type: object - title: DeleteAccountApiKeyResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountApiKeyRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: GetAccountApiKeyRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountApiKeyResponse: - type: object - properties: - apiKey: - allOf: - - title: api_key - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' - title: GetAccountApiKeyResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountApiKeysRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountApiKeysRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountApiKeysResponse: - type: object - properties: - apiKeys: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' - title: api_keys - title: GetAccountApiKeysResponse - additionalProperties: false - mgmt.v1alpha1.RegenerateAccountApiKeyRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - expiresAt: - allOf: - - title: expires_at - description: 'Validate between now and one year: now < x < 365 days' - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: RegenerateAccountApiKeyRequest - required: - - expiresAt - - expiresAt - additionalProperties: false - mgmt.v1alpha1.RegenerateAccountApiKeyResponse: - type: object - properties: - apiKey: - allOf: - - title: api_key - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountApiKey' - title: RegenerateAccountApiKeyResponse - additionalProperties: false - mgmt.v1alpha1.AccessToken: - type: object - allOf: - - anyOf: - - required: - - idToken - - not: - anyOf: - - required: - - idToken - - anyOf: - - required: - - refreshToken - - not: - anyOf: - - required: - - refreshToken - properties: - accessToken: - type: string - title: access_token - description: >- - The access token that will be provided in subsequent requests to - provide authenticated access to the Api - refreshToken: - type: string - title: refresh_token - description: |- - Token that can be used to retrieve a refreshed access token. - Will not be provided if the offline_access scope is not provided in the initial login flow. - expiresIn: - oneOf: - - type: string - - type: number - title: expires_in - description: >- - Relative time in seconds that the access token will expire. Combine - with the current time to get the expires_at time. - scope: - type: string - title: scope - description: The scopes that the access token have - idToken: - type: string - title: id_token - description: The identity token of the authenticated user - tokenType: - type: string - title: token_type - description: The token type. For JWTs, this will be `Bearer` - title: AccessToken - additionalProperties: false - description: A decoded representation of an Access token from the backing auth server - mgmt.v1alpha1.CheckTokenRequest: - type: object - title: CheckTokenRequest - additionalProperties: false - mgmt.v1alpha1.CheckTokenResponse: - type: object - title: CheckTokenResponse - additionalProperties: false - mgmt.v1alpha1.GetAuthStatusRequest: - type: object - title: GetAuthStatusRequest - additionalProperties: false - mgmt.v1alpha1.GetAuthStatusResponse: - type: object - properties: - isEnabled: - type: boolean - title: is_enabled - description: |- - Whether or not the server has authentication enabled. - This tells the client if it is expected to send access tokens. - title: GetAuthStatusResponse - additionalProperties: false - mgmt.v1alpha1.GetAuthorizeUrlRequest: - type: object - properties: - state: - type: string - title: state - minLength: 1 - description: >- - The state that's generated by the client that is passed along to - prevent tampering - redirectUri: - type: string - title: redirect_uri - minLength: 1 - description: >- - The redirect uri that the client will be redirected back to during - the auth request - scope: - type: string - title: scope - minLength: 1 - description: >- - The scopes the client is requesting as a part of the oauth login - request - title: GetAuthorizeUrlRequest - additionalProperties: false - mgmt.v1alpha1.GetAuthorizeUrlResponse: - type: object - properties: - url: - type: string - title: url - description: >- - The generated url that is the client will be redirected to during - the Oauth flow - title: GetAuthorizeUrlResponse - additionalProperties: false - mgmt.v1alpha1.GetCliIssuerRequest: - type: object - title: GetCliIssuerRequest - additionalProperties: false - mgmt.v1alpha1.GetCliIssuerResponse: - type: object - properties: - issuerUrl: - type: string - title: issuer_url - description: The backing authentication issuer url - audience: - type: string - title: audience - description: >- - The audience that will be used in the access token. This corresponds - to the "aud" claim - title: GetCliIssuerResponse - additionalProperties: false - mgmt.v1alpha1.LoginCliRequest: - type: object - properties: - code: - type: string - title: code - minLength: 1 - description: The oauth code - redirectUri: - type: string - title: redirect_uri - minLength: 1 - description: The oauth redirect uri that the client uses during the oauth request - title: LoginCliRequest - additionalProperties: false - mgmt.v1alpha1.LoginCliResponse: - type: object - properties: - accessToken: - allOf: - - title: access_token - description: The access token that is returned on successful login - - $ref: '#/components/schemas/mgmt.v1alpha1.AccessToken' - title: LoginCliResponse - additionalProperties: false - mgmt.v1alpha1.RefreshCliRequest: - type: object - properties: - refreshToken: - type: string - title: refresh_token - minLength: 1 - description: The token used to retrieve a new access token. - title: RefreshCliRequest - additionalProperties: false - mgmt.v1alpha1.RefreshCliResponse: - type: object - properties: - accessToken: - allOf: - - title: access_token - description: The access token that is returned on successful refresh - - $ref: '#/components/schemas/mgmt.v1alpha1.AccessToken' - title: RefreshCliResponse - additionalProperties: false - mgmt.v1alpha1.AwsS3ConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - credentials - - not: - anyOf: - - required: - - credentials - - anyOf: - - required: - - endpoint - - not: - anyOf: - - required: - - endpoint - - anyOf: - - required: - - pathPrefix - - not: - anyOf: - - required: - - pathPrefix - - anyOf: - - required: - - region - - not: - anyOf: - - required: - - region - properties: - bucketArn: - type: string - title: bucket_arn - pathPrefix: - type: string - title: path_prefix - credentials: - allOf: - - title: credentials - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3Credentials' - region: - type: string - title: region - endpoint: - type: string - title: endpoint - bucket: - type: string - title: bucket - minLength: 1 - title: AwsS3ConnectionConfig - additionalProperties: false - mgmt.v1alpha1.AwsS3Credentials: - type: object - allOf: - - anyOf: - - required: - - accessKeyId - - not: - anyOf: - - required: - - accessKeyId - - anyOf: - - required: - - fromEc2Role - - not: - anyOf: - - required: - - fromEc2Role - - anyOf: - - required: - - profile - - not: - anyOf: - - required: - - profile - - anyOf: - - required: - - roleArn - - not: - anyOf: - - required: - - roleArn - - anyOf: - - required: - - roleExternalId - - not: - anyOf: - - required: - - roleExternalId - - anyOf: - - required: - - secretAccessKey - - not: - anyOf: - - required: - - secretAccessKey - - anyOf: - - required: - - sessionToken - - not: - anyOf: - - required: - - sessionToken - properties: - profile: - type: string - title: profile - accessKeyId: - type: string - title: access_key_id - secretAccessKey: - type: string - title: secret_access_key - sessionToken: - type: string - title: session_token - fromEc2Role: - type: boolean - title: from_ec2_role - roleArn: - type: string - title: role_arn - roleExternalId: - type: string - title: role_external_id - title: AwsS3Credentials - additionalProperties: false - description: |- - S3 Credentials that are used by the worker process. - Note: this may be optionally provided if the worker that is being hosted has environment credentials to the S3 bucket instead. - mgmt.v1alpha1.CheckConnectionConfigByIdRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - description: The connection id to validate - title: CheckConnectionConfigByIdRequest - additionalProperties: false - mgmt.v1alpha1.CheckConnectionConfigByIdResponse: - type: object - allOf: - - anyOf: - - required: - - connectionError - - not: - anyOf: - - required: - - connectionError - anyOf: - - required: - - connectionError - - not: - anyOf: - - required: - - connectionError - properties: - isConnected: - type: boolean - title: is_connected - description: Whether or not the API was able to ping the connection - connectionError: - type: string - title: connection_error - description: This is the error that was received if the API was unable to connect - privileges: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionRolePrivilege' - title: privileges - description: The privileges the role has to the connection - title: CheckConnectionConfigByIdResponse - additionalProperties: false - mgmt.v1alpha1.CheckConnectionConfigRequest: - type: object - properties: - connectionConfig: - allOf: - - title: connection_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' - title: CheckConnectionConfigRequest - additionalProperties: false - mgmt.v1alpha1.CheckConnectionConfigResponse: - type: object - allOf: - - anyOf: - - required: - - connectionError - - not: - anyOf: - - required: - - connectionError - anyOf: - - required: - - connectionError - - not: - anyOf: - - required: - - connectionError - properties: - isConnected: - type: boolean - title: is_connected - description: Whether or not the API was able to ping the connection - connectionError: - type: string - title: connection_error - description: This is the error that was received if the API was unable to connect - privileges: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionRolePrivilege' - title: privileges - title: CheckConnectionConfigResponse - additionalProperties: false - mgmt.v1alpha1.CheckSqlQueryRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - description: The connection id that the query will be checked against - query: - type: string - title: query - minLength: 1 - description: The full query that will be run through a PREPARE statement - title: CheckSqlQueryRequest - additionalProperties: false - mgmt.v1alpha1.CheckSqlQueryResponse: - type: object - allOf: - - anyOf: - - required: - - erorrMessage - - not: - anyOf: - - required: - - erorrMessage - anyOf: - - required: - - erorrMessage - - not: - anyOf: - - required: - - erorrMessage - properties: - isValid: - type: boolean - title: is_valid - description: >- - The query is run through PREPARE. Returns valid if it correctly - compiled - erorrMessage: - type: string - title: erorr_message - description: >- - The error message returned by the sql client if the prepare did not - return successfully - title: CheckSqlQueryResponse - additionalProperties: false - mgmt.v1alpha1.ClientTlsConfig: - type: object - allOf: - - anyOf: - - required: - - clientCert - - not: - anyOf: - - required: - - clientCert - - anyOf: - - required: - - clientKey - - not: - anyOf: - - required: - - clientKey - - anyOf: - - required: - - rootCert - - not: - anyOf: - - required: - - rootCert - properties: - rootCert: - type: string - title: root_cert - description: Root Certificate in PEM Format - clientCert: - type: string - title: client_cert - description: Client Certificate in PEM format. Must also provide key. - clientKey: - type: string - title: client_key - description: Client Key in PEM format. Must also provide cert. - title: ClientTlsConfig - additionalProperties: false - description: Config for providing client-side TLS certificates - mgmt.v1alpha1.Connection: - type: object - properties: - id: - type: string - title: id - description: The unique identifier of the connection - name: - type: string - title: name - description: The unique, friendly name of the connection - connectionConfig: - allOf: - - title: connection_config - description: Contains the connection configuration and connection type - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' - createdByUserId: - type: string - title: created_by_user_id - description: The user id of the user that created the connection - createdAt: - allOf: - - title: created_at - description: When the connection was created - - $ref: '#/components/schemas/google.protobuf.Timestamp' - updatedByUserId: - type: string - title: updated_by_user_id - description: Who last updated the connection - updatedAt: - allOf: - - title: updated_at - description: When the connection was last updated - - $ref: '#/components/schemas/google.protobuf.Timestamp' - accountId: - type: string - title: account_id - description: The unique account that owns this connection - title: Connection - additionalProperties: false - mgmt.v1alpha1.ConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - localDirConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - openaiConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - localDirConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - openaiConfig - - required: - - pgConfig - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - localDirConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - openaiConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - localDirConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - openaiConfig - - required: - - pgConfig - properties: - pgConfig: - allOf: - - title: pg_config - description: Configures a PostgreSQL connection - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresConnectionConfig' - awsS3Config: - allOf: - - title: aws_s3_config - description: Configures an AWS S3 Connection - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3ConnectionConfig' - mysqlConfig: - allOf: - - title: mysql_config - description: Configures a MySQL connection - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlConnectionConfig' - localDirConfig: - allOf: - - title: local_dir_config - description: >- - Configures a connection to a directory available on the local - file system - - $ref: >- - #/components/schemas/mgmt.v1alpha1.LocalDirectoryConnectionConfig - openaiConfig: - allOf: - - title: openai_config - description: Connection config for an OpenAI (or compatible) Connection - - $ref: '#/components/schemas/mgmt.v1alpha1.OpenAiConnectionConfig' - mongoConfig: - allOf: - - title: mongo_config - description: Configures a MongoDB Connection - - $ref: '#/components/schemas/mgmt.v1alpha1.MongoConnectionConfig' - gcpCloudstorageConfig: - allOf: - - title: gcp_cloudstorage_config - description: Configures a GCP Cloud Storage Connection - - $ref: >- - #/components/schemas/mgmt.v1alpha1.GcpCloudStorageConnectionConfig - dynamodbConfig: - allOf: - - title: dynamodb_config - description: Configures a DynamoDB Connection - - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBConnectionConfig' - mssqlConfig: - allOf: - - title: mssql_config - description: Configures a Microsoft SQL Server (mssql) Connection - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlConnectionConfig' - title: ConnectionConfig - additionalProperties: false - description: Configuration for all of the supported Neosync connection types - mgmt.v1alpha1.ConnectionRolePrivilege: - type: object - properties: - grantee: - type: string - title: grantee - description: The role that was given the permissions - schema: - type: string - title: schema - description: 'The database schema. Ex: public' - table: - type: string - title: table - description: The name of the table in the schema - privilegeType: - type: array - items: - type: string - title: privilege_type - description: The privileges given to that role - title: ConnectionRolePrivilege - additionalProperties: false - mgmt.v1alpha1.CreateConnectionRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - description: The friendly name of the connection - connectionConfig: - allOf: - - title: connection_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' - title: CreateConnectionRequest - additionalProperties: false - mgmt.v1alpha1.CreateConnectionResponse: - type: object - properties: - connection: - allOf: - - title: connection - - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' - title: CreateConnectionResponse - additionalProperties: false - mgmt.v1alpha1.DeleteConnectionRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: DeleteConnectionRequest - additionalProperties: false - mgmt.v1alpha1.DeleteConnectionResponse: - type: object - title: DeleteConnectionResponse - additionalProperties: false - mgmt.v1alpha1.DynamoDBConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - credentials - - not: - anyOf: - - required: - - credentials - - anyOf: - - required: - - endpoint - - not: - anyOf: - - required: - - endpoint - - anyOf: - - required: - - region - - not: - anyOf: - - required: - - region - properties: - credentials: - allOf: - - title: credentials - description: >- - Optional credentials that may be provided and will be used to - connect to the DynamoDB Instance. - If self-hosting, this may be provided by the environment in lieu of specifying these here - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3Credentials' - region: - type: string - title: region - description: >- - Optionally specify the region that the dynamodb instance lives in if - not provided by the environment. - endpoint: - type: string - title: endpoint - description: Optionally specify the endpoint that will be used by the AWS SDK. - title: DynamoDBConnectionConfig - additionalProperties: false - description: Configuration for a DynaomDB Connection - mgmt.v1alpha1.GcpCloudStorageConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - pathPrefix - - not: - anyOf: - - required: - - pathPrefix - - anyOf: - - required: - - serviceAccountCredentials - - not: - anyOf: - - required: - - serviceAccountCredentials - properties: - bucket: - type: string - title: bucket - minLength: 1 - description: The GCP Cloud Storage bucket that will be accessed. - pathPrefix: - type: string - title: path_prefix - description: The path prefix that will be appended to each file - serviceAccountCredentials: - type: string - title: service_account_credentials - description: stringified json of the service account credentials file - title: GcpCloudStorageConnectionConfig - additionalProperties: false - description: Configuration for GCP Cloud Storage Buckets - mgmt.v1alpha1.GetConnectionRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: GetConnectionRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionResponse: - type: object - properties: - connection: - allOf: - - title: connection - - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' - title: GetConnectionResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionsRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetConnectionsRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionsResponse: - type: object - properties: - connections: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' - title: connections - title: GetConnectionsResponse - additionalProperties: false - mgmt.v1alpha1.IsConnectionNameAvailableRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - connectionName: - type: string - title: connection_name - pattern: ^[a-z0-9-]{3,100}$ - title: IsConnectionNameAvailableRequest - additionalProperties: false - mgmt.v1alpha1.IsConnectionNameAvailableResponse: - type: object - properties: - isAvailable: - type: boolean - title: is_available - title: IsConnectionNameAvailableResponse - additionalProperties: false - mgmt.v1alpha1.LocalDirectoryConnectionConfig: - type: object - properties: - path: - type: string - title: path - minLength: 1 - description: >- - The absolute path to a directory that is available on the local file - system to the API and Worker nodes - title: LocalDirectoryConnectionConfig - additionalProperties: false - description: >- - Configures a connection to a directory available on the local file - system - mgmt.v1alpha1.MongoConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - url - - not: - anyOf: - - required: - - url - anyOf: - - required: - - url - - not: - anyOf: - - required: - - url - properties: - url: - type: string - title: url - description: The full mongo connection url - tunnel: - allOf: - - title: tunnel - description: >- - Provide tunnel configuration that can be used to access a - connection that is not publicly accessible to the internet - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' - clientTls: - allOf: - - title: client_tls - description: Provide client-side TLS Certificates - - $ref: '#/components/schemas/mgmt.v1alpha1.ClientTlsConfig' - title: MongoConnectionConfig - additionalProperties: false - mgmt.v1alpha1.MssqlConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - url - - not: - anyOf: - - required: - - url - anyOf: - - required: - - url - - not: - anyOf: - - required: - - url - properties: - url: - type: string - title: url - description: The URL with sqlserver scheme. - connectionOptions: - allOf: - - title: connection_options - - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' - tunnel: - allOf: - - title: tunnel - description: >- - Provide tunnel configuration that can be used to access a - postgres connection that is not publicly accessible to the - internet - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' - title: MssqlConnectionConfig - additionalProperties: false - description: Configuration for a Mssql Connection - mgmt.v1alpha1.MysqlConnection: - type: object - properties: - user: - type: string - title: user - pass: - type: string - title: pass - protocol: - type: string - title: protocol - host: - type: string - title: host - port: - type: integer - title: port - name: - type: string - title: name - title: MysqlConnection - additionalProperties: false - mgmt.v1alpha1.MysqlConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - connection - - required: - - url - - not: - anyOf: - - required: - - connection - - required: - - url - anyOf: - - required: - - connection - - required: - - url - - not: - anyOf: - - required: - - connection - - required: - - url - properties: - url: - type: string - title: url - connection: - allOf: - - title: connection - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlConnection' - tunnel: - allOf: - - title: tunnel - description: >- - Provide tunnel configuration that can be used to access a - postgres connection that is not publicly accessible to the - internet - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' - connectionOptions: - allOf: - - title: connection_options - - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' - title: MysqlConnectionConfig - additionalProperties: false - mgmt.v1alpha1.OpenAiConnectionConfig: - type: object - properties: - apiKey: - type: string - title: api_key - description: OpenAI Api Key - apiUrl: - type: string - title: api_url - description: OpenAI URL - title: OpenAiConnectionConfig - additionalProperties: false - description: Configures a connection to OpenAI or OpenAI compatible API. - mgmt.v1alpha1.PostgresConnection: - type: object - allOf: - - anyOf: - - required: - - sslMode - - not: - anyOf: - - required: - - sslMode - anyOf: - - required: - - sslMode - - not: - anyOf: - - required: - - sslMode - properties: - host: - type: string - title: host - port: - type: integer - title: port - name: - type: string - title: name - user: - type: string - title: user - pass: - type: string - title: pass - sslMode: - type: string - title: ssl_mode - title: PostgresConnection - additionalProperties: false - mgmt.v1alpha1.PostgresConnectionConfig: - type: object - allOf: - - anyOf: - - required: - - connection - - required: - - url - - not: - anyOf: - - required: - - connection - - required: - - url - anyOf: - - required: - - connection - - required: - - url - - not: - anyOf: - - required: - - connection - - required: - - url - properties: - url: - type: string - title: url - connection: - allOf: - - title: connection - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresConnection' - tunnel: - allOf: - - title: tunnel - description: >- - Provide tunnel configuration that can be used to access a - postgres connection that is not publicly accessible to the - internet - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHTunnel' - connectionOptions: - allOf: - - title: connection_options - - $ref: '#/components/schemas/mgmt.v1alpha1.SqlConnectionOptions' - clientTls: - allOf: - - title: client_tls - description: Provide client-side TLS Certificates - - $ref: '#/components/schemas/mgmt.v1alpha1.ClientTlsConfig' - title: PostgresConnectionConfig - additionalProperties: false - mgmt.v1alpha1.SSHAuthentication: - type: object - allOf: - - anyOf: - - required: - - passphrase - - required: - - privateKey - - not: - anyOf: - - required: - - passphrase - - required: - - privateKey - anyOf: - - required: - - passphrase - - required: - - privateKey - - not: - anyOf: - - required: - - passphrase - - required: - - privateKey - properties: - passphrase: - allOf: - - title: passphrase - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHPassphrase' - privateKey: - allOf: - - title: private_key - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHPrivateKey' - title: SSHAuthentication - additionalProperties: false - description: SSH Authentication - mgmt.v1alpha1.SSHPassphrase: - type: object - properties: - value: - type: string - title: value - minLength: 1 - description: >- - The password to be used to connect to the SSH server eventually we - can expand this to allow pulling from other sources. - title: SSHPassphrase - additionalProperties: false - description: >- - Contains the configuration needed to retrieve the SSH passphrase for the - tunnel - mgmt.v1alpha1.SSHPrivateKey: - type: object - allOf: - - anyOf: - - required: - - passphrase - - not: - anyOf: - - required: - - passphrase - anyOf: - - required: - - passphrase - - not: - anyOf: - - required: - - passphrase - properties: - value: - type: string - title: value - minLength: 1 - description: The private key in PEM format. - passphrase: - type: string - title: passphrase - description: If the private key is encrypted, this value should decrypt it. - title: SSHPrivateKey - additionalProperties: false - description: >- - Contains the configuration needed to retrieve the SSH private key for - the tunnel - mgmt.v1alpha1.SSHTunnel: - type: object - allOf: - - anyOf: - - required: - - knownHostPublicKey - - not: - anyOf: - - required: - - knownHostPublicKey - anyOf: - - required: - - knownHostPublicKey - - not: - anyOf: - - required: - - knownHostPublicKey - properties: - host: - type: string - title: host - minLength: 1 - description: The host of the SSH server - port: - type: integer - title: port - description: The port of the SSH server, typically 22 - user: - type: string - title: user - minLength: 1 - description: The user that will be used to authenticate - knownHostPublicKey: - type: string - title: known_host_public_key - minLength: 1 - description: >- - Optionally provide the public key of the known host of the SSH - tunnel that we are connecting to. - If this is not provided, the server will blindly connect to the host with the given credentials. - This is not recommended for production use! - authentication: - allOf: - - title: authentication - description: >- - Provide the authentication required to successfully connect to - the SSH server for tunneling - - $ref: '#/components/schemas/mgmt.v1alpha1.SSHAuthentication' - title: SSHTunnel - additionalProperties: false - mgmt.v1alpha1.SqlConnectionOptions: - type: object - allOf: - - anyOf: - - required: - - maxConnectionLimit - - not: - anyOf: - - required: - - maxConnectionLimit - anyOf: - - required: - - maxConnectionLimit - - not: - anyOf: - - required: - - maxConnectionLimit - properties: - maxConnectionLimit: - type: integer - title: max_connection_limit - description: Limits the number of open connections in the pool. - title: SqlConnectionOptions - additionalProperties: false - mgmt.v1alpha1.UpdateConnectionRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - connectionConfig: - allOf: - - title: connection_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionConfig' - title: UpdateConnectionRequest - additionalProperties: false - mgmt.v1alpha1.UpdateConnectionResponse: - type: object - properties: - connection: - allOf: - - title: connection - - $ref: '#/components/schemas/mgmt.v1alpha1.Connection' - title: UpdateConnectionResponse - additionalProperties: false - google.protobuf.NullValue: - type: string - title: NullValue - enum: - - NULL_VALUE - description: >- - `NullValue` is a singleton enumeration to represent the null value for - the - `Value` type union. - - The JSON representation for `NullValue` is JSON `null`. - google.protobuf.ListValue: - type: object - properties: - values: - type: array - items: - $ref: '#/components/schemas/google.protobuf.Value' - title: values - description: Repeated field of dynamically typed values. - title: ListValue - additionalProperties: false - description: |- - `ListValue` is a wrapper around a repeated field of values. - - The JSON representation for `ListValue` is JSON array. - google.protobuf.Struct: - type: object - properties: - fields: - type: object - title: fields - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/google.protobuf.Value' - description: Unordered map of dynamically typed values. - title: Struct - additionalProperties: false - description: |- - `Struct` represents a structured data value, consisting of fields - which map to dynamically typed values. In some languages, `Struct` - might be supported by a native representation. For example, in - scripting languages like JS a struct is represented as an - object. The details of that representation are described together - with the proto support for the language. - - The JSON representation for `Struct` is JSON object. - google.protobuf.Struct.FieldsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/google.protobuf.Value' - title: FieldsEntry - additionalProperties: false - google.protobuf.Value: - oneOf: - - type: 'null' - - type: number - - type: string - - type: boolean - - type: array - - type: object - additionalProperties: true - description: |- - `Value` represents a dynamically typed value which can be either - null, a number, a string, a boolean, a recursive struct value, or a - list of values. A producer of value is expected to set one of these - variants. Absence of any variant indicates an error. - - The JSON representation for `Value` is JSON value. - mgmt.v1alpha1.AwsDynamoDBStreamConfig: - type: object - title: AwsDynamoDBStreamConfig - additionalProperties: false - mgmt.v1alpha1.AwsS3SchemaConfig: - type: object - allOf: - - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - properties: - jobId: - type: string - title: job_id - format: uuid - jobRunId: - type: string - title: job_run_id - minLength: 1 - title: AwsS3SchemaConfig - additionalProperties: false - mgmt.v1alpha1.AwsS3StreamConfig: - type: object - allOf: - - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - properties: - jobId: - type: string - title: job_id - format: uuid - jobRunId: - type: string - title: job_run_id - minLength: 1 - title: AwsS3StreamConfig - additionalProperties: false - mgmt.v1alpha1.ConnectionSchemaConfig: - type: object - allOf: - - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - pgConfig - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mongoConfig - - required: - - mssqlConfig - - required: - - mysqlConfig - - required: - - pgConfig - properties: - pgConfig: - allOf: - - title: pg_config - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSchemaConfig' - awsS3Config: - allOf: - - title: aws_s3_config - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3SchemaConfig' - mysqlConfig: - allOf: - - title: mysql_config - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSchemaConfig' - mongoConfig: - allOf: - - title: mongo_config - - $ref: '#/components/schemas/mgmt.v1alpha1.MongoSchemaConfig' - gcpCloudstorageConfig: - allOf: - - title: gcp_cloudstorage_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GcpCloudStorageSchemaConfig' - dynamodbConfig: - allOf: - - title: dynamodb_config - - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSchemaConfig' - mssqlConfig: - allOf: - - title: mssql_config - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSchemaConfig' - title: ConnectionSchemaConfig - additionalProperties: false - mgmt.v1alpha1.ConnectionStreamConfig: - type: object - allOf: - - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mysqlConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mysqlConfig - - required: - - pgConfig - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mysqlConfig - - required: - - pgConfig - - not: - anyOf: - - required: - - awsS3Config - - required: - - dynamodbConfig - - required: - - gcpCloudstorageConfig - - required: - - mysqlConfig - - required: - - pgConfig - properties: - pgConfig: - allOf: - - title: pg_config - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresStreamConfig' - awsS3Config: - allOf: - - title: aws_s3_config - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3StreamConfig' - mysqlConfig: - allOf: - - title: mysql_config - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlStreamConfig' - gcpCloudstorageConfig: - allOf: - - title: gcp_cloudstorage_config - - $ref: '#/components/schemas/mgmt.v1alpha1.GcpCloudStorageStreamConfig' - dynamodbConfig: - allOf: - - title: dynamodb_config - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsDynamoDBStreamConfig' - title: ConnectionStreamConfig - additionalProperties: false - mgmt.v1alpha1.DatabaseColumn: - type: object - allOf: - - anyOf: - - required: - - columnDefault - - not: - anyOf: - - required: - - columnDefault - - anyOf: - - required: - - generatedType - - not: - anyOf: - - required: - - generatedType - - anyOf: - - required: - - identityGeneration - - not: - anyOf: - - required: - - identityGeneration - properties: - schema: - type: string - title: schema - description: 'The database schema. Ex: public' - table: - type: string - title: table - description: The name of the table in the schema - column: - type: string - title: column - description: The name of the column - dataType: - type: string - title: data_type - description: The datatype of the column - isNullable: - type: string - title: is_nullable - description: The isNullable Flag of the column - columnDefault: - type: string - title: column_default - description: The default value of the column if available - generatedType: - type: string - title: generated_type - description: >- - Populated if the column is generated. The value is the type of - generated column it is. For example, postgres is 's' for stored - May be other values in the future, or other DB providers may use a different value types. - identityGeneration: - type: string - title: identity_generation - description: >- - Populated if the column is an identity. The value is the type of the - identity column it is. For example, postgres is 'd' for generated by - default, or 'a' for generated always. - title: DatabaseColumn - additionalProperties: false - mgmt.v1alpha1.DatabaseTable: - type: object - properties: - schema: - type: string - title: schema - minLength: 1 - table: - type: string - title: table - minLength: 1 - title: DatabaseTable - additionalProperties: false - mgmt.v1alpha1.DynamoDBSchemaConfig: - type: object - title: DynamoDBSchemaConfig - additionalProperties: false - mgmt.v1alpha1.ForeignConstraint: - type: object - properties: - column: - type: string - title: column - description: '@deprecated - use columns' - isNullable: - type: boolean - title: is_nullable - description: '@deprecated - use not_nullable' - foreignKey: - allOf: - - title: foreign_key - - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignKey' - columns: - type: array - items: - type: string - title: columns - notNullable: - type: array - items: - type: boolean - title: not_nullable - title: ForeignConstraint - additionalProperties: false - mgmt.v1alpha1.ForeignConstraintTables: - type: object - properties: - constraints: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraint' - title: constraints - title: ForeignConstraintTables - additionalProperties: false - mgmt.v1alpha1.ForeignKey: - type: object - properties: - table: - type: string - title: table - column: - type: string - title: column - description: '@deprecated - use columns' - columns: - type: array - items: - type: string - title: columns - title: ForeignKey - additionalProperties: false - mgmt.v1alpha1.GcpCloudStorageSchemaConfig: - type: object - allOf: - - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - properties: - jobId: - type: string - title: job_id - format: uuid - jobRunId: - type: string - title: job_run_id - minLength: 1 - title: GcpCloudStorageSchemaConfig - additionalProperties: false - mgmt.v1alpha1.GcpCloudStorageStreamConfig: - type: object - allOf: - - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - anyOf: - - required: - - jobId - - required: - - jobRunId - - not: - anyOf: - - required: - - jobId - - required: - - jobRunId - properties: - jobId: - type: string - title: job_id - format: uuid - jobRunId: - type: string - title: job_run_id - minLength: 1 - title: GcpCloudStorageStreamConfig - additionalProperties: false - mgmt.v1alpha1.GetAiGeneratedDataRequest: - type: object - allOf: - - anyOf: - - required: - - userPrompt - - not: - anyOf: - - required: - - userPrompt - anyOf: - - required: - - userPrompt - - not: - anyOf: - - required: - - userPrompt - properties: - aiConnectionId: - type: string - title: ai_connection_id - format: uuid - count: - oneOf: - - type: string - - type: number - title: count - maximum: 10 - minimum: 1 - modelName: - type: string - title: model_name - minLength: 1 - userPrompt: - type: string - title: user_prompt - dataConnectionId: - type: string - title: data_connection_id - format: uuid - table: - allOf: - - title: table - - $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseTable' - title: GetAiGeneratedDataRequest - additionalProperties: false - mgmt.v1alpha1.GetAiGeneratedDataResponse: - type: object - properties: - records: - type: array - items: - $ref: '#/components/schemas/google.protobuf.Struct' - title: records - description: A list of generated records - title: GetAiGeneratedDataResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionDataStreamRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - streamConfig: - allOf: - - title: stream_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionStreamConfig' - schema: - type: string - title: schema - table: - type: string - title: table - title: GetConnectionDataStreamRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionDataStreamResponse: - type: object - properties: - row: - type: object - title: row - additionalProperties: - type: string - title: value - format: byte - description: >- - A map of column name to the bytes value of the data that was found - for that column and row - title: GetConnectionDataStreamResponse - additionalProperties: false - description: Each stream response is a single row in the requested schema and table - mgmt.v1alpha1.GetConnectionDataStreamResponse.RowEntry: - type: object - properties: - key: - type: string - title: key - value: - type: string - title: value - format: byte - title: RowEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionForeignConstraintsRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - title: GetConnectionForeignConstraintsRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionForeignConstraintsResponse: - type: object - properties: - tableConstraints: - type: object - title: table_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' - description: >- - the key here is .
and the list of tables that it - depends on, also `.
` format. - title: GetConnectionForeignConstraintsResponse - additionalProperties: false - description: Dependency constraints for a specific table - mgmt.v1alpha1.GetConnectionForeignConstraintsResponse.TableConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' - title: TableConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionInitStatementsRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - options: - allOf: - - title: options - - $ref: '#/components/schemas/mgmt.v1alpha1.InitStatementOptions' - title: GetConnectionInitStatementsRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionInitStatementsResponse: - type: object - properties: - tableInitStatements: - type: object - title: table_init_statements - additionalProperties: - type: string - title: value - description: >- - the key here is .
and value is the table init - statement. - tableTruncateStatements: - type: object - title: table_truncate_statements - additionalProperties: - type: string - title: value - description: >- - the key here is .
and value is the table truncate - statement. - schemaInitStatements: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.SchemaInitStatements' - title: schema_init_statements - title: GetConnectionInitStatementsResponse - additionalProperties: false - description: Init statement for a specific table - mgmt.v1alpha1.GetConnectionInitStatementsResponse.TableInitStatementsEntry: - type: object - properties: - key: - type: string - title: key - value: - type: string - title: value - title: TableInitStatementsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionInitStatementsResponse.TableTruncateStatementsEntry: - type: object - properties: - key: - type: string - title: key - value: - type: string - title: value - title: TableTruncateStatementsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionPrimaryConstraintsRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - title: GetConnectionPrimaryConstraintsRequest - additionalProperties: false - description: Primary constraints for a specific table - mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse: - type: object - properties: - tableConstraints: - type: object - title: table_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' - description: the key here is .
and value is the primary constraint - title: GetConnectionPrimaryConstraintsResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionPrimaryConstraintsResponse.TableConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' - title: TableConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaMapRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - schemaConfig: - allOf: - - title: schema_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionSchemaConfig' - title: GetConnectionSchemaMapRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaMapResponse: - type: object - properties: - schemaMap: - type: object - title: schema_map - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' - description: >- - Returns the database columns separated by the fully qualified - .
- title: GetConnectionSchemaMapResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaMapResponse.SchemaMapEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaResponse' - title: SchemaMapEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaMapsRequest: - type: object - properties: - requests: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapRequest' - title: requests - description: List of connection schema maps to request - title: GetConnectionSchemaMapsRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaMapsResponse: - type: object - properties: - responses: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.GetConnectionSchemaMapResponse' - title: responses - description: List of responses in the same order as the input - connectionIds: - type: array - items: - type: string - title: connection_ids - description: Parallel array of each connection id that matches with the response - title: GetConnectionSchemaMapsResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - schemaConfig: - allOf: - - title: schema_config - - $ref: '#/components/schemas/mgmt.v1alpha1.ConnectionSchemaConfig' - title: GetConnectionSchemaRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionSchemaResponse: - type: object - properties: - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseColumn' - title: schemas - title: GetConnectionSchemaResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionTableConstraintsRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - title: GetConnectionTableConstraintsRequest - additionalProperties: false - mgmt.v1alpha1.GetConnectionTableConstraintsResponse: - type: object - properties: - foreignKeyConstraints: - type: object - title: foreign_key_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' - description: >- - the key here is .
and the list of tables that it - depends on, also `.
` format. - primaryKeyConstraints: - type: object - title: primary_key_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' - description: the key here is .
and value is the primary constraint - uniqueConstraints: - type: object - title: unique_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraints' - description: the key here is .
and value is the unique constraint - title: GetConnectionTableConstraintsResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionTableConstraintsResponse.ForeignKeyConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.ForeignConstraintTables' - title: ForeignKeyConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionTableConstraintsResponse.PrimaryKeyConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.PrimaryConstraint' - title: PrimaryKeyConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionTableConstraintsResponse.UniqueConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraints' - title: UniqueConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetConnectionUniqueConstraintsRequest: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - title: GetConnectionUniqueConstraintsRequest - additionalProperties: false - description: Unique constraints for a specific table - mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse: - type: object - properties: - tableConstraints: - type: object - title: table_constraints - additionalProperties: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' - description: the key here is .
and value is the unique constraint - title: GetConnectionUniqueConstraintsResponse - additionalProperties: false - mgmt.v1alpha1.GetConnectionUniqueConstraintsResponse.TableConstraintsEntry: - type: object - properties: - key: - type: string - title: key - value: - allOf: - - title: value - - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' - title: TableConstraintsEntry - additionalProperties: false - mgmt.v1alpha1.GetTableRowCountRequest: - type: object - allOf: - - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - properties: - connectionId: - type: string - title: connection_id - schema: - type: string - title: schema - table: - type: string - title: table - whereClause: - type: string - title: where_clause - title: GetTableRowCountRequest - additionalProperties: false - mgmt.v1alpha1.GetTableRowCountResponse: - type: object - properties: - count: - oneOf: - - type: string - - type: number - title: count - title: GetTableRowCountResponse - additionalProperties: false - mgmt.v1alpha1.InitStatementOptions: - type: object - properties: - initSchema: - type: boolean - title: init_schema - truncateBeforeInsert: - type: boolean - title: truncate_before_insert - truncateCascade: - type: boolean - title: truncate_cascade - title: InitStatementOptions - additionalProperties: false - mgmt.v1alpha1.MongoSchemaConfig: - type: object - title: MongoSchemaConfig - additionalProperties: false - mgmt.v1alpha1.MssqlSchemaConfig: - type: object - title: MssqlSchemaConfig - additionalProperties: false - mgmt.v1alpha1.MysqlSchemaConfig: - type: object - title: MysqlSchemaConfig - additionalProperties: false - mgmt.v1alpha1.MysqlStreamConfig: - type: object - title: MysqlStreamConfig - additionalProperties: false - mgmt.v1alpha1.PostgresSchemaConfig: - type: object - title: PostgresSchemaConfig - additionalProperties: false - mgmt.v1alpha1.PostgresStreamConfig: - type: object - title: PostgresStreamConfig - additionalProperties: false - mgmt.v1alpha1.PrimaryConstraint: - type: object - properties: - columns: - type: array - items: - type: string - title: columns - title: PrimaryConstraint - additionalProperties: false - mgmt.v1alpha1.SchemaInitStatements: - type: object - properties: - label: - type: string - title: label - statements: - type: array - items: - type: string - title: statements - title: SchemaInitStatements - additionalProperties: false - mgmt.v1alpha1.UniqueConstraint: - type: object - properties: - columns: - type: array - items: - type: string - title: columns - title: UniqueConstraint - additionalProperties: false - mgmt.v1alpha1.UniqueConstraints: - type: object - properties: - constraints: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.UniqueConstraint' - title: constraints - title: UniqueConstraints - additionalProperties: false - mgmt.v1alpha1.ActivityStatus: - type: string - title: ActivityStatus - enum: - - ACTIVITY_STATUS_UNSPECIFIED - - ACTIVITY_STATUS_SCHEDULED - - ACTIVITY_STATUS_STARTED - - ACTIVITY_STATUS_CANCELED - - ACTIVITY_STATUS_FAILED - mgmt.v1alpha1.AwsS3DestinationConnectionOptions.StorageClass: - type: string - title: StorageClass - enum: - - STORAGE_CLASS_UNSPECIFIED - - STORAGE_CLASS_STANDARD - - STORAGE_CLASS_REDUCED_REDUNDANCY - - STORAGE_CLASS_GLACIER - - STORAGE_CLASS_STANDARD_IA - - STORAGE_CLASS_ONEZONE_IA - - STORAGE_CLASS_INTELLIGENT_TIERING - - STORAGE_CLASS_DEEP_ARCHIVE - mgmt.v1alpha1.JobRunStatus: - type: string - title: JobRunStatus - enum: - - JOB_RUN_STATUS_UNSPECIFIED - - JOB_RUN_STATUS_PENDING - - JOB_RUN_STATUS_RUNNING - - JOB_RUN_STATUS_COMPLETE - - JOB_RUN_STATUS_ERROR - - JOB_RUN_STATUS_CANCELED - - JOB_RUN_STATUS_TERMINATED - - JOB_RUN_STATUS_FAILED - - JOB_RUN_STATUS_TIMED_OUT - description: An enumeration of job run statuses. - mgmt.v1alpha1.JobStatus: - type: string - title: JobStatus - enum: - - JOB_STATUS_UNSPECIFIED - - JOB_STATUS_ENABLED - - JOB_STATUS_PAUSED - - JOB_STATUS_DISABLED - mgmt.v1alpha1.LogLevel: - type: string - title: LogLevel - enum: - - LOG_LEVEL_UNSPECIFIED - - LOG_LEVEL_DEBUG - - LOG_LEVEL_INFO - - LOG_LEVEL_WARN - - LOG_LEVEL_ERROR - mgmt.v1alpha1.LogWindow: - type: string - title: LogWindow - enum: - - LOG_WINDOW_NO_TIME_UNSPECIFIED - - LOG_WINDOW_FIFTEEN_MIN - - LOG_WINDOW_ONE_HOUR - - LOG_WINDOW_ONE_DAY - mgmt.v1alpha1.TransformerSource: - type: string - title: TransformerSource - enum: - - TRANSFORMER_SOURCE_UNSPECIFIED - - TRANSFORMER_SOURCE_PASSTHROUGH - - TRANSFORMER_SOURCE_GENERATE_DEFAULT - - TRANSFORMER_SOURCE_TRANSFORM_JAVASCRIPT - - TRANSFORMER_SOURCE_GENERATE_EMAIL - - TRANSFORMER_SOURCE_TRANSFORM_EMAIL - - TRANSFORMER_SOURCE_GENERATE_BOOL - - TRANSFORMER_SOURCE_GENERATE_CARD_NUMBER - - TRANSFORMER_SOURCE_GENERATE_CITY - - TRANSFORMER_SOURCE_GENERATE_E164_PHONE_NUMBER - - TRANSFORMER_SOURCE_GENERATE_FIRST_NAME - - TRANSFORMER_SOURCE_GENERATE_FLOAT64 - - TRANSFORMER_SOURCE_GENERATE_FULL_ADDRESS - - TRANSFORMER_SOURCE_GENERATE_FULL_NAME - - TRANSFORMER_SOURCE_GENERATE_GENDER - - TRANSFORMER_SOURCE_GENERATE_INT64_PHONE_NUMBER - - TRANSFORMER_SOURCE_GENERATE_INT64 - - TRANSFORMER_SOURCE_GENERATE_RANDOM_INT64 - - TRANSFORMER_SOURCE_GENERATE_LAST_NAME - - TRANSFORMER_SOURCE_GENERATE_SHA256HASH - - TRANSFORMER_SOURCE_GENERATE_SSN - - TRANSFORMER_SOURCE_GENERATE_STATE - - TRANSFORMER_SOURCE_GENERATE_STREET_ADDRESS - - TRANSFORMER_SOURCE_GENERATE_STRING_PHONE_NUMBER - - TRANSFORMER_SOURCE_GENERATE_STRING - - TRANSFORMER_SOURCE_GENERATE_RANDOM_STRING - - TRANSFORMER_SOURCE_GENERATE_UNIXTIMESTAMP - - TRANSFORMER_SOURCE_GENERATE_USERNAME - - TRANSFORMER_SOURCE_GENERATE_UTCTIMESTAMP - - TRANSFORMER_SOURCE_GENERATE_UUID - - TRANSFORMER_SOURCE_GENERATE_ZIPCODE - - TRANSFORMER_SOURCE_TRANSFORM_E164_PHONE_NUMBER - - TRANSFORMER_SOURCE_TRANSFORM_FIRST_NAME - - TRANSFORMER_SOURCE_TRANSFORM_FLOAT64 - - TRANSFORMER_SOURCE_TRANSFORM_FULL_NAME - - TRANSFORMER_SOURCE_TRANSFORM_INT64_PHONE_NUMBER - - TRANSFORMER_SOURCE_TRANSFORM_INT64 - - TRANSFORMER_SOURCE_TRANSFORM_LAST_NAME - - TRANSFORMER_SOURCE_TRANSFORM_PHONE_NUMBER - - TRANSFORMER_SOURCE_TRANSFORM_STRING - - TRANSFORMER_SOURCE_GENERATE_NULL - - TRANSFORMER_SOURCE_GENERATE_CATEGORICAL - - TRANSFORMER_SOURCE_TRANSFORM_CHARACTER_SCRAMBLE - - TRANSFORMER_SOURCE_USER_DEFINED - - TRANSFORMER_SOURCE_GENERATE_JAVASCRIPT - - TRANSFORMER_SOURCE_GENERATE_COUNTRY - - TRANSFORMER_SOURCE_TRANSFORM_PII_TEXT - mgmt.v1alpha1.ActivityFailure: - type: object - properties: - message: - type: string - title: message - title: ActivityFailure - additionalProperties: false - mgmt.v1alpha1.ActivityOptions: - type: object - allOf: - - anyOf: - - required: - - scheduleToCloseTimeout - - not: - anyOf: - - required: - - scheduleToCloseTimeout - - anyOf: - - required: - - startToCloseTimeout - - not: - anyOf: - - required: - - startToCloseTimeout - properties: - scheduleToCloseTimeout: - oneOf: - - type: string - - type: number - title: schedule_to_close_timeout - minimum: 1 - description: >- - Total time that a workflow is willing to wait for an activity to - complete, including retries. - Measured in seconds - startToCloseTimeout: - oneOf: - - type: string - - type: number - title: start_to_close_timeout - minimum: 1 - description: |- - Max time of a single Temporal Activity execution attempt. - This timeout should be as short as the longest psosible execution of any activity (e.g. table sync). - Important to know that this is per retry attempt. Defaults to the schedule to close timeout if not provided. - Measured in seconds - retryPolicy: - allOf: - - title: retry_policy - description: |- - Optionally define a retry policy for the activity - If max attempts is not set, the activity will retry indefinitely until the start to close timeout lapses - - $ref: '#/components/schemas/mgmt.v1alpha1.RetryPolicy' - title: ActivityOptions - additionalProperties: false - description: >- - Config that contains various timeouts that are configured in the - underlying temporal workflow(s) and activities - mgmt.v1alpha1.AiGenerateSourceOptions: - type: object - allOf: - - anyOf: - - required: - - fkSourceConnectionId - - not: - anyOf: - - required: - - fkSourceConnectionId - - anyOf: - - required: - - generateBatchSize - - not: - anyOf: - - required: - - generateBatchSize - - anyOf: - - required: - - userPrompt - - not: - anyOf: - - required: - - userPrompt - properties: - aiConnectionId: - type: string - title: ai_connection_id - format: uuid - description: >- - The connection id that corresponds with an AI-based Neosync - connection - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceSchemaOption' - title: schemas - minItems: 1 - description: >- - The list of schemas (and their tables) along with any configuration - options that will be used to generate data for. - fkSourceConnectionId: - type: string - title: fk_source_connection_id - format: uuid - description: >- - An optional connection id that will be used as the basis for the - shape of data to be generated. - modelName: - type: string - title: model_name - minLength: 1 - description: The name of the model to use - userPrompt: - type: string - title: user_prompt - description: Optionally provide a user prompt to give more context to the schema - generateBatchSize: - oneOf: - - type: string - - type: number - title: generate_batch_size - maximum: 100 - minimum: 1 - description: >- - The batch size that will be used to generate X number of records. - This is global and will be applied to all tables configured. - title: AiGenerateSourceOptions - additionalProperties: false - mgmt.v1alpha1.AiGenerateSourceSchemaOption: - type: object - properties: - schema: - type: string - title: schema - minLength: 1 - description: The dataabase schema - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceTableOption' - title: tables - minItems: 1 - description: >- - The list of tables (and their configuration) that reside within the - schema to receive generated data - title: AiGenerateSourceSchemaOption - additionalProperties: false - mgmt.v1alpha1.AiGenerateSourceTableOption: - type: object - properties: - table: - type: string - title: table - minLength: 1 - description: >- - The table that will be used to. 1. The schema of the table will be - injected into the prompt, of which the resulting data will then be - inserted. - rowCount: - oneOf: - - type: string - - type: number - title: row_count - maximum: 1000 - minimum: 1 - description: The total number of records to be generated. - title: AiGenerateSourceTableOption - additionalProperties: false - mgmt.v1alpha1.AwsS3DestinationConnectionOptions: - type: object - allOf: - - anyOf: - - required: - - maxInFlight - - not: - anyOf: - - required: - - maxInFlight - - anyOf: - - required: - - timeout - - not: - anyOf: - - required: - - timeout - properties: - storageClass: - allOf: - - title: storage_class - description: >- - The storage class that will be used when objects are written to - S3 - - $ref: >- - #/components/schemas/mgmt.v1alpha1.AwsS3DestinationConnectionOptions.StorageClass - maxInFlight: - type: integer - title: max_in_flight - description: >- - The maximum number of batched messages to have in flight at a given - time. Increase this to improve throughput. - timeout: - type: string - title: timeout - description: >- - The maximum period (duration string) to wait on an upload before - abandoning it and reattempting. - batch: - allOf: - - title: batch - description: >- - Configure batching options to more efficiently store records in - S3 - - $ref: '#/components/schemas/mgmt.v1alpha1.BatchConfig' - title: AwsS3DestinationConnectionOptions - additionalProperties: false - mgmt.v1alpha1.AwsS3SourceConnectionOptions: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - title: AwsS3SourceConnectionOptions - additionalProperties: false - mgmt.v1alpha1.BatchConfig: - type: object - allOf: - - anyOf: - - required: - - count - - not: - anyOf: - - required: - - count - - anyOf: - - required: - - period - - not: - anyOf: - - required: - - period - properties: - count: - type: integer - title: count - description: The max allowed in a batch before it is flushed. 0 to disable. - period: - type: string - title: period - description: >- - A duration string in which an incomplete batch should be flushed - regardless of the count. - Examples are 1s, 1m, 500ms - title: BatchConfig - additionalProperties: false - mgmt.v1alpha1.CancelJobRunRequest: - type: object - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - title: CancelJobRunRequest - additionalProperties: false - mgmt.v1alpha1.CancelJobRunResponse: - type: object - title: CancelJobRunResponse - additionalProperties: false - mgmt.v1alpha1.ColumnError: - type: object - properties: - schema: - type: string - title: schema - table: - type: string - title: table - column: - type: string - title: column - errors: - type: array - items: - type: string - title: errors - title: ColumnError - additionalProperties: false - mgmt.v1alpha1.CreateJobDestination: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - options: - allOf: - - title: options - - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' - title: CreateJobDestination - additionalProperties: false - mgmt.v1alpha1.CreateJobDestinationConnectionsRequest: - type: object - properties: - jobId: - type: string - title: job_id - format: uuid - destinations: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobDestination' - title: destinations - title: CreateJobDestinationConnectionsRequest - additionalProperties: false - mgmt.v1alpha1.CreateJobDestinationConnectionsResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: CreateJobDestinationConnectionsResponse - additionalProperties: false - mgmt.v1alpha1.CreateJobRequest: - type: object - allOf: - - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - properties: - accountId: - type: string - title: account_id - format: uuid - description: The unique account identifier that this job will be associated with - jobName: - type: string - title: job_name - pattern: ^[a-z0-9-]{3,100}$ - description: The unique, friendly name of the job. This is unique per account - cronSchedule: - type: string - title: cron_schedule - description: >- - Optionally provide a cron schedule. Goes into effect if the job - status is set to enabled - mappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' - title: mappings - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' - destinations: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.CreateJobDestination' - title: destinations - initiateJobRun: - type: boolean - title: initiate_job_run - description: >- - Initially trigger a run of this job regardless of its status or cron - schedule - workflowOptions: - allOf: - - title: workflow_options - description: >- - Specify timeouts and other workflow options for the underlying - temporal workflow - - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' - syncOptions: - allOf: - - title: sync_options - description: >- - Specify timeout and retry options for data synchronization - activities - Data sync activities are any piece of work that involves actually synchronizing data from a source to a destination - For the data sync and generate jobs, this will be applied per table - - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' - virtualForeignKeys: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' - title: virtual_foreign_keys - title: CreateJobRequest - additionalProperties: false - mgmt.v1alpha1.CreateJobResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: CreateJobResponse - additionalProperties: false - mgmt.v1alpha1.CreateJobRunRequest: - type: object - properties: - jobId: - type: string - title: job_id - format: uuid - title: CreateJobRunRequest - additionalProperties: false - mgmt.v1alpha1.CreateJobRunResponse: - type: object - title: CreateJobRunResponse - additionalProperties: false - mgmt.v1alpha1.DatabaseError: - type: object - properties: - errors: - type: array - items: - type: string - title: errors - title: DatabaseError - additionalProperties: false - mgmt.v1alpha1.DeleteJobDestinationConnectionRequest: - type: object - properties: - destinationId: - type: string - title: destination_id - format: uuid - title: DeleteJobDestinationConnectionRequest - additionalProperties: false - mgmt.v1alpha1.DeleteJobDestinationConnectionResponse: - type: object - title: DeleteJobDestinationConnectionResponse - additionalProperties: false - mgmt.v1alpha1.DeleteJobRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: DeleteJobRequest - additionalProperties: false - mgmt.v1alpha1.DeleteJobResponse: - type: object - title: DeleteJobResponse - additionalProperties: false - mgmt.v1alpha1.DeleteJobRunRequest: - type: object - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - title: DeleteJobRunRequest - additionalProperties: false - mgmt.v1alpha1.DeleteJobRunResponse: - type: object - title: DeleteJobRunResponse - additionalProperties: false - mgmt.v1alpha1.DynamoDBDestinationConnectionOptions: - type: object - properties: - tableMappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBDestinationTableMapping' - title: table_mappings - description: >- - List of table mappings when piping data from a dynamoDB table to - another dynamoDB table - title: DynamoDBDestinationConnectionOptions - additionalProperties: false - description: Configuration for DynamoDB Destination Connection Job Options - mgmt.v1alpha1.DynamoDBDestinationTableMapping: - type: object - properties: - sourceTable: - type: string - title: source_table - description: The name of the incoming source table - destinationTable: - type: string - title: destination_table - description: The name of the outgoing destination table - title: DynamoDBDestinationTableMapping - additionalProperties: false - description: >- - Configuration for mapping a source table to a destination table for - DynamoDB - mgmt.v1alpha1.DynamoDBSourceConnectionOptions: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - description: The unique connection id to a dynamodb connection configuration - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceTableOption' - title: tables - description: |- - List of table option configurations for any mapped source table. - Any table listed in this must also be present as a job mapping table to be applied. - unmappedTransforms: - allOf: - - title: unmapped_transforms - description: Default transformations for any unmapped keys - - $ref: >- - #/components/schemas/mgmt.v1alpha1.DynamoDBSourceUnmappedTransformConfig - enableConsistentRead: - type: boolean - title: enable_consistent_read - description: |- - Enforces strong read consistency - False: Eventually Consistent Reads, True: Strongly Consistent Reads - https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadConsistency.html - title: DynamoDBSourceConnectionOptions - additionalProperties: false - description: DynamoDB connection options for a job source - mgmt.v1alpha1.DynamoDBSourceSchemaSubset: - type: object - properties: - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceTableOption' - title: tables - title: DynamoDBSourceSchemaSubset - additionalProperties: false - mgmt.v1alpha1.DynamoDBSourceTableOption: - type: object - allOf: - - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - properties: - table: - type: string - title: table - minLength: 1 - description: The table that this configuration will be applied to - whereClause: - type: string - title: where_clause - description: >- - An optional PartiQL query that may be used for subsetting the - DynamoDB table. - This is not a parameterized query and must be valid. Intended to be everything after the WHERE keyword. - title: DynamoDBSourceTableOption - additionalProperties: false - mgmt.v1alpha1.DynamoDBSourceUnmappedTransformConfig: - type: object - properties: - b: - allOf: - - title: b - description: Byte - - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' - boolean: - allOf: - - title: boolean - description: Boolean - - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' - 'n': - allOf: - - title: 'n' - description: Number - - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' - s: - allOf: - - title: s - description: String - - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' - title: DynamoDBSourceUnmappedTransformConfig - additionalProperties: false - mgmt.v1alpha1.GcpCloudStorageDestinationConnectionOptions: - type: object - title: GcpCloudStorageDestinationConnectionOptions - additionalProperties: false - description: >- - Configuration for Google Cloud Storage Destination Connection Job - Options - mgmt.v1alpha1.GenerateSourceOptions: - type: object - allOf: - - anyOf: - - required: - - fkSourceConnectionId - - not: - anyOf: - - required: - - fkSourceConnectionId - anyOf: - - required: - - fkSourceConnectionId - - not: - anyOf: - - required: - - fkSourceConnectionId - properties: - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceSchemaOption' - title: schemas - minItems: 1 - fkSourceConnectionId: - type: string - title: fk_source_connection_id - format: uuid - title: GenerateSourceOptions - additionalProperties: false - mgmt.v1alpha1.GenerateSourceSchemaOption: - type: object - properties: - schema: - type: string - title: schema - minLength: 1 - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceTableOption' - title: tables - minItems: 1 - title: GenerateSourceSchemaOption - additionalProperties: false - mgmt.v1alpha1.GenerateSourceTableOption: - type: object - properties: - table: - type: string - title: table - minLength: 1 - rowCount: - oneOf: - - type: string - - type: number - title: row_count - minimum: 1 - title: GenerateSourceTableOption - additionalProperties: false - mgmt.v1alpha1.GetJobNextRunsRequest: - type: object - properties: - jobId: - type: string - title: job_id - title: GetJobNextRunsRequest - additionalProperties: false - mgmt.v1alpha1.GetJobNextRunsResponse: - type: object - properties: - nextRuns: - allOf: - - title: next_runs - - $ref: '#/components/schemas/mgmt.v1alpha1.JobNextRuns' - title: GetJobNextRunsResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRecentRunsRequest: - type: object - properties: - jobId: - type: string - title: job_id - format: uuid - title: GetJobRecentRunsRequest - additionalProperties: false - mgmt.v1alpha1.GetJobRecentRunsResponse: - type: object - properties: - recentRuns: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobRecentRun' - title: recent_runs - title: GetJobRecentRunsResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: GetJobRequest - additionalProperties: false - mgmt.v1alpha1.GetJobResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: GetJobResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRunEventsRequest: - type: object - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - title: GetJobRunEventsRequest - additionalProperties: false - mgmt.v1alpha1.GetJobRunEventsResponse: - type: object - properties: - events: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEvent' - title: events - isRunComplete: - type: boolean - title: is_run_complete - title: GetJobRunEventsResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRunLogsStreamRequest: - type: object - allOf: - - anyOf: - - required: - - maxLogLines - - not: - anyOf: - - required: - - maxLogLines - anyOf: - - required: - - maxLogLines - - not: - anyOf: - - required: - - maxLogLines - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - window: - allOf: - - title: window - description: The time window in which to retrieve the logs - - $ref: '#/components/schemas/mgmt.v1alpha1.LogWindow' - shouldTail: - type: boolean - title: should_tail - description: >- - Whether or not to tail the stream. Note: only works with k8s-pods - and is not currently supported with Loki logs - maxLogLines: - oneOf: - - type: string - - type: number - title: max_log_lines - minimum: 1 - description: Optionally provide a max log limit - logLevels: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.LogLevel' - title: log_levels - description: >- - Provide a list of log levels to filter by. If any of these are - UNSPECIFIED, all log levels are returned. - title: GetJobRunLogsStreamRequest - additionalProperties: false - mgmt.v1alpha1.GetJobRunLogsStreamResponse: - type: object - allOf: - - anyOf: - - required: - - timestamp - - not: - anyOf: - - required: - - timestamp - anyOf: - - required: - - timestamp - - not: - anyOf: - - required: - - timestamp - properties: - logLine: - type: string - title: log_line - timestamp: - allOf: - - title: timestamp - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: GetJobRunLogsStreamResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRunRequest: - type: object - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - title: GetJobRunRequest - additionalProperties: false - mgmt.v1alpha1.GetJobRunResponse: - type: object - properties: - jobRun: - allOf: - - title: job_run - - $ref: '#/components/schemas/mgmt.v1alpha1.JobRun' - title: GetJobRunResponse - additionalProperties: false - mgmt.v1alpha1.GetJobRunsRequest: - type: object - allOf: - - anyOf: - - required: - - accountId - - required: - - jobId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - anyOf: - - required: - - accountId - - required: - - jobId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - properties: - jobId: - type: string - title: job_id - format: uuid - accountId: - type: string - title: account_id - format: uuid - title: GetJobRunsRequest - additionalProperties: false - mgmt.v1alpha1.GetJobRunsResponse: - type: object - properties: - jobRuns: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobRun' - title: job_runs - title: GetJobRunsResponse - additionalProperties: false - mgmt.v1alpha1.GetJobStatusRequest: - type: object - properties: - jobId: - type: string - title: job_id - title: GetJobStatusRequest - additionalProperties: false - mgmt.v1alpha1.GetJobStatusResponse: - type: object - properties: - status: - allOf: - - title: status - - $ref: '#/components/schemas/mgmt.v1alpha1.JobStatus' - title: GetJobStatusResponse - additionalProperties: false - mgmt.v1alpha1.GetJobStatusesRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetJobStatusesRequest - additionalProperties: false - mgmt.v1alpha1.GetJobStatusesResponse: - type: object - properties: - statuses: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobStatusRecord' - title: statuses - title: GetJobStatusesResponse - additionalProperties: false - mgmt.v1alpha1.GetJobsRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetJobsRequest - additionalProperties: false - mgmt.v1alpha1.GetJobsResponse: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: jobs - title: GetJobsResponse - additionalProperties: false - mgmt.v1alpha1.GetRunContextRequest: - type: object - properties: - id: - allOf: - - title: id - - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' - title: GetRunContextRequest - additionalProperties: false - mgmt.v1alpha1.GetRunContextResponse: - type: object - properties: - value: - type: string - title: value - format: byte - title: GetRunContextResponse - additionalProperties: false - mgmt.v1alpha1.IsJobNameAvailableRequest: - type: object - properties: - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - accountId: - type: string - title: account_id - format: uuid - title: IsJobNameAvailableRequest - additionalProperties: false - mgmt.v1alpha1.IsJobNameAvailableResponse: - type: object - properties: - isAvailable: - type: boolean - title: is_available - title: IsJobNameAvailableResponse - additionalProperties: false - mgmt.v1alpha1.Job: - type: object - allOf: - - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - properties: - id: - type: string - title: id - description: The unique identifier of the job - createdByUserId: - type: string - title: created_by_user_id - createdAt: - allOf: - - title: created_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - updatedByUserId: - type: string - title: updated_by_user_id - updatedAt: - allOf: - - title: updated_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - name: - type: string - title: name - description: The unique, friendly name of the job - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' - destinations: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestination' - title: destinations - mappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' - title: mappings - cronSchedule: - type: string - title: cron_schedule - accountId: - type: string - title: account_id - description: The account identifier that a job is associated with - syncOptions: - allOf: - - title: sync_options - description: >- - Specify timeout and retry options for data synchronization - activities - Data sync activities are any piece of work that involves actually synchronizing data from a source to a destination - For the data sync and generate jobs, this will be applied per table - - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' - workflowOptions: - allOf: - - title: workflow_options - description: >- - Specify timeouts and other workflow options for the underlying - temporal workflow - - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' - virtualForeignKeys: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' - title: virtual_foreign_keys - title: Job - additionalProperties: false - mgmt.v1alpha1.JobDestination: - type: object - properties: - connectionId: - type: string - title: connection_id - options: - allOf: - - title: options - - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' - id: - type: string - title: id - title: JobDestination - additionalProperties: false - mgmt.v1alpha1.JobDestinationOptions: - type: object - allOf: - - anyOf: - - required: - - awsS3Options - - required: - - dynamodbOptions - - required: - - gcpCloudstorageOptions - - required: - - mongodbOptions - - required: - - mssqlOptions - - required: - - mysqlOptions - - required: - - postgresOptions - - not: - anyOf: - - required: - - awsS3Options - - required: - - dynamodbOptions - - required: - - gcpCloudstorageOptions - - required: - - mongodbOptions - - required: - - mssqlOptions - - required: - - mysqlOptions - - required: - - postgresOptions - anyOf: - - required: - - awsS3Options - - required: - - dynamodbOptions - - required: - - gcpCloudstorageOptions - - required: - - mongodbOptions - - required: - - mssqlOptions - - required: - - mysqlOptions - - required: - - postgresOptions - - not: - anyOf: - - required: - - awsS3Options - - required: - - dynamodbOptions - - required: - - gcpCloudstorageOptions - - required: - - mongodbOptions - - required: - - mssqlOptions - - required: - - mysqlOptions - - required: - - postgresOptions - properties: - postgresOptions: - allOf: - - title: postgres_options - - $ref: >- - #/components/schemas/mgmt.v1alpha1.PostgresDestinationConnectionOptions - awsS3Options: - allOf: - - title: aws_s3_options - - $ref: >- - #/components/schemas/mgmt.v1alpha1.AwsS3DestinationConnectionOptions - mysqlOptions: - allOf: - - title: mysql_options - - $ref: >- - #/components/schemas/mgmt.v1alpha1.MysqlDestinationConnectionOptions - mongodbOptions: - allOf: - - title: mongodb_options - - $ref: >- - #/components/schemas/mgmt.v1alpha1.MongoDBDestinationConnectionOptions - gcpCloudstorageOptions: - allOf: - - title: gcp_cloudstorage_options - description: Destination Connecton options for Google Cloud Storage - - $ref: >- - #/components/schemas/mgmt.v1alpha1.GcpCloudStorageDestinationConnectionOptions - dynamodbOptions: - allOf: - - title: dynamodb_options - description: Destination Connection options for DynamoDB - - $ref: >- - #/components/schemas/mgmt.v1alpha1.DynamoDBDestinationConnectionOptions - mssqlOptions: - allOf: - - title: mssql_options - description: Destination Connection options for Microsoft SQL Server - - $ref: >- - #/components/schemas/mgmt.v1alpha1.MssqlDestinationConnectionOptions - title: JobDestinationOptions - additionalProperties: false - mgmt.v1alpha1.JobMapping: - type: object - properties: - schema: - type: string - title: schema - table: - type: string - title: table - column: - type: string - title: column - transformer: - allOf: - - title: transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.JobMappingTransformer' - title: JobMapping - additionalProperties: false - mgmt.v1alpha1.JobMappingTransformer: - type: object - properties: - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - title: JobMappingTransformer - additionalProperties: false - mgmt.v1alpha1.JobNextRuns: - type: object - properties: - nextRunTimes: - type: array - items: - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: next_run_times - title: JobNextRuns - additionalProperties: false - mgmt.v1alpha1.JobRecentRun: - type: object - properties: - startTime: - allOf: - - title: start_time - - $ref: '#/components/schemas/google.protobuf.Timestamp' - jobRunId: - type: string - title: job_run_id - title: JobRecentRun - additionalProperties: false - mgmt.v1alpha1.JobRun: - type: object - allOf: - - anyOf: - - required: - - completedAt - - not: - anyOf: - - required: - - completedAt - anyOf: - - required: - - completedAt - - not: - anyOf: - - required: - - completedAt - properties: - id: - type: string - title: id - description: >- - The id of the job run. This will currently be equivalent to the - temporal workflow id - jobId: - type: string - title: job_id - description: The unique identifier of the job id this run is associated with - name: - type: string - title: name - description: The name of the job run. - status: - allOf: - - title: status - description: the status of the job run - - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunStatus' - startedAt: - allOf: - - title: started_at - description: A timestamp of when the run started - - $ref: '#/components/schemas/google.protobuf.Timestamp' - completedAt: - allOf: - - title: completed_at - description: >- - Available if the run completed or has not yet been archived by - the system - - $ref: '#/components/schemas/google.protobuf.Timestamp' - pendingActivities: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.PendingActivity' - title: pending_activities - description: >- - Pending activities are only returned when retrieving a specific job - run and will not be returned when requesting job runs in list format - title: JobRun - additionalProperties: false - mgmt.v1alpha1.JobRunEvent: - type: object - properties: - id: - oneOf: - - type: string - - type: number - title: id - type: - type: string - title: type - startTime: - allOf: - - title: start_time - - $ref: '#/components/schemas/google.protobuf.Timestamp' - closeTime: - allOf: - - title: close_time - - $ref: '#/components/schemas/google.protobuf.Timestamp' - metadata: - allOf: - - title: metadata - - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventMetadata' - tasks: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventTask' - title: tasks - title: JobRunEvent - additionalProperties: false - mgmt.v1alpha1.JobRunEventMetadata: - type: object - allOf: - - anyOf: - - required: - - syncMetadata - - not: - anyOf: - - required: - - syncMetadata - anyOf: - - required: - - syncMetadata - - not: - anyOf: - - required: - - syncMetadata - properties: - syncMetadata: - allOf: - - title: sync_metadata - - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunSyncMetadata' - title: JobRunEventMetadata - additionalProperties: false - mgmt.v1alpha1.JobRunEventTask: - type: object - properties: - id: - oneOf: - - type: string - - type: number - title: id - type: - type: string - title: type - eventTime: - allOf: - - title: event_time - - $ref: '#/components/schemas/google.protobuf.Timestamp' - error: - allOf: - - title: error - - $ref: '#/components/schemas/mgmt.v1alpha1.JobRunEventTaskError' - title: JobRunEventTask - additionalProperties: false - mgmt.v1alpha1.JobRunEventTaskError: - type: object - properties: - message: - type: string - title: message - retryState: - type: string - title: retry_state - title: JobRunEventTaskError - additionalProperties: false - mgmt.v1alpha1.JobRunSyncMetadata: - type: object - properties: - schema: - type: string - title: schema - table: - type: string - title: table - title: JobRunSyncMetadata - additionalProperties: false - mgmt.v1alpha1.JobSource: - type: object - properties: - options: - allOf: - - title: options - - $ref: '#/components/schemas/mgmt.v1alpha1.JobSourceOptions' - title: JobSource - required: - - options - - options - additionalProperties: false - mgmt.v1alpha1.JobSourceOptions: - type: object - allOf: - - anyOf: - - required: - - aiGenerate - - required: - - awsS3 - - required: - - dynamodb - - required: - - generate - - required: - - mongodb - - required: - - mssql - - required: - - mysql - - required: - - postgres - - not: - anyOf: - - required: - - aiGenerate - - required: - - awsS3 - - required: - - dynamodb - - required: - - generate - - required: - - mongodb - - required: - - mssql - - required: - - mysql - - required: - - postgres - anyOf: - - required: - - aiGenerate - - required: - - awsS3 - - required: - - dynamodb - - required: - - generate - - required: - - mongodb - - required: - - mssql - - required: - - mysql - - required: - - postgres - - not: - anyOf: - - required: - - aiGenerate - - required: - - awsS3 - - required: - - dynamodb - - required: - - generate - - required: - - mongodb - - required: - - mssql - - required: - - mysql - - required: - - postgres - properties: - postgres: - allOf: - - title: postgres - - $ref: >- - #/components/schemas/mgmt.v1alpha1.PostgresSourceConnectionOptions - awsS3: - allOf: - - title: aws_s3 - - $ref: '#/components/schemas/mgmt.v1alpha1.AwsS3SourceConnectionOptions' - mysql: - allOf: - - title: mysql - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceConnectionOptions' - generate: - allOf: - - title: generate - - $ref: '#/components/schemas/mgmt.v1alpha1.GenerateSourceOptions' - aiGenerate: - allOf: - - title: ai_generate - - $ref: '#/components/schemas/mgmt.v1alpha1.AiGenerateSourceOptions' - mongodb: - allOf: - - title: mongodb - - $ref: >- - #/components/schemas/mgmt.v1alpha1.MongoDBSourceConnectionOptions - dynamodb: - allOf: - - title: dynamodb - - $ref: >- - #/components/schemas/mgmt.v1alpha1.DynamoDBSourceConnectionOptions - mssql: - allOf: - - title: mssql - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceConnectionOptions' - title: JobSourceOptions - additionalProperties: false - mgmt.v1alpha1.JobSourceSqlSubetSchemas: - type: object - allOf: - - anyOf: - - required: - - dynamodbSubset - - required: - - mssqlSubset - - required: - - mysqlSubset - - required: - - postgresSubset - - not: - anyOf: - - required: - - dynamodbSubset - - required: - - mssqlSubset - - required: - - mysqlSubset - - required: - - postgresSubset - anyOf: - - required: - - dynamodbSubset - - required: - - mssqlSubset - - required: - - mysqlSubset - - required: - - postgresSubset - - not: - anyOf: - - required: - - dynamodbSubset - - required: - - mssqlSubset - - required: - - mysqlSubset - - required: - - postgresSubset - properties: - postgresSubset: - allOf: - - title: postgres_subset - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaSubset' - mysqlSubset: - allOf: - - title: mysql_subset - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaSubset' - dynamodbSubset: - allOf: - - title: dynamodb_subset - - $ref: '#/components/schemas/mgmt.v1alpha1.DynamoDBSourceSchemaSubset' - mssqlSubset: - allOf: - - title: mssql_subset - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaSubset' - title: JobSourceSqlSubetSchemas - additionalProperties: false - mgmt.v1alpha1.JobStatusRecord: - type: object - properties: - jobId: - type: string - title: job_id - status: - allOf: - - title: status - - $ref: '#/components/schemas/mgmt.v1alpha1.JobStatus' - title: JobStatusRecord - additionalProperties: false - mgmt.v1alpha1.MongoDBDestinationConnectionOptions: - type: object - title: MongoDBDestinationConnectionOptions - additionalProperties: false - mgmt.v1alpha1.MongoDBSourceConnectionOptions: - type: object - properties: - connectionId: - type: string - title: connection_id - format: uuid - description: The unique connection id to a mongo connection configuration - title: MongoDBSourceConnectionOptions - additionalProperties: false - description: MongoDB connection options for a job source - mgmt.v1alpha1.MssqlDestinationConnectionOptions: - type: object - properties: - truncateTable: - allOf: - - title: truncate_table - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlTruncateTableConfig' - initTableSchema: - type: boolean - title: init_table_schema - description: Currently not supported and a placeholder for future implementation - onConflict: - allOf: - - title: on_conflict - description: >- - Currently not supported and a placeholder for future - implementation - - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlOnConflictConfig' - skipForeignKeyViolations: - type: boolean - title: skip_foreign_key_violations - description: >- - Insert all valid records, skipping any that violate foreign key - constraints. - title: MssqlDestinationConnectionOptions - additionalProperties: false - mgmt.v1alpha1.MssqlOnConflictConfig: - type: object - properties: - doNothing: - type: boolean - title: do_nothing - title: MssqlOnConflictConfig - additionalProperties: false - mgmt.v1alpha1.MssqlSourceConnectionOptions: - type: object - properties: - haltOnNewColumnAddition: - type: boolean - title: halt_on_new_column_addition - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaOption' - title: schemas - connectionId: - type: string - title: connection_id - format: uuid - subsetByForeignKeyConstraints: - type: boolean - title: subset_by_foreign_key_constraints - title: MssqlSourceConnectionOptions - additionalProperties: false - mgmt.v1alpha1.MssqlSourceSchemaOption: - type: object - properties: - schema: - type: string - title: schema - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceTableOption' - title: tables - title: MssqlSourceSchemaOption - additionalProperties: false - mgmt.v1alpha1.MssqlSourceSchemaSubset: - type: object - properties: - mssqlSchemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MssqlSourceSchemaOption' - title: mssql_schemas - title: MssqlSourceSchemaSubset - additionalProperties: false - mgmt.v1alpha1.MssqlSourceTableOption: - type: object - allOf: - - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - properties: - table: - type: string - title: table - whereClause: - type: string - title: where_clause - title: MssqlSourceTableOption - additionalProperties: false - mgmt.v1alpha1.MssqlTruncateTableConfig: - type: object - properties: - truncateBeforeInsert: - type: boolean - title: truncate_before_insert - title: MssqlTruncateTableConfig - additionalProperties: false - mgmt.v1alpha1.MysqlDestinationConnectionOptions: - type: object - properties: - truncateTable: - allOf: - - title: truncate_table - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlTruncateTableConfig' - initTableSchema: - type: boolean - title: init_table_schema - onConflict: - allOf: - - title: on_conflict - - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlOnConflictConfig' - skipForeignKeyViolations: - type: boolean - title: skip_foreign_key_violations - description: >- - Insert all valid records, skipping any that violate foreign key - constraints. - title: MysqlDestinationConnectionOptions - additionalProperties: false - mgmt.v1alpha1.MysqlOnConflictConfig: - type: object - properties: - doNothing: - type: boolean - title: do_nothing - title: MysqlOnConflictConfig - additionalProperties: false - mgmt.v1alpha1.MysqlSourceConnectionOptions: - type: object - properties: - haltOnNewColumnAddition: - type: boolean - title: halt_on_new_column_addition - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaOption' - title: schemas - connectionId: - type: string - title: connection_id - format: uuid - subsetByForeignKeyConstraints: - type: boolean - title: subset_by_foreign_key_constraints - title: MysqlSourceConnectionOptions - additionalProperties: false - mgmt.v1alpha1.MysqlSourceSchemaOption: - type: object - properties: - schema: - type: string - title: schema - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceTableOption' - title: tables - title: MysqlSourceSchemaOption - additionalProperties: false - mgmt.v1alpha1.MysqlSourceSchemaSubset: - type: object - properties: - mysqlSchemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.MysqlSourceSchemaOption' - title: mysql_schemas - title: MysqlSourceSchemaSubset - additionalProperties: false - mgmt.v1alpha1.MysqlSourceTableOption: - type: object - allOf: - - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - properties: - table: - type: string - title: table - whereClause: - type: string - title: where_clause - title: MysqlSourceTableOption - additionalProperties: false - mgmt.v1alpha1.MysqlTruncateTableConfig: - type: object - properties: - truncateBeforeInsert: - type: boolean - title: truncate_before_insert - title: MysqlTruncateTableConfig - additionalProperties: false - mgmt.v1alpha1.PauseJobRequest: - type: object - allOf: - - anyOf: - - required: - - note - - not: - anyOf: - - required: - - note - anyOf: - - required: - - note - - not: - anyOf: - - required: - - note - properties: - id: - type: string - title: id - format: uuid - pause: - type: boolean - title: pause - note: - type: string - title: note - title: PauseJobRequest - additionalProperties: false - mgmt.v1alpha1.PauseJobResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: PauseJobResponse - additionalProperties: false - mgmt.v1alpha1.PendingActivity: - type: object - allOf: - - anyOf: - - required: - - lastFailure - - not: - anyOf: - - required: - - lastFailure - anyOf: - - required: - - lastFailure - - not: - anyOf: - - required: - - lastFailure - properties: - status: - allOf: - - title: status - - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityStatus' - activityName: - type: string - title: activity_name - lastFailure: - allOf: - - title: last_failure - - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityFailure' - title: PendingActivity - additionalProperties: false - mgmt.v1alpha1.PostgresDestinationConnectionOptions: - type: object - properties: - truncateTable: - allOf: - - title: truncate_table - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresTruncateTableConfig' - initTableSchema: - type: boolean - title: init_table_schema - onConflict: - allOf: - - title: on_conflict - - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresOnConflictConfig' - skipForeignKeyViolations: - type: boolean - title: skip_foreign_key_violations - description: >- - Insert all valid records, skipping any that violate foreign key - constraints. - title: PostgresDestinationConnectionOptions - additionalProperties: false - mgmt.v1alpha1.PostgresOnConflictConfig: - type: object - properties: - doNothing: - type: boolean - title: do_nothing - title: PostgresOnConflictConfig - additionalProperties: false - mgmt.v1alpha1.PostgresSourceConnectionOptions: - type: object - properties: - haltOnNewColumnAddition: - type: boolean - title: halt_on_new_column_addition - schemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaOption' - title: schemas - connectionId: - type: string - title: connection_id - format: uuid - subsetByForeignKeyConstraints: - type: boolean - title: subset_by_foreign_key_constraints - title: PostgresSourceConnectionOptions - additionalProperties: false - mgmt.v1alpha1.PostgresSourceSchemaOption: - type: object - properties: - schema: - type: string - title: schema - tables: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceTableOption' - title: tables - title: PostgresSourceSchemaOption - additionalProperties: false - mgmt.v1alpha1.PostgresSourceSchemaSubset: - type: object - properties: - postgresSchemas: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.PostgresSourceSchemaOption' - title: postgres_schemas - title: PostgresSourceSchemaSubset - additionalProperties: false - mgmt.v1alpha1.PostgresSourceTableOption: - type: object - allOf: - - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - anyOf: - - required: - - whereClause - - not: - anyOf: - - required: - - whereClause - properties: - table: - type: string - title: table - whereClause: - type: string - title: where_clause - title: PostgresSourceTableOption - additionalProperties: false - mgmt.v1alpha1.PostgresTruncateTableConfig: - type: object - properties: - truncateBeforeInsert: - type: boolean - title: truncate_before_insert - cascade: - type: boolean - title: cascade - title: PostgresTruncateTableConfig - additionalProperties: false - mgmt.v1alpha1.RetryPolicy: - type: object - allOf: - - anyOf: - - required: - - maximumAttempts - - not: - anyOf: - - required: - - maximumAttempts - anyOf: - - required: - - maximumAttempts - - not: - anyOf: - - required: - - maximumAttempts - properties: - maximumAttempts: - type: integer - title: maximum_attempts - description: >- - Maximum number of attempts. When exceeded the retries stop even if - not expired yet. - If not set or set to 0, it means unlimited, and rely on activity ScheduleToCloseTimeout to stop. - title: RetryPolicy - additionalProperties: false - description: Defines the retry policy for an activity - mgmt.v1alpha1.RunContextKey: - type: object - properties: - jobRunId: - type: string - title: job_run_id - minLength: 1 - description: The Neosync Run ID - externalId: - type: string - title: external_id - minLength: 1 - description: An opaque identifier that will be used to store specific items - accountId: - type: string - title: account_id - minLength: 1 - description: The Neosync Account ID - title: RunContextKey - additionalProperties: false - mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - description: The unique identifier of the job to update subsets for - schemas: - allOf: - - title: schemas - description: The subset configuration - - $ref: '#/components/schemas/mgmt.v1alpha1.JobSourceSqlSubetSchemas' - subsetByForeignKeyConstraints: - type: boolean - title: subset_by_foreign_key_constraints - description: >- - Whether or not to have subsets follow foreign key constraints (for - connections that support it) - title: SetJobSourceSqlConnectionSubsetsRequest - additionalProperties: false - mgmt.v1alpha1.SetJobSourceSqlConnectionSubsetsResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: SetJobSourceSqlConnectionSubsetsResponse - additionalProperties: false - mgmt.v1alpha1.SetJobSyncOptionsRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - description: The unique identifier of the job - syncOptions: - allOf: - - title: sync_options - description: >- - The sync options object. The entire object must be provided and - will fully overwrite the previous result - - $ref: '#/components/schemas/mgmt.v1alpha1.ActivityOptions' - title: SetJobSyncOptionsRequest - additionalProperties: false - mgmt.v1alpha1.SetJobSyncOptionsResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: SetJobSyncOptionsResponse - additionalProperties: false - mgmt.v1alpha1.SetJobWorkflowOptionsRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - description: The unique identifier of the job - worfklowOptions: - allOf: - - title: worfklow_options - description: >- - The workflow options object. The entire object must be provided - and will fully overwrite the previous result - - $ref: '#/components/schemas/mgmt.v1alpha1.WorkflowOptions' - title: SetJobWorkflowOptionsRequest - additionalProperties: false - mgmt.v1alpha1.SetJobWorkflowOptionsResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: SetJobWorkflowOptionsResponse - additionalProperties: false - mgmt.v1alpha1.SetRunContextRequest: - type: object - properties: - id: - allOf: - - title: id - - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' - value: - type: string - title: value - format: byte - description: An opaque value that is to be determined by the key - title: SetRunContextRequest - additionalProperties: false - mgmt.v1alpha1.SetRunContextResponse: - type: object - title: SetRunContextResponse - additionalProperties: false - mgmt.v1alpha1.SetRunContextsRequest: - type: object - properties: - id: - allOf: - - title: id - - $ref: '#/components/schemas/mgmt.v1alpha1.RunContextKey' - value: - type: string - title: value - format: byte - description: An opaque value that is to be determined by the key - title: SetRunContextsRequest - additionalProperties: false - mgmt.v1alpha1.SetRunContextsResponse: - type: object - title: SetRunContextsResponse - additionalProperties: false - mgmt.v1alpha1.TerminateJobRunRequest: - type: object - properties: - jobRunId: - type: string - title: job_run_id - accountId: - type: string - title: account_id - format: uuid - title: TerminateJobRunRequest - additionalProperties: false - mgmt.v1alpha1.TerminateJobRunResponse: - type: object - title: TerminateJobRunResponse - additionalProperties: false - mgmt.v1alpha1.UpdateJobDestinationConnectionRequest: - type: object - properties: - jobId: - type: string - title: job_id - format: uuid - connectionId: - type: string - title: connection_id - format: uuid - options: - allOf: - - title: options - - $ref: '#/components/schemas/mgmt.v1alpha1.JobDestinationOptions' - destinationId: - type: string - title: destination_id - title: UpdateJobDestinationConnectionRequest - additionalProperties: false - mgmt.v1alpha1.UpdateJobDestinationConnectionResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: UpdateJobDestinationConnectionResponse - additionalProperties: false - mgmt.v1alpha1.UpdateJobScheduleRequest: - type: object - allOf: - - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - anyOf: - - required: - - cronSchedule - - not: - anyOf: - - required: - - cronSchedule - properties: - id: - type: string - title: id - format: uuid - cronSchedule: - type: string - title: cron_schedule - title: UpdateJobScheduleRequest - additionalProperties: false - mgmt.v1alpha1.UpdateJobScheduleResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: UpdateJobScheduleResponse - additionalProperties: false - mgmt.v1alpha1.UpdateJobSourceConnectionRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.JobSource' - mappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' - title: mappings - virtualForeignKeys: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' - title: virtual_foreign_keys - title: UpdateJobSourceConnectionRequest - additionalProperties: false - mgmt.v1alpha1.UpdateJobSourceConnectionResponse: - type: object - properties: - job: - allOf: - - title: job - - $ref: '#/components/schemas/mgmt.v1alpha1.Job' - title: UpdateJobSourceConnectionResponse - additionalProperties: false - mgmt.v1alpha1.ValidateJobMappingsRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - description: The unique account identifier that this job will be associated with - mappings: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.JobMapping' - title: mappings - connectionId: - type: string - title: connection_id - virtualForeignKeys: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignConstraint' - title: virtual_foreign_keys - title: ValidateJobMappingsRequest - additionalProperties: false - mgmt.v1alpha1.ValidateJobMappingsResponse: - type: object - properties: - columnErrors: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.ColumnError' - title: column_errors - databaseErrors: - allOf: - - title: database_errors - - $ref: '#/components/schemas/mgmt.v1alpha1.DatabaseError' - title: ValidateJobMappingsResponse - additionalProperties: false - mgmt.v1alpha1.VirtualForeignConstraint: - type: object - properties: - schema: - type: string - title: schema - table: - type: string - title: table - columns: - type: array - items: - type: string - title: columns - foreignKey: - allOf: - - title: foreign_key - - $ref: '#/components/schemas/mgmt.v1alpha1.VirtualForeignKey' - title: VirtualForeignConstraint - additionalProperties: false - mgmt.v1alpha1.VirtualForeignKey: - type: object - properties: - schema: - type: string - title: schema - table: - type: string - title: table - columns: - type: array - items: - type: string - title: columns - title: VirtualForeignKey - additionalProperties: false - mgmt.v1alpha1.WorkflowOptions: - type: object - allOf: - - anyOf: - - required: - - runTimeout - - not: - anyOf: - - required: - - runTimeout - anyOf: - - required: - - runTimeout - - not: - anyOf: - - required: - - runTimeout - properties: - runTimeout: - oneOf: - - type: string - - type: number - title: run_timeout - description: |- - The timeout for a single workflow run. - Measured in seconds - title: WorkflowOptions - additionalProperties: false - description: >- - Config that contains various timeouts that are configured in the - underlying temporal workflow - More options will come in the future as needed - mgmt.v1alpha1.RangedMetricName: - type: string - title: RangedMetricName - enum: - - RANGED_METRIC_NAME_UNSPECIFIED - - RANGED_METRIC_NAME_INPUT_RECEIVED - mgmt.v1alpha1.Date: - type: object - properties: - year: - type: integer - title: year - maximum: 9999 - description: >- - Year of the date. Must be from 1 to 9999, or 0 to specify a date - without - a year. - month: - type: integer - title: month - maximum: 31 - description: >- - Month of a year. Must be from 1 to 12, or 0 to specify a year - without a - month and day. - day: - type: integer - title: day - maximum: 31 - description: >- - Day of a month. Must be from 1 to 31 and valid for the year and - month, or 0 - to specify a year by itself or a year and month where the day isn't - significant. - title: Date - additionalProperties: false - description: >- - Represents a whole or partial calendar date, such as a birthday. The - time of - day and time zone are either specified elsewhere or are insignificant. The - date is relative to the Gregorian Calendar. This can represent one of the - following: - - * A full date, with non-zero year, month, and day values - * A month and day value, with a zero year, such as an anniversary - * A year on its own, with zero month and day values - * A year and month value, with a zero day, such as a credit card expiration - date - - Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and - `google.protobuf.Timestamp`. - mgmt.v1alpha1.DayResult: - type: object - properties: - date: - allOf: - - title: date - - $ref: '#/components/schemas/mgmt.v1alpha1.Date' - count: - oneOf: - - type: string - - type: number - title: count - title: DayResult - additionalProperties: false - mgmt.v1alpha1.GetDailyMetricCountRequest: - type: object - allOf: - - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - properties: - start: - allOf: - - title: start - description: The start day - - $ref: '#/components/schemas/mgmt.v1alpha1.Date' - end: - allOf: - - title: end - description: The end day - - $ref: '#/components/schemas/mgmt.v1alpha1.Date' - metric: - allOf: - - title: metric - description: The metric to return - - $ref: '#/components/schemas/mgmt.v1alpha1.RangedMetricName' - accountId: - type: string - title: account_id - format: uuid - description: The account identifier that will be used to filter by - jobId: - type: string - title: job_id - format: uuid - description: The job identifier that will be used to filter by - runId: - type: string - title: run_id - format: uuid - description: The run identifier that will be used to filter by - title: GetDailyMetricCountRequest - additionalProperties: false - mgmt.v1alpha1.GetDailyMetricCountResponse: - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.DayResult' - title: results - title: GetDailyMetricCountResponse - additionalProperties: false - mgmt.v1alpha1.GetMetricCountRequest: - type: object - allOf: - - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - - not: - anyOf: - - required: - - accountId - - required: - - jobId - - required: - - runId - properties: - start: - allOf: - - title: start - description: '@deprecated - use start_day' - - $ref: '#/components/schemas/google.protobuf.Timestamp' - end: - allOf: - - title: end - description: '@deprecated - use end_day' - - $ref: '#/components/schemas/google.protobuf.Timestamp' - metric: - allOf: - - title: metric - description: The metric to return - - $ref: '#/components/schemas/mgmt.v1alpha1.RangedMetricName' - accountId: - type: string - title: account_id - format: uuid - description: The account identifier that will be used to filter by - jobId: - type: string - title: job_id - format: uuid - description: The job identifier that will be used to filter by - runId: - type: string - title: run_id - format: uuid - description: The run identifier that will be used to filter by - startDay: - allOf: - - title: start_day - - $ref: '#/components/schemas/mgmt.v1alpha1.Date' - endDay: - allOf: - - title: end_day - - $ref: '#/components/schemas/mgmt.v1alpha1.Date' - title: GetMetricCountRequest - additionalProperties: false - mgmt.v1alpha1.GetMetricCountResponse: - type: object - properties: - count: - oneOf: - - type: string - - type: number - title: count - description: >- - The summed up count of the metric based on the input query and - timerange specified - title: GetMetricCountResponse - additionalProperties: false - mgmt.v1alpha1.SupportedJobType: - type: string - title: SupportedJobType - enum: - - SUPPORTED_JOB_TYPE_UNSPECIFIED - - SUPPORTED_JOB_TYPE_SYNC - - SUPPORTED_JOB_TYPE_GENERATE - mgmt.v1alpha1.TransformerDataType: - type: string - title: TransformerDataType - enum: - - TRANSFORMER_DATA_TYPE_UNSPECIFIED - - TRANSFORMER_DATA_TYPE_STRING - - TRANSFORMER_DATA_TYPE_INT64 - - TRANSFORMER_DATA_TYPE_BOOLEAN - - TRANSFORMER_DATA_TYPE_FLOAT64 - - TRANSFORMER_DATA_TYPE_NULL - - TRANSFORMER_DATA_TYPE_ANY - - TRANSFORMER_DATA_TYPE_TIME - - TRANSFORMER_DATA_TYPE_UUID - mgmt.v1alpha1.CreateUserDefinedTransformerRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - description: - type: string - title: description - type: - type: string - title: type - description: '@deprecated' - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' - transformerConfig: - allOf: - - title: transformer_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - title: CreateUserDefinedTransformerRequest - additionalProperties: false - mgmt.v1alpha1.CreateUserDefinedTransformerResponse: - type: object - properties: - transformer: - allOf: - - title: transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' - title: CreateUserDefinedTransformerResponse - additionalProperties: false - mgmt.v1alpha1.DeleteUserDefinedTransformerRequest: - type: object - properties: - transformerId: - type: string - title: transformer_id - format: uuid - title: DeleteUserDefinedTransformerRequest - additionalProperties: false - mgmt.v1alpha1.DeleteUserDefinedTransformerResponse: - type: object - title: DeleteUserDefinedTransformerResponse - additionalProperties: false - mgmt.v1alpha1.GetSystemTransformerBySourceRequest: - type: object - properties: - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' - title: GetSystemTransformerBySourceRequest - additionalProperties: false - mgmt.v1alpha1.GetSystemTransformerBySourceResponse: - type: object - properties: - transformer: - allOf: - - title: transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.SystemTransformer' - title: GetSystemTransformerBySourceResponse - additionalProperties: false - mgmt.v1alpha1.GetSystemTransformersRequest: - type: object - title: GetSystemTransformersRequest - additionalProperties: false - mgmt.v1alpha1.GetSystemTransformersResponse: - type: object - properties: - transformers: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.SystemTransformer' - title: transformers - title: GetSystemTransformersResponse - additionalProperties: false - mgmt.v1alpha1.GetUserDefinedTransformerByIdRequest: - type: object - properties: - transformerId: - type: string - title: transformer_id - format: uuid - title: GetUserDefinedTransformerByIdRequest - additionalProperties: false - mgmt.v1alpha1.GetUserDefinedTransformerByIdResponse: - type: object - properties: - transformer: - allOf: - - title: transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' - title: GetUserDefinedTransformerByIdResponse - additionalProperties: false - mgmt.v1alpha1.GetUserDefinedTransformersRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetUserDefinedTransformersRequest - additionalProperties: false - mgmt.v1alpha1.GetUserDefinedTransformersResponse: - type: object - properties: - transformers: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' - title: transformers - title: GetUserDefinedTransformersResponse - additionalProperties: false - mgmt.v1alpha1.IsTransformerNameAvailableRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - transformerName: - type: string - title: transformer_name - pattern: ^[a-z0-9-]{3,100}$ - title: IsTransformerNameAvailableRequest - additionalProperties: false - mgmt.v1alpha1.IsTransformerNameAvailableResponse: - type: object - properties: - isAvailable: - type: boolean - title: is_available - title: IsTransformerNameAvailableResponse - additionalProperties: false - mgmt.v1alpha1.SystemTransformer: - type: object - properties: - name: - type: string - title: name - description: - type: string - title: description - dataType: - allOf: - - title: data_type - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - dataTypes: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' - title: data_types - supportedJobTypes: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.SupportedJobType' - title: supported_job_types - title: SystemTransformer - additionalProperties: false - mgmt.v1alpha1.UpdateUserDefinedTransformerRequest: - type: object - properties: - transformerId: - type: string - title: transformer_id - format: uuid - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - description: - type: string - title: description - transformerConfig: - allOf: - - title: transformer_config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - title: UpdateUserDefinedTransformerRequest - additionalProperties: false - mgmt.v1alpha1.UpdateUserDefinedTransformerResponse: - type: object - properties: - transformer: - allOf: - - title: transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.UserDefinedTransformer' - title: UpdateUserDefinedTransformerResponse - additionalProperties: false - mgmt.v1alpha1.UserDefinedTransformer: - type: object - properties: - id: - type: string - title: id - format: uuid - name: - type: string - title: name - description: - type: string - title: description - dataType: - allOf: - - title: data_type - description: >- - This property is readonly and is calculated based off the origin - system transformer - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' - source: - allOf: - - title: source - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerSource' - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerConfig' - createdAt: - allOf: - - title: created_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - updatedAt: - allOf: - - title: updated_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - accountId: - type: string - title: account_id - dataTypes: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.TransformerDataType' - title: data_types - title: UserDefinedTransformer - additionalProperties: false - mgmt.v1alpha1.ValidateUserJavascriptCodeRequest: - type: object - properties: - accountId: - type: string - title: account_id - description: "@deprecated - an account isn't required to validate js code" - code: - type: string - title: code - minLength: 1 - title: ValidateUserJavascriptCodeRequest - additionalProperties: false - mgmt.v1alpha1.ValidateUserJavascriptCodeResponse: - type: object - properties: - valid: - type: boolean - title: valid - title: ValidateUserJavascriptCodeResponse - additionalProperties: false - mgmt.v1alpha1.ValidateUserRegexCodeRequest: - type: object - properties: - accountId: - type: string - title: account_id - description: "@deprecated - an account isn't required to validate js code" - userProvidedRegex: - type: string - title: user_provided_regex - title: ValidateUserRegexCodeRequest - additionalProperties: false - mgmt.v1alpha1.ValidateUserRegexCodeResponse: - type: object - properties: - valid: - type: boolean - title: valid - title: ValidateUserRegexCodeResponse - additionalProperties: false - mgmt.v1alpha1.AccountStatus: - type: string - title: AccountStatus - enum: - - ACCOUNT_STATUS_REASON_UNSPECIFIED - - ACCOUNT_STATUS_EXCEEDS_ALLOWED_LIMIT - - ACCOUNT_STATUS_REQUESTED_EXCEEDS_LIMIT - - ACCOUNT_STATUS_ACCOUNT_IN_EXPIRED_STATE - mgmt.v1alpha1.BillingStatus: - type: string - title: BillingStatus - enum: - - BILLING_STATUS_UNSPECIFIED - - BILLING_STATUS_ACTIVE - - BILLING_STATUS_EXPIRED - mgmt.v1alpha1.UserAccountType: - type: string - title: UserAccountType - enum: - - USER_ACCOUNT_TYPE_UNSPECIFIED - - USER_ACCOUNT_TYPE_PERSONAL - - USER_ACCOUNT_TYPE_TEAM - - USER_ACCOUNT_TYPE_ENTERPRISE - mgmt.v1alpha1.AcceptTeamAccountInviteRequest: - type: object - properties: - token: - type: string - title: token - minLength: 1 - title: AcceptTeamAccountInviteRequest - additionalProperties: false - mgmt.v1alpha1.AcceptTeamAccountInviteResponse: - type: object - properties: - account: - allOf: - - title: account - - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' - title: AcceptTeamAccountInviteResponse - additionalProperties: false - mgmt.v1alpha1.AccountInvite: - type: object - properties: - id: - type: string - title: id - accountId: - type: string - title: account_id - senderUserId: - type: string - title: sender_user_id - email: - type: string - title: email - token: - type: string - title: token - accepted: - type: boolean - title: accepted - createdAt: - allOf: - - title: created_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - updatedAt: - allOf: - - title: updated_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - expiresAt: - allOf: - - title: expires_at - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: AccountInvite - additionalProperties: false - mgmt.v1alpha1.AccountOnboardingConfig: - type: object - properties: - hasCreatedSourceConnection: - type: boolean - title: has_created_source_connection - description: '@deprecated - use has_completed_onboarding' - hasCreatedDestinationConnection: - type: boolean - title: has_created_destination_connection - description: '@deprecated - use has_completed_onboarding' - hasCreatedJob: - type: boolean - title: has_created_job - description: '@deprecated - use has_completed_onboarding' - hasInvitedMembers: - type: boolean - title: has_invited_members - description: '@deprecated - use has_completed_onboarding' - hasCompletedOnboarding: - type: boolean - title: has_completed_onboarding - title: AccountOnboardingConfig - additionalProperties: false - mgmt.v1alpha1.AccountTemporalConfig: - type: object - properties: - url: - type: string - title: url - minLength: 1 - namespace: - type: string - title: namespace - minLength: 1 - syncJobQueueName: - type: string - title: sync_job_queue_name - minLength: 1 - title: AccountTemporalConfig - additionalProperties: false - mgmt.v1alpha1.AccountUser: - type: object - properties: - id: - type: string - title: id - name: - type: string - title: name - image: - type: string - title: image - email: - type: string - title: email - title: AccountUser - additionalProperties: false - mgmt.v1alpha1.ConvertPersonalToTeamAccountRequest: - type: object - allOf: - - anyOf: - - required: - - accountId - - not: - anyOf: - - required: - - accountId - anyOf: - - required: - - accountId - - not: - anyOf: - - required: - - accountId - properties: - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - description: The name of the team account - accountId: - type: string - title: account_id - format: uuid - description: >- - Optionally provide the personal account to convert. This may be used - in break-glass scenarios where there are multiple personal accounts - And we want to convert one of them. If not provided, it will find the first one and convert it, leaving the other. - title: ConvertPersonalToTeamAccountRequest - additionalProperties: false - mgmt.v1alpha1.ConvertPersonalToTeamAccountResponse: - type: object - allOf: - - anyOf: - - required: - - checkoutSessionUrl - - not: - anyOf: - - required: - - checkoutSessionUrl - anyOf: - - required: - - checkoutSessionUrl - - not: - anyOf: - - required: - - checkoutSessionUrl - properties: - accountId: - type: string - title: account_id - description: >- - The id of the team account (will be the same identifier as the - personal account) - checkoutSessionUrl: - type: string - title: checkout_session_url - description: >- - If NeosyncCloud, will respond with a checkout session url so they - can setup billing - newPersonalAccountId: - type: string - title: new_personal_account_id - description: The identifier of the newly created personal account - title: ConvertPersonalToTeamAccountResponse - additionalProperties: false - mgmt.v1alpha1.CreateTeamAccountRequest: - type: object - properties: - name: - type: string - title: name - pattern: ^[a-z0-9-]{3,100}$ - description: The name of the team account - title: CreateTeamAccountRequest - additionalProperties: false - mgmt.v1alpha1.CreateTeamAccountResponse: - type: object - allOf: - - anyOf: - - required: - - checkoutSessionUrl - - not: - anyOf: - - required: - - checkoutSessionUrl - anyOf: - - required: - - checkoutSessionUrl - - not: - anyOf: - - required: - - checkoutSessionUrl - properties: - accountId: - type: string - title: account_id - checkoutSessionUrl: - type: string - title: checkout_session_url - description: >- - If NeosyncCloud, will respond with a checkout session url so they - can setup billing - title: CreateTeamAccountResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountBillingCheckoutSessionRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountBillingCheckoutSessionRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountBillingCheckoutSessionResponse: - type: object - properties: - checkoutSessionUrl: - type: string - title: checkout_session_url - description: The url that will be redirected to - title: GetAccountBillingCheckoutSessionResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountBillingPortalSessionRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountBillingPortalSessionRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountBillingPortalSessionResponse: - type: object - properties: - portalSessionUrl: - type: string - title: portal_session_url - description: The url that will be redirected to - title: GetAccountBillingPortalSessionResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountOnboardingConfigRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountOnboardingConfigRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountOnboardingConfigResponse: - type: object - properties: - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' - title: GetAccountOnboardingConfigResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountStatusRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountStatusRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountStatusResponse: - type: object - allOf: - - anyOf: - - required: - - allowedRecordCount - - not: - anyOf: - - required: - - allowedRecordCount - anyOf: - - required: - - allowedRecordCount - - not: - anyOf: - - required: - - allowedRecordCount - properties: - usedRecordCount: - oneOf: - - type: string - - type: number - title: used_record_count - description: >- - A count of the currently used records for the current billing - period. - This may go over the allowed record count depending on when the record count is polled by the metric system. - allowedRecordCount: - oneOf: - - type: string - - type: number - title: allowed_record_count - description: The allowed record count. It will be null if there is no limit. - subscriptionStatus: - allOf: - - title: subscription_status - description: >- - The current subscription status determined by the billing - system. - - $ref: '#/components/schemas/mgmt.v1alpha1.BillingStatus' - title: GetAccountStatusResponse - additionalProperties: false - mgmt.v1alpha1.GetAccountTemporalConfigRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetAccountTemporalConfigRequest - additionalProperties: false - mgmt.v1alpha1.GetAccountTemporalConfigResponse: - type: object - properties: - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' - title: GetAccountTemporalConfigResponse - additionalProperties: false - mgmt.v1alpha1.GetBillingAccountsRequest: - type: object - properties: - accountIds: - type: array - items: - type: string - title: account_ids - description: Optional list of account identifiers to filter the response by - title: GetBillingAccountsRequest - additionalProperties: false - mgmt.v1alpha1.GetBillingAccountsResponse: - type: object - properties: - accounts: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' - title: accounts - title: GetBillingAccountsResponse - additionalProperties: false - mgmt.v1alpha1.GetSystemInformationRequest: - type: object - title: GetSystemInformationRequest - additionalProperties: false - mgmt.v1alpha1.GetSystemInformationResponse: - type: object - properties: - version: - type: string - title: version - description: The Git tagged version - commit: - type: string - title: commit - description: The Git commit - compiler: - type: string - title: compiler - description: The Go compiler flag that was used to build this version of Neosync - platform: - type: string - title: platform - description: The Go platform flag that was used to build this version of Neosync - buildDate: - allOf: - - title: build_date - - $ref: '#/components/schemas/google.protobuf.Timestamp' - title: GetSystemInformationResponse - additionalProperties: false - mgmt.v1alpha1.GetTeamAccountInvitesRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetTeamAccountInvitesRequest - additionalProperties: false - mgmt.v1alpha1.GetTeamAccountInvitesResponse: - type: object - properties: - invites: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AccountInvite' - title: invites - title: GetTeamAccountInvitesResponse - additionalProperties: false - mgmt.v1alpha1.GetTeamAccountMembersRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: GetTeamAccountMembersRequest - additionalProperties: false - mgmt.v1alpha1.GetTeamAccountMembersResponse: - type: object - properties: - users: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.AccountUser' - title: users - title: GetTeamAccountMembersResponse - additionalProperties: false - mgmt.v1alpha1.GetUserAccountsRequest: - type: object - title: GetUserAccountsRequest - additionalProperties: false - mgmt.v1alpha1.GetUserAccountsResponse: - type: object - properties: - accounts: - type: array - items: - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccount' - title: accounts - title: GetUserAccountsResponse - additionalProperties: false - mgmt.v1alpha1.GetUserRequest: - type: object - title: GetUserRequest - additionalProperties: false - mgmt.v1alpha1.GetUserResponse: - type: object - properties: - userId: - type: string - title: user_id - title: GetUserResponse - additionalProperties: false - mgmt.v1alpha1.InviteUserToTeamAccountRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - email: - type: string - title: email - minLength: 1 - title: InviteUserToTeamAccountRequest - additionalProperties: false - mgmt.v1alpha1.InviteUserToTeamAccountResponse: - type: object - properties: - invite: - allOf: - - title: invite - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountInvite' - title: InviteUserToTeamAccountResponse - additionalProperties: false - mgmt.v1alpha1.IsAccountStatusValidRequest: - type: object - allOf: - - anyOf: - - required: - - requestedRecordCount - - not: - anyOf: - - required: - - requestedRecordCount - anyOf: - - required: - - requestedRecordCount - - not: - anyOf: - - required: - - requestedRecordCount - properties: - accountId: - type: string - title: account_id - format: uuid - requestedRecordCount: - oneOf: - - type: string - - type: number - title: requested_record_count - description: >- - An optional count of records to be added to the current usage for - validation. - title: IsAccountStatusValidRequest - additionalProperties: false - mgmt.v1alpha1.IsAccountStatusValidResponse: - type: object - allOf: - - anyOf: - - required: - - allowedRecordCount - - not: - anyOf: - - required: - - allowedRecordCount - - anyOf: - - required: - - reason - - not: - anyOf: - - required: - - reason - properties: - isValid: - type: boolean - title: is_valid - reason: - type: string - title: reason - description: If the account is not valid, a reason for why may be provided. - shouldPoll: - type: boolean - title: should_poll - description: >- - Whether or not the process should decide to continue polling for - validitiy updates - usedRecordCount: - oneOf: - - type: string - - type: number - title: used_record_count - description: >- - A count of the currently used records for the current billing - period. - This may go over the allowed record count depending on when the record count is polled by the metric system. - allowedRecordCount: - oneOf: - - type: string - - type: number - title: allowed_record_count - description: The allowed record count. It will be null if there is no limit. - accountStatus: - allOf: - - title: account_status - description: The current status of the account. Default is valid. - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountStatus' - title: IsAccountStatusValidResponse - additionalProperties: false - mgmt.v1alpha1.IsUserInAccountRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - title: IsUserInAccountRequest - additionalProperties: false - mgmt.v1alpha1.IsUserInAccountResponse: - type: object - properties: - ok: - type: boolean - title: ok - title: IsUserInAccountResponse - additionalProperties: false - mgmt.v1alpha1.RemoveTeamAccountInviteRequest: - type: object - properties: - id: - type: string - title: id - format: uuid - title: RemoveTeamAccountInviteRequest - additionalProperties: false - mgmt.v1alpha1.RemoveTeamAccountInviteResponse: - type: object - title: RemoveTeamAccountInviteResponse - additionalProperties: false - mgmt.v1alpha1.RemoveTeamAccountMemberRequest: - type: object - properties: - userId: - type: string - title: user_id - format: uuid - accountId: - type: string - title: account_id - format: uuid - title: RemoveTeamAccountMemberRequest - additionalProperties: false - mgmt.v1alpha1.RemoveTeamAccountMemberResponse: - type: object - title: RemoveTeamAccountMemberResponse - additionalProperties: false - mgmt.v1alpha1.SetAccountOnboardingConfigRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' - title: SetAccountOnboardingConfigRequest - additionalProperties: false - mgmt.v1alpha1.SetAccountOnboardingConfigResponse: - type: object - properties: - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountOnboardingConfig' - title: SetAccountOnboardingConfigResponse - additionalProperties: false - mgmt.v1alpha1.SetAccountTemporalConfigRequest: - type: object - properties: - accountId: - type: string - title: account_id - format: uuid - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' - title: SetAccountTemporalConfigRequest - additionalProperties: false - mgmt.v1alpha1.SetAccountTemporalConfigResponse: - type: object - properties: - config: - allOf: - - title: config - - $ref: '#/components/schemas/mgmt.v1alpha1.AccountTemporalConfig' - title: SetAccountTemporalConfigResponse - additionalProperties: false - mgmt.v1alpha1.SetBillingMeterEventRequest: - type: object - allOf: - - anyOf: - - required: - - timestamp - - not: - anyOf: - - required: - - timestamp - anyOf: - - required: - - timestamp - - not: - anyOf: - - required: - - timestamp - properties: - accountId: - type: string - title: account_id - format: uuid - description: The account id to apply this metered event to - eventName: - type: string - title: event_name - minLength: 1 - description: The metered event name - value: - type: string - title: value - minLength: 1 - description: The value of the meter for the given time - eventId: - type: string - title: event_id - minLength: 1 - description: The unique identifier of this metered event - timestamp: - oneOf: - - type: string - - type: number - title: timestamp - description: >- - The time of the event in Unix Epoch format. Defaults to the current - timestamp if not specified. - title: SetBillingMeterEventRequest - additionalProperties: false - mgmt.v1alpha1.SetBillingMeterEventResponse: - type: object - title: SetBillingMeterEventResponse - additionalProperties: false - mgmt.v1alpha1.SetPersonalAccountRequest: - type: object - title: SetPersonalAccountRequest - additionalProperties: false - mgmt.v1alpha1.SetPersonalAccountResponse: - type: object - properties: - accountId: - type: string - title: account_id - title: SetPersonalAccountResponse - additionalProperties: false - mgmt.v1alpha1.SetUserRequest: - type: object - title: SetUserRequest - additionalProperties: false - mgmt.v1alpha1.SetUserResponse: - type: object - properties: - userId: - type: string - title: user_id - title: SetUserResponse - additionalProperties: false - mgmt.v1alpha1.UserAccount: - type: object - properties: - id: - type: string - title: id - description: The unique identifier of the account - name: - type: string - title: name - description: The account slug - type: - allOf: - - title: type - description: The type of account - - $ref: '#/components/schemas/mgmt.v1alpha1.UserAccountType' - hasStripeCustomerId: - type: boolean - title: has_stripe_customer_id - description: Whether or not the account has an associated stripe customer id - title: UserAccount - additionalProperties: false -x-tagGroups: - - name: mgmt.v1alpha1 - tags: - - mgmt.v1alpha1.AnonymizationService - - mgmt.v1alpha1.ApiKeyService - - mgmt.v1alpha1.AuthService - - mgmt.v1alpha1.ConnectionService - - mgmt.v1alpha1.ConnectionDataService - - mgmt.v1alpha1.JobService - - mgmt.v1alpha1.MetricsService - - mgmt.v1alpha1.TransformersService - - mgmt.v1alpha1.UserAccountService diff --git a/schema_only.sql b/schema_only.sql deleted file mode 100644 index 6865a4da0a..0000000000 --- a/schema_only.sql +++ /dev/null @@ -1,4 +0,0 @@ -Msg 102, Level 15, State 1, Server 07735386916f, Line 1 -Incorrect syntax near '.'. -Msg 102, Level 15, State 1, Server 07735386916f, Line 1 -Incorrect syntax near '.'. From 8ed73928377a527db9116747c5b5e74d7e875e36 Mon Sep 17 00:00:00 2001 From: Evis Drenova Date: Thu, 24 Oct 2024 17:02:58 -0700 Subject: [PATCH 3/3] update compose --- compose.dev.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/compose.dev.yml b/compose.dev.yml index 7af4f64ad6..ad94d9d763 100644 --- a/compose.dev.yml +++ b/compose.dev.yml @@ -8,7 +8,7 @@ include: # - path: ./compose/compose-db-mysql.yml # - path: ./compose/compose-db-mongo.yml # - path: ./compose/compose-db-dynamo.yml - - path: ./compose/compose-db-mssql.yml + # - path: ./compose/compose-db-mssql.yml services: app: