kb-cloud-client-typescript 2.4.0-alpha.52 → 2.4.0-alpha.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/adminapi.yaml CHANGED
@@ -26260,6 +26260,40 @@ paths:
26260
26260
  $ref: '#/components/responses/404'
26261
26261
  tags:
26262
26262
  - dataReplication
26263
+ /admin/v1/organizations/{orgName}/replication/channel:
26264
+ post:
26265
+ operationId: createAdminDataChannel
26266
+ summary: Create a new data channel
26267
+ description: Create a new data channel.
26268
+ parameters:
26269
+ - description: The Name of the organization
26270
+ in: path
26271
+ name: orgName
26272
+ required: true
26273
+ schema:
26274
+ type: string
26275
+ requestBody:
26276
+ content:
26277
+ application/json:
26278
+ schema:
26279
+ $ref: '#/components/schemas/dataReplicationCreate'
26280
+ required: true
26281
+ responses:
26282
+ '200':
26283
+ content:
26284
+ application/json:
26285
+ schema:
26286
+ $ref: '#/components/schemas/dataChannelResponse'
26287
+ description: A successful response.
26288
+ '401':
26289
+ $ref: '#/components/responses/401'
26290
+ '403':
26291
+ $ref: '#/components/responses/403'
26292
+ '404':
26293
+ $ref: '#/components/responses/404'
26294
+ tags:
26295
+ - dataReplication
26296
+ x-codegen-request-body-name: body
26263
26297
  /admin/v1/organizations/{orgName}/replication/channel/{channelID}:
26264
26298
  get:
26265
26299
  operationId: getDataChannel
@@ -26361,39 +26395,67 @@ paths:
26361
26395
  tags:
26362
26396
  - dataReplication
26363
26397
  x-codegen-request-body-name: body
26364
- /admin/v1/checks:
26365
- get:
26366
- operationId: listAdminDataChecks
26367
- summary: List Data Checks
26368
- description: Retrieve a list of standalone data checks.
26398
+ /admin/v1/organizations/{orgName}/replication/channel/objects:
26399
+ post:
26400
+ operationId: queryReplicationObject
26401
+ summary: query replication object
26402
+ description: query replication object.
26369
26403
  parameters:
26370
26404
  - description: The Name of the organization
26371
- in: query
26405
+ in: path
26372
26406
  name: orgName
26373
- required: false
26407
+ required: true
26374
26408
  schema:
26375
26409
  type: string
26376
- - description: The name of the check
26377
- in: query
26378
- name: name
26379
- required: false
26410
+ requestBody:
26411
+ content:
26412
+ application/json:
26413
+ schema:
26414
+ $ref: '#/components/schemas/replicationObjectQuery'
26415
+ required: true
26416
+ responses:
26417
+ '200':
26418
+ content:
26419
+ application/json:
26420
+ schema:
26421
+ $ref: '#/components/schemas/replicationObjectTree'
26422
+ description: A successful response.
26423
+ '401':
26424
+ $ref: '#/components/responses/401'
26425
+ '403':
26426
+ $ref: '#/components/responses/403'
26427
+ '404':
26428
+ $ref: '#/components/responses/404'
26429
+ '501':
26430
+ $ref: '#/components/responses/501'
26431
+ tags:
26432
+ - dataReplication
26433
+ x-codegen-request-body-name: body
26434
+ /admin/v1/organizations/{orgName}/replication/channel/precheck:
26435
+ post:
26436
+ operationId: createPreCheck
26437
+ summary: create pre check
26438
+ description: create pre check.
26439
+ parameters:
26440
+ - description: The Name of the organization
26441
+ in: path
26442
+ name: orgName
26443
+ required: true
26380
26444
  schema:
26381
26445
  type: string
26382
- - description: The status of the check
26383
- in: query
26384
- name: status
26385
- required: false
26386
- schema:
26387
- type: array
26388
- items:
26389
- type: string
26446
+ requestBody:
26447
+ content:
26448
+ application/json:
26449
+ schema:
26450
+ $ref: '#/components/schemas/preCheckCreate'
26451
+ required: true
26390
26452
  responses:
26391
26453
  '200':
26392
26454
  content:
26393
26455
  application/json:
26394
26456
  schema:
26395
- $ref: '#/components/schemas/dataCheckList'
26396
- description: A list of checks.
26457
+ $ref: '#/components/schemas/preCheckTaskResponse'
26458
+ description: A successful response.
26397
26459
  '401':
26398
26460
  $ref: '#/components/responses/401'
26399
26461
  '403':
@@ -26402,21 +26464,22 @@ paths:
26402
26464
  $ref: '#/components/responses/404'
26403
26465
  tags:
26404
26466
  - dataReplication
26405
- /admin/v1/organizations/{orgName}/checks/{checkID}:
26467
+ x-codegen-request-body-name: body
26468
+ /admin/v1/organizations/{orgName}/replication/channel/precheck/{preCheckID}:
26406
26469
  get:
26407
- operationId: getDataCheck
26408
- summary: Get Data Check
26409
- description: Retrieve a standalone data check detail.
26470
+ operationId: getPreCheck
26471
+ summary: get preCheck
26472
+ description: get preCheck.
26410
26473
  parameters:
26411
- - description: The Name of the organization
26474
+ - description: The ID of the preCheck task
26412
26475
  in: path
26413
- name: orgName
26476
+ name: preCheckID
26414
26477
  required: true
26415
26478
  schema:
26416
26479
  type: string
26417
- - description: The ID of the check
26480
+ - description: The Name of the organization
26418
26481
  in: path
26419
- name: checkID
26482
+ name: orgName
26420
26483
  required: true
26421
26484
  schema:
26422
26485
  type: string
@@ -26425,8 +26488,8 @@ paths:
26425
26488
  content:
26426
26489
  application/json:
26427
26490
  schema:
26428
- $ref: '#/components/schemas/dataCheckItem'
26429
- description: A check detail.
26491
+ $ref: '#/components/schemas/preCheckTaskDetail'
26492
+ description: A successful response.
26430
26493
  '401':
26431
26494
  $ref: '#/components/responses/401'
26432
26495
  '403':
@@ -26436,26 +26499,27 @@ paths:
26436
26499
  tags:
26437
26500
  - dataReplication
26438
26501
  delete:
26439
- operationId: deleteDataCheck
26440
- summary: Delete a data check
26441
- description: Delete a standalone data check and its runtime resources.
26502
+ deprecated: true
26503
+ operationId: deletePreCheck
26504
+ summary: delete preCheck
26505
+ description: delete preCheck.
26442
26506
  parameters:
26443
- - description: The Name of the organization
26507
+ - description: The ID of the preCheck task
26444
26508
  in: path
26445
- name: orgName
26509
+ name: preCheckID
26446
26510
  required: true
26447
26511
  schema:
26448
26512
  type: string
26449
- - description: The ID of the check
26513
+ - description: The Name of the organization
26450
26514
  in: path
26451
- name: checkID
26515
+ name: orgName
26452
26516
  required: true
26453
26517
  schema:
26454
26518
  type: string
26455
26519
  responses:
26456
26520
  '204':
26457
26521
  content: {}
26458
- description: Returned when check is deleted successfully.
26522
+ description: Returned when preCheck is deleted successfully.
26459
26523
  '401':
26460
26524
  $ref: '#/components/responses/401'
26461
26525
  '403':
@@ -26464,11 +26528,11 @@ paths:
26464
26528
  $ref: '#/components/responses/404'
26465
26529
  tags:
26466
26530
  - dataReplication
26467
- /admin/v1/organizations/{orgName}/checks/{checkID}/details:
26531
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/logs:
26468
26532
  get:
26469
- operationId: getDataCheckDetails
26470
- summary: Get Data Check Difference Details
26471
- description: Read typed check miss or diff details from the latest parsed check result.
26533
+ description: Query logs of a data channel
26534
+ summary: Query data channel logs
26535
+ operationId: queryDataChannelLogs
26472
26536
  parameters:
26473
26537
  - description: The Name of the organization
26474
26538
  in: path
@@ -26476,60 +26540,31 @@ paths:
26476
26540
  required: true
26477
26541
  schema:
26478
26542
  type: string
26479
- - description: The ID of the check
26480
- in: path
26481
- name: checkID
26543
+ - in: path
26544
+ name: channelID
26482
26545
  required: true
26483
26546
  schema:
26484
26547
  type: string
26485
- - description: The detail type
26486
- in: query
26487
- name: type
26488
- required: true
26489
- schema:
26490
- $ref: '#/components/schemas/dataCheckDetailType'
26491
- - description: Source schema or database. Required for snapshot checks.
26492
- in: query
26493
- name: schema
26494
- required: false
26548
+ - in: query
26549
+ name: moduleName
26495
26550
  schema:
26496
26551
  type: string
26497
- - description: Source table. Required for snapshot checks.
26498
- in: query
26499
- name: table
26500
- required: false
26552
+ - in: query
26553
+ name: containerName
26501
26554
  schema:
26502
26555
  type: string
26503
- - description: Struct object key. Optional for struct checks; omitted to page all struct details.
26504
- in: query
26505
- name: key
26506
26556
  required: false
26557
+ - in: query
26558
+ name: limit
26507
26559
  schema:
26508
26560
  type: string
26509
- - description: Page number for pagination.
26510
- in: query
26511
- name: page
26512
- required: false
26513
- schema:
26514
- type: integer
26515
- minimum: 1
26516
- default: 1
26517
- - description: Number of items per page.
26518
- in: query
26519
- name: pageSize
26520
- required: false
26521
- schema:
26522
- type: integer
26523
- minimum: 1
26524
- maximum: 1000
26525
- default: 100
26526
26561
  responses:
26527
26562
  '200':
26528
26563
  content:
26529
- application/json:
26564
+ text/plain:
26530
26565
  schema:
26531
- $ref: '#/components/schemas/dataCheckDetails'
26532
- description: A successful response.
26566
+ type: string
26567
+ description: channel logs output
26533
26568
  '401':
26534
26569
  $ref: '#/components/responses/401'
26535
26570
  '403':
@@ -26538,11 +26573,11 @@ paths:
26538
26573
  $ref: '#/components/responses/404'
26539
26574
  tags:
26540
26575
  - dataReplication
26541
- /admin/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
26576
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/containers:
26542
26577
  get:
26543
- operationId: getDataCheckSQLLogs
26544
- summary: Get Data Check SQL Logs
26545
- description: Read raw SQL lines emitted by check sql_logger entries.
26578
+ description: Query containers of a data channel module pod
26579
+ summary: Query data channel module pod containers
26580
+ operationId: queryDataChannelContainers
26546
26581
  parameters:
26547
26582
  - description: The Name of the organization
26548
26583
  in: path
@@ -26550,19 +26585,24 @@ paths:
26550
26585
  required: true
26551
26586
  schema:
26552
26587
  type: string
26553
- - description: The ID of the check
26554
- in: path
26555
- name: checkID
26588
+ - in: path
26589
+ name: channelID
26556
26590
  required: true
26557
26591
  schema:
26558
26592
  type: string
26593
+ - in: query
26594
+ name: moduleName
26595
+ schema:
26596
+ type: string
26559
26597
  responses:
26560
26598
  '200':
26561
26599
  content:
26562
- text/plain:
26600
+ application/json:
26563
26601
  schema:
26564
- type: string
26565
- description: Raw SQL lines.
26602
+ type: array
26603
+ items:
26604
+ $ref: '#/components/schemas/dataReplicationChannelContainer'
26605
+ description: A list of data channel module containers.
26566
26606
  '401':
26567
26607
  $ref: '#/components/responses/401'
26568
26608
  '403':
@@ -26571,11 +26611,11 @@ paths:
26571
26611
  $ref: '#/components/responses/404'
26572
26612
  tags:
26573
26613
  - dataReplication
26574
- /admin/v1/organizations/{orgName}/replication/channel/{channelID}/ops/{opsType}:
26575
- post:
26576
- operationId: createDataChannelOps
26577
- summary: Create a new data channel ops
26578
- description: Create a new data channel ops.
26614
+ /admin/v1/organizations/{orgName}/replication/channel/parameters:
26615
+ get:
26616
+ operationId: listDataChannelParameters
26617
+ summary: List Data Channel Parameters
26618
+ description: Retrieve a list of data channel parameters.
26579
26619
  parameters:
26580
26620
  - description: The Name of the organization
26581
26621
  in: path
@@ -26583,46 +26623,29 @@ paths:
26583
26623
  required: true
26584
26624
  schema:
26585
26625
  type: string
26626
+ - description: The name of the standard definition
26627
+ in: query
26628
+ name: standardName
26629
+ schema:
26630
+ type: string
26586
26631
  - description: The ID of the data channel
26587
- in: path
26632
+ in: query
26588
26633
  name: channelID
26589
- required: true
26590
26634
  schema:
26591
26635
  type: string
26592
- - description: The operation type
26593
- in: path
26594
- name: opsType
26595
- required: true
26636
+ - description: The source EngineDeifnition name
26637
+ in: query
26638
+ name: source
26596
26639
  schema:
26597
- $ref: '#/components/schemas/dataReplicationOpsType'
26598
- responses:
26599
- '204':
26600
- content: {}
26601
- description: Returned when operation is completed successfully.
26602
- '401':
26603
- $ref: '#/components/responses/401'
26604
- '403':
26605
- $ref: '#/components/responses/403'
26606
- '404':
26607
- $ref: '#/components/responses/404'
26608
- tags:
26609
- - dataReplication
26610
- /admin/v1/organizations/{orgName}/replication/channel/{channelID}/events:
26611
- get:
26612
- operationId: listDataChannelEvents
26613
- summary: List Data Channel Events
26614
- description: Retrieve a list of data channel events.
26615
- parameters:
26616
- - description: The Name of the organization
26617
- in: path
26618
- name: orgName
26619
- required: true
26640
+ type: string
26641
+ - description: The target EngineDeifnition name
26642
+ in: query
26643
+ name: target
26620
26644
  schema:
26621
26645
  type: string
26622
- - description: The ID of the data channel
26623
- in: path
26624
- name: channelID
26625
- required: true
26646
+ - description: The module name
26647
+ in: query
26648
+ name: moduleName
26626
26649
  schema:
26627
26650
  type: string
26628
26651
  responses:
@@ -26630,8 +26653,8 @@ paths:
26630
26653
  content:
26631
26654
  application/json:
26632
26655
  schema:
26633
- $ref: '#/components/schemas/dataReplicationEventList'
26634
- description: A list of data channel events.
26656
+ $ref: '#/components/schemas/dataReplicationParametersResponse'
26657
+ description: A list of data channel parameters.
26635
26658
  '401':
26636
26659
  $ref: '#/components/responses/401'
26637
26660
  '403':
@@ -26640,47 +26663,52 @@ paths:
26640
26663
  $ref: '#/components/responses/404'
26641
26664
  tags:
26642
26665
  - dataReplication
26643
- /admin/v1/organizations/{orgName}/replication/channel/objects:
26644
- post:
26645
- operationId: queryReplicationObject
26646
- summary: query replication object
26647
- description: query replication object.
26666
+ /admin/v1/checks:
26667
+ get:
26668
+ operationId: listAdminDataChecks
26669
+ summary: List Data Checks
26670
+ description: Retrieve a list of standalone data checks.
26648
26671
  parameters:
26649
26672
  - description: The Name of the organization
26650
- in: path
26673
+ in: query
26651
26674
  name: orgName
26652
- required: true
26675
+ required: false
26653
26676
  schema:
26654
26677
  type: string
26655
- requestBody:
26656
- content:
26657
- application/json:
26658
- schema:
26659
- $ref: '#/components/schemas/replicationObjectQuery'
26660
- required: true
26678
+ - description: The name of the check
26679
+ in: query
26680
+ name: name
26681
+ required: false
26682
+ schema:
26683
+ type: string
26684
+ - description: The status of the check
26685
+ in: query
26686
+ name: status
26687
+ required: false
26688
+ schema:
26689
+ type: array
26690
+ items:
26691
+ type: string
26661
26692
  responses:
26662
26693
  '200':
26663
26694
  content:
26664
26695
  application/json:
26665
26696
  schema:
26666
- $ref: '#/components/schemas/replicationObjectTree'
26667
- description: A successful response.
26697
+ $ref: '#/components/schemas/dataCheckList'
26698
+ description: A list of checks.
26668
26699
  '401':
26669
26700
  $ref: '#/components/responses/401'
26670
26701
  '403':
26671
26702
  $ref: '#/components/responses/403'
26672
26703
  '404':
26673
26704
  $ref: '#/components/responses/404'
26674
- '501':
26675
- $ref: '#/components/responses/501'
26676
26705
  tags:
26677
26706
  - dataReplication
26678
- x-codegen-request-body-name: body
26679
- /admin/v1/organizations/{orgName}/replication/channel/precheck:
26707
+ /admin/v1/organizations/{orgName}/checks:
26680
26708
  post:
26681
- operationId: createPreCheck
26682
- summary: create pre check
26683
- description: create pre check.
26709
+ operationId: createAdminDataCheck
26710
+ summary: Create a data check
26711
+ description: 'Create an independent data check. The request must use exactly one entry point: provide channelID with checkType, or provide the full direct check configuration.'
26684
26712
  parameters:
26685
26713
  - description: The Name of the organization
26686
26714
  in: path
@@ -26692,14 +26720,14 @@ paths:
26692
26720
  content:
26693
26721
  application/json:
26694
26722
  schema:
26695
- $ref: '#/components/schemas/preCheckCreate'
26723
+ $ref: '#/components/schemas/dataCheckCreate'
26696
26724
  required: true
26697
26725
  responses:
26698
26726
  '200':
26699
26727
  content:
26700
26728
  application/json:
26701
26729
  schema:
26702
- $ref: '#/components/schemas/preCheckTaskResponse'
26730
+ $ref: '#/components/schemas/dataCheckResponse'
26703
26731
  description: A successful response.
26704
26732
  '401':
26705
26733
  $ref: '#/components/responses/401'
@@ -26710,21 +26738,21 @@ paths:
26710
26738
  tags:
26711
26739
  - dataReplication
26712
26740
  x-codegen-request-body-name: body
26713
- /admin/v1/organizations/{orgName}/replication/channel/precheck/{preCheckID}:
26741
+ /admin/v1/organizations/{orgName}/checks/{checkID}:
26714
26742
  get:
26715
- operationId: getPreCheck
26716
- summary: get preCheck
26717
- description: get preCheck.
26743
+ operationId: getDataCheck
26744
+ summary: Get Data Check
26745
+ description: Retrieve a standalone data check detail.
26718
26746
  parameters:
26719
- - description: The ID of the preCheck task
26747
+ - description: The Name of the organization
26720
26748
  in: path
26721
- name: preCheckID
26749
+ name: orgName
26722
26750
  required: true
26723
26751
  schema:
26724
26752
  type: string
26725
- - description: The Name of the organization
26753
+ - description: The ID of the check
26726
26754
  in: path
26727
- name: orgName
26755
+ name: checkID
26728
26756
  required: true
26729
26757
  schema:
26730
26758
  type: string
@@ -26733,8 +26761,8 @@ paths:
26733
26761
  content:
26734
26762
  application/json:
26735
26763
  schema:
26736
- $ref: '#/components/schemas/preCheckTaskDetail'
26737
- description: A successful response.
26764
+ $ref: '#/components/schemas/dataCheckItem'
26765
+ description: A check detail.
26738
26766
  '401':
26739
26767
  $ref: '#/components/responses/401'
26740
26768
  '403':
@@ -26744,27 +26772,26 @@ paths:
26744
26772
  tags:
26745
26773
  - dataReplication
26746
26774
  delete:
26747
- deprecated: true
26748
- operationId: deletePreCheck
26749
- summary: delete preCheck
26750
- description: delete preCheck.
26775
+ operationId: deleteDataCheck
26776
+ summary: Delete a data check
26777
+ description: Delete a standalone data check and its runtime resources.
26751
26778
  parameters:
26752
- - description: The ID of the preCheck task
26779
+ - description: The Name of the organization
26753
26780
  in: path
26754
- name: preCheckID
26781
+ name: orgName
26755
26782
  required: true
26756
26783
  schema:
26757
26784
  type: string
26758
- - description: The Name of the organization
26785
+ - description: The ID of the check
26759
26786
  in: path
26760
- name: orgName
26787
+ name: checkID
26761
26788
  required: true
26762
26789
  schema:
26763
26790
  type: string
26764
26791
  responses:
26765
26792
  '204':
26766
26793
  content: {}
26767
- description: Returned when preCheck is deleted successfully.
26794
+ description: Returned when check is deleted successfully.
26768
26795
  '401':
26769
26796
  $ref: '#/components/responses/401'
26770
26797
  '403':
@@ -26773,11 +26800,11 @@ paths:
26773
26800
  $ref: '#/components/responses/404'
26774
26801
  tags:
26775
26802
  - dataReplication
26776
- /admin/v1/organizations/{orgName}/replication/channel/{channelID}/logs:
26803
+ /admin/v1/organizations/{orgName}/checks/{checkID}/details:
26777
26804
  get:
26778
- description: Query logs of a data channel
26779
- summary: Query data channel logs
26780
- operationId: queryDataChannelLogs
26805
+ operationId: getDataCheckDetails
26806
+ summary: Get Data Check Difference Details
26807
+ description: Read typed check miss or diff details from the latest parsed check result.
26781
26808
  parameters:
26782
26809
  - description: The Name of the organization
26783
26810
  in: path
@@ -26785,31 +26812,60 @@ paths:
26785
26812
  required: true
26786
26813
  schema:
26787
26814
  type: string
26788
- - in: path
26789
- name: channelID
26815
+ - description: The ID of the check
26816
+ in: path
26817
+ name: checkID
26790
26818
  required: true
26791
26819
  schema:
26792
26820
  type: string
26793
- - in: query
26794
- name: moduleName
26821
+ - description: The detail type
26822
+ in: query
26823
+ name: type
26824
+ required: true
26825
+ schema:
26826
+ $ref: '#/components/schemas/dataCheckDetailType'
26827
+ - description: Source schema or database. Required for snapshot checks.
26828
+ in: query
26829
+ name: schema
26830
+ required: false
26795
26831
  schema:
26796
26832
  type: string
26797
- - in: query
26798
- name: containerName
26833
+ - description: Source table. Required for snapshot checks.
26834
+ in: query
26835
+ name: table
26836
+ required: false
26799
26837
  schema:
26800
26838
  type: string
26839
+ - description: Struct object key. Optional for struct checks; omitted to page all struct details.
26840
+ in: query
26841
+ name: key
26801
26842
  required: false
26802
- - in: query
26803
- name: limit
26804
26843
  schema:
26805
26844
  type: string
26845
+ - description: Page number for pagination.
26846
+ in: query
26847
+ name: page
26848
+ required: false
26849
+ schema:
26850
+ type: integer
26851
+ minimum: 1
26852
+ default: 1
26853
+ - description: Number of items per page.
26854
+ in: query
26855
+ name: pageSize
26856
+ required: false
26857
+ schema:
26858
+ type: integer
26859
+ minimum: 1
26860
+ maximum: 1000
26861
+ default: 100
26806
26862
  responses:
26807
26863
  '200':
26808
26864
  content:
26809
- text/plain:
26865
+ application/json:
26810
26866
  schema:
26811
- type: string
26812
- description: channel logs output
26867
+ $ref: '#/components/schemas/dataCheckDetails'
26868
+ description: A successful response.
26813
26869
  '401':
26814
26870
  $ref: '#/components/responses/401'
26815
26871
  '403':
@@ -26818,11 +26874,11 @@ paths:
26818
26874
  $ref: '#/components/responses/404'
26819
26875
  tags:
26820
26876
  - dataReplication
26821
- /admin/v1/organizations/{orgName}/replication/channel/{channelID}/containers:
26877
+ /admin/v1/organizations/{orgName}/checks/{checkID}/sqlLogs:
26822
26878
  get:
26823
- description: Query containers of a data channel module pod
26824
- summary: Query data channel module pod containers
26825
- operationId: queryDataChannelContainers
26879
+ operationId: getDataCheckSQLLogs
26880
+ summary: Get Data Check SQL Logs
26881
+ description: Read raw SQL lines emitted by check sql_logger entries.
26826
26882
  parameters:
26827
26883
  - description: The Name of the organization
26828
26884
  in: path
@@ -26830,24 +26886,19 @@ paths:
26830
26886
  required: true
26831
26887
  schema:
26832
26888
  type: string
26833
- - in: path
26834
- name: channelID
26889
+ - description: The ID of the check
26890
+ in: path
26891
+ name: checkID
26835
26892
  required: true
26836
26893
  schema:
26837
26894
  type: string
26838
- - in: query
26839
- name: moduleName
26840
- schema:
26841
- type: string
26842
26895
  responses:
26843
26896
  '200':
26844
26897
  content:
26845
- application/json:
26898
+ text/plain:
26846
26899
  schema:
26847
- type: array
26848
- items:
26849
- $ref: '#/components/schemas/dataReplicationChannelContainer'
26850
- description: A list of data channel module containers.
26900
+ type: string
26901
+ description: Raw SQL lines.
26851
26902
  '401':
26852
26903
  $ref: '#/components/responses/401'
26853
26904
  '403':
@@ -26856,11 +26907,11 @@ paths:
26856
26907
  $ref: '#/components/responses/404'
26857
26908
  tags:
26858
26909
  - dataReplication
26859
- /admin/v1/organizations/{orgName}/replication/channel/parameters:
26860
- get:
26861
- operationId: listDataChannelParameters
26862
- summary: List Data Channel Parameters
26863
- description: Retrieve a list of data channel parameters.
26910
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/ops/{opsType}:
26911
+ post:
26912
+ operationId: createDataChannelOps
26913
+ summary: Create a new data channel ops
26914
+ description: Create a new data channel ops.
26864
26915
  parameters:
26865
26916
  - description: The Name of the organization
26866
26917
  in: path
@@ -26868,29 +26919,46 @@ paths:
26868
26919
  required: true
26869
26920
  schema:
26870
26921
  type: string
26871
- - description: The name of the standard definition
26872
- in: query
26873
- name: standardName
26874
- schema:
26875
- type: string
26876
26922
  - description: The ID of the data channel
26877
- in: query
26923
+ in: path
26878
26924
  name: channelID
26925
+ required: true
26879
26926
  schema:
26880
26927
  type: string
26881
- - description: The source EngineDeifnition name
26882
- in: query
26883
- name: source
26928
+ - description: The operation type
26929
+ in: path
26930
+ name: opsType
26931
+ required: true
26884
26932
  schema:
26885
- type: string
26886
- - description: The target EngineDeifnition name
26887
- in: query
26888
- name: target
26933
+ $ref: '#/components/schemas/dataReplicationOpsType'
26934
+ responses:
26935
+ '204':
26936
+ content: {}
26937
+ description: Returned when operation is completed successfully.
26938
+ '401':
26939
+ $ref: '#/components/responses/401'
26940
+ '403':
26941
+ $ref: '#/components/responses/403'
26942
+ '404':
26943
+ $ref: '#/components/responses/404'
26944
+ tags:
26945
+ - dataReplication
26946
+ /admin/v1/organizations/{orgName}/replication/channel/{channelID}/events:
26947
+ get:
26948
+ operationId: listDataChannelEvents
26949
+ summary: List Data Channel Events
26950
+ description: Retrieve a list of data channel events.
26951
+ parameters:
26952
+ - description: The Name of the organization
26953
+ in: path
26954
+ name: orgName
26955
+ required: true
26889
26956
  schema:
26890
26957
  type: string
26891
- - description: The module name
26892
- in: query
26893
- name: moduleName
26958
+ - description: The ID of the data channel
26959
+ in: path
26960
+ name: channelID
26961
+ required: true
26894
26962
  schema:
26895
26963
  type: string
26896
26964
  responses:
@@ -26898,8 +26966,8 @@ paths:
26898
26966
  content:
26899
26967
  application/json:
26900
26968
  schema:
26901
- $ref: '#/components/schemas/dataReplicationParametersResponse'
26902
- description: A list of data channel parameters.
26969
+ $ref: '#/components/schemas/dataReplicationEventList'
26970
+ description: A list of data channel events.
26903
26971
  '401':
26904
26972
  $ref: '#/components/responses/401'
26905
26973
  '403':
@@ -47941,41 +48009,6 @@ components:
47941
48009
  type: array
47942
48010
  items:
47943
48011
  $ref: '#/components/schemas/dataChannelItem'
47944
- dataChannelModuleProgress:
47945
- type: object
47946
- properties:
47947
- moduleName:
47948
- type: string
47949
- kubernetesName:
47950
- type: string
47951
- nullable: true
47952
- progress:
47953
- type: number
47954
- format: double
47955
- nullable: true
47956
- status:
47957
- type: string
47958
- message:
47959
- type: string
47960
- nullable: true
47961
- dataChannelProgress:
47962
- type: object
47963
- properties:
47964
- progress:
47965
- type: number
47966
- format: double
47967
- nullable: true
47968
- moduleProgress:
47969
- type: array
47970
- items:
47971
- $ref: '#/components/schemas/dataChannelModuleProgress'
47972
- dataChannelDetail:
47973
- type: object
47974
- properties:
47975
- channel:
47976
- $ref: '#/components/schemas/dataChannelItem'
47977
- progress:
47978
- $ref: '#/components/schemas/dataChannelProgress'
47979
48012
  customEndpointCreate:
47980
48013
  type: object
47981
48014
  properties:
@@ -48049,6 +48082,55 @@ components:
48049
48082
  items:
48050
48083
  $ref: '#/components/schemas/dataChannelParameterKeyValue'
48051
48084
  nullable: true
48085
+ dataChannelResponse:
48086
+ type: object
48087
+ properties:
48088
+ channelID:
48089
+ type: string
48090
+ channelName:
48091
+ type: string
48092
+ createdAt:
48093
+ type: string
48094
+ format: date-time
48095
+ updatedAt:
48096
+ type: string
48097
+ format: date-time
48098
+ nullable: true
48099
+ dataChannelModuleProgress:
48100
+ type: object
48101
+ properties:
48102
+ moduleName:
48103
+ type: string
48104
+ kubernetesName:
48105
+ type: string
48106
+ nullable: true
48107
+ progress:
48108
+ type: number
48109
+ format: double
48110
+ nullable: true
48111
+ status:
48112
+ type: string
48113
+ message:
48114
+ type: string
48115
+ nullable: true
48116
+ dataChannelProgress:
48117
+ type: object
48118
+ properties:
48119
+ progress:
48120
+ type: number
48121
+ format: double
48122
+ nullable: true
48123
+ moduleProgress:
48124
+ type: array
48125
+ items:
48126
+ $ref: '#/components/schemas/dataChannelModuleProgress'
48127
+ dataChannelDetail:
48128
+ type: object
48129
+ properties:
48130
+ channel:
48131
+ $ref: '#/components/schemas/dataChannelItem'
48132
+ progress:
48133
+ $ref: '#/components/schemas/dataChannelProgress'
48052
48134
  dataReplicationUpdate:
48053
48135
  type: object
48054
48136
  properties:
@@ -48057,20 +48139,74 @@ components:
48057
48139
  isRestart:
48058
48140
  type: boolean
48059
48141
  nullable: true
48060
- dataChannelResponse:
48142
+ replicationObjectQuery:
48061
48143
  type: object
48062
48144
  properties:
48063
- channelID:
48145
+ sourceEngineDefinition:
48064
48146
  type: string
48065
- channelName:
48147
+ targetEngineDefinition:
48066
48148
  type: string
48067
- createdAt:
48149
+ endpoint:
48150
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48151
+ nodeType:
48068
48152
  type: string
48069
- format: date-time
48070
- updatedAt:
48153
+ nullable: true
48154
+ nodeValue:
48155
+ type: string
48156
+ nullable: true
48157
+ queryNodeType:
48071
48158
  type: string
48072
- format: date-time
48073
48159
  nullable: true
48160
+ preCheckCreate:
48161
+ type: object
48162
+ properties:
48163
+ modules:
48164
+ type: array
48165
+ items:
48166
+ type: string
48167
+ environmentID:
48168
+ type: string
48169
+ source:
48170
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48171
+ target:
48172
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48173
+ replicationObjects:
48174
+ $ref: '#/components/schemas/dataChannelObject'
48175
+ dataReplicationChannelContainer:
48176
+ type: object
48177
+ properties:
48178
+ name:
48179
+ type: string
48180
+ isMainContainer:
48181
+ type: boolean
48182
+ default: false
48183
+ isInitContainer:
48184
+ type: boolean
48185
+ default: false
48186
+ dataReplicationParametersResponseDetail:
48187
+ type: object
48188
+ properties:
48189
+ displayName:
48190
+ type: string
48191
+ desc:
48192
+ $ref: '#/components/schemas/internationalDesc'
48193
+ key:
48194
+ type: string
48195
+ defaultValue:
48196
+ type: string
48197
+ value:
48198
+ type: string
48199
+ valueType:
48200
+ $ref: '#/components/schemas/parameterValueType'
48201
+ required:
48202
+ - key
48203
+ dataReplicationParametersResponse:
48204
+ type: object
48205
+ description: the parameters of the data channel, the key is the module name, the value is the parameter template
48206
+ additionalProperties:
48207
+ type: array
48208
+ items:
48209
+ $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
48074
48210
  dataCheckType:
48075
48211
  type: string
48076
48212
  description: Type of check to run. A standalone check runs exactly one type.
@@ -48146,6 +48282,45 @@ components:
48146
48282
  type: array
48147
48283
  items:
48148
48284
  $ref: '#/components/schemas/dataCheckListItem'
48285
+ dataCheckCreate:
48286
+ type: object
48287
+ required:
48288
+ - checkType
48289
+ description: Exactly one entry point must be used. Provide channelID with checkType to create from an existing channel, or provide environmentID, project, source, target, replicationObjects, and checkType for direct creation.
48290
+ properties:
48291
+ checkType:
48292
+ $ref: '#/components/schemas/dataCheckType'
48293
+ channelID:
48294
+ type: string
48295
+ description: Existing data replication channel ID used only as a create-time shortcut.
48296
+ checkName:
48297
+ type: string
48298
+ nullable: true
48299
+ environmentID:
48300
+ type: string
48301
+ description: Environment UUID for direct check creation.
48302
+ project:
48303
+ type: string
48304
+ description: Kubernetes namespace for direct check creation.
48305
+ source:
48306
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48307
+ nullable: true
48308
+ target:
48309
+ $ref: '#/components/schemas/dataChannelEndpointCreate'
48310
+ nullable: true
48311
+ replicationObjects:
48312
+ $ref: '#/components/schemas/dataChannelObject'
48313
+ nullable: true
48314
+ dataCheckResponse:
48315
+ type: object
48316
+ properties:
48317
+ checkID:
48318
+ type: string
48319
+ checkName:
48320
+ type: string
48321
+ createdAt:
48322
+ type: string
48323
+ format: date-time
48149
48324
  dataCheckTableSummary:
48150
48325
  type: object
48151
48326
  properties:
@@ -48333,74 +48508,6 @@ components:
48333
48508
  type: array
48334
48509
  items:
48335
48510
  $ref: '#/components/schemas/eventItem'
48336
- replicationObjectQuery:
48337
- type: object
48338
- properties:
48339
- sourceEngineDefinition:
48340
- type: string
48341
- targetEngineDefinition:
48342
- type: string
48343
- endpoint:
48344
- $ref: '#/components/schemas/dataChannelEndpointCreate'
48345
- nodeType:
48346
- type: string
48347
- nullable: true
48348
- nodeValue:
48349
- type: string
48350
- nullable: true
48351
- queryNodeType:
48352
- type: string
48353
- nullable: true
48354
- preCheckCreate:
48355
- type: object
48356
- properties:
48357
- modules:
48358
- type: array
48359
- items:
48360
- type: string
48361
- environmentID:
48362
- type: string
48363
- source:
48364
- $ref: '#/components/schemas/dataChannelEndpointCreate'
48365
- target:
48366
- $ref: '#/components/schemas/dataChannelEndpointCreate'
48367
- replicationObjects:
48368
- $ref: '#/components/schemas/dataChannelObject'
48369
- dataReplicationChannelContainer:
48370
- type: object
48371
- properties:
48372
- name:
48373
- type: string
48374
- isMainContainer:
48375
- type: boolean
48376
- default: false
48377
- isInitContainer:
48378
- type: boolean
48379
- default: false
48380
- dataReplicationParametersResponseDetail:
48381
- type: object
48382
- properties:
48383
- displayName:
48384
- type: string
48385
- desc:
48386
- $ref: '#/components/schemas/internationalDesc'
48387
- key:
48388
- type: string
48389
- defaultValue:
48390
- type: string
48391
- value:
48392
- type: string
48393
- valueType:
48394
- $ref: '#/components/schemas/parameterValueType'
48395
- required:
48396
- - key
48397
- dataReplicationParametersResponse:
48398
- type: object
48399
- description: the parameters of the data channel, the key is the module name, the value is the parameter template
48400
- additionalProperties:
48401
- type: array
48402
- items:
48403
- $ref: '#/components/schemas/dataReplicationParametersResponseDetail'
48404
48511
  responses:
48405
48512
  '204':
48406
48513
  description: No Content