@platzio/sdk 0.5.0-beta.12 → 0.5.0-beta.13

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.
Files changed (3) hide show
  1. package/api.ts +2091 -775
  2. package/openapi.yaml +643 -6
  3. package/package.json +1 -1
package/openapi.yaml CHANGED
@@ -278,7 +278,8 @@ paths:
278
278
  type: string
279
279
  key:
280
280
  type: string
281
- spec: {}
281
+ spec:
282
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
282
283
  num_total:
283
284
  type: integer
284
285
  format: int64
@@ -718,7 +719,6 @@ paths:
718
719
  - cluster_id
719
720
  - enabled
720
721
  - status
721
- - reported_status
722
722
  - helm_chart_id
723
723
  - config
724
724
  properties:
@@ -750,7 +750,9 @@ paths:
750
750
  format: uuid
751
751
  nullable: true
752
752
  reported_status:
753
- $ref: '#/components/schemas/DeploymentReportedStatus'
753
+ allOf:
754
+ - $ref: '#/components/schemas/DeploymentReportedStatus'
755
+ nullable: true
754
756
  helm_chart_id:
755
757
  type: string
756
758
  format: uuid
@@ -1224,12 +1226,20 @@ paths:
1224
1226
  available:
1225
1227
  type: boolean
1226
1228
  values_ui:
1229
+ allOf:
1230
+ - $ref: '#/components/schemas/UiSchema'
1227
1231
  nullable: true
1228
1232
  actions_schema:
1233
+ allOf:
1234
+ - $ref: '#/components/schemas/ChartExtActions'
1229
1235
  nullable: true
1230
1236
  features:
1237
+ allOf:
1238
+ - $ref: '#/components/schemas/ChartExtFeatures'
1231
1239
  nullable: true
1232
1240
  resource_types:
1241
+ allOf:
1242
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
1233
1243
  nullable: true
1234
1244
  error:
1235
1245
  type: string
@@ -2318,6 +2328,412 @@ paths:
2318
2328
  - user_token: []
2319
2329
  components:
2320
2330
  schemas:
2331
+ ChartExt:
2332
+ type: object
2333
+ properties:
2334
+ metadata:
2335
+ allOf:
2336
+ - $ref: '#/components/schemas/ChartMetadata'
2337
+ nullable: true
2338
+ ui_schema:
2339
+ allOf:
2340
+ - $ref: '#/components/schemas/UiSchema'
2341
+ nullable: true
2342
+ actions:
2343
+ allOf:
2344
+ - $ref: '#/components/schemas/ChartExtActions'
2345
+ nullable: true
2346
+ features:
2347
+ allOf:
2348
+ - $ref: '#/components/schemas/ChartExtFeatures'
2349
+ nullable: true
2350
+ resource_types:
2351
+ allOf:
2352
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
2353
+ nullable: true
2354
+ error:
2355
+ type: string
2356
+ nullable: true
2357
+ ChartExtActionEndpoint:
2358
+ type: string
2359
+ enum:
2360
+ - standard_ingress
2361
+ ChartExtActionMethod:
2362
+ type: string
2363
+ enum:
2364
+ - GET
2365
+ - POST
2366
+ - PUT
2367
+ - PATCH
2368
+ - DELETE
2369
+ ChartExtActionTarget:
2370
+ type: object
2371
+ required:
2372
+ - endpoint
2373
+ - path
2374
+ - method
2375
+ properties:
2376
+ endpoint:
2377
+ $ref: '#/components/schemas/ChartExtActionEndpoint'
2378
+ path:
2379
+ type: string
2380
+ method:
2381
+ $ref: '#/components/schemas/ChartExtActionMethod'
2382
+ ChartExtActionUserDeploymentRole:
2383
+ type: string
2384
+ enum:
2385
+ - Owner
2386
+ - Maintainer
2387
+ ChartExtActionV0:
2388
+ allOf:
2389
+ - $ref: '#/components/schemas/ChartExtActionTarget'
2390
+ - type: object
2391
+ required:
2392
+ - id
2393
+ - allowed_role
2394
+ - title
2395
+ - description
2396
+ properties:
2397
+ id:
2398
+ type: string
2399
+ allowed_role:
2400
+ $ref: '#/components/schemas/ChartExtActionUserDeploymentRole'
2401
+ title:
2402
+ type: string
2403
+ fontawesome_icon:
2404
+ type: string
2405
+ nullable: true
2406
+ description:
2407
+ type: string
2408
+ ui_schema:
2409
+ allOf:
2410
+ - $ref: '#/components/schemas/UiSchema'
2411
+ nullable: true
2412
+ ChartExtActionV1Beta1:
2413
+ type: object
2414
+ required:
2415
+ - apiVersion
2416
+ - kind
2417
+ - spec
2418
+ properties:
2419
+ apiVersion:
2420
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
2421
+ kind:
2422
+ $ref: '#/components/schemas/ChartExtKindAction'
2423
+ spec:
2424
+ $ref: '#/components/schemas/ChartExtActionV0'
2425
+ ChartExtActions:
2426
+ oneOf:
2427
+ - $ref: '#/components/schemas/ChartExtActionsV1Beta1'
2428
+ - $ref: '#/components/schemas/ChartExtActionsV0'
2429
+ ChartExtActionsV0:
2430
+ type: object
2431
+ required:
2432
+ - schema_version
2433
+ - actions
2434
+ properties:
2435
+ schema_version:
2436
+ type: integer
2437
+ format: int64
2438
+ minimum: 0.0
2439
+ actions:
2440
+ type: array
2441
+ items:
2442
+ $ref: '#/components/schemas/ChartExtActionV0'
2443
+ ChartExtActionsV1Beta1:
2444
+ type: object
2445
+ required:
2446
+ - actions
2447
+ properties:
2448
+ actions:
2449
+ type: array
2450
+ items:
2451
+ $ref: '#/components/schemas/ChartExtActionV1Beta1'
2452
+ ChartExtCardinality:
2453
+ type: string
2454
+ enum:
2455
+ - Many
2456
+ - OnePerCluster
2457
+ ChartExtDeploymentDisplay:
2458
+ type: object
2459
+ properties:
2460
+ name:
2461
+ allOf:
2462
+ - $ref: '#/components/schemas/ChartExtDeploymentDisplayName'
2463
+ nullable: true
2464
+ icon:
2465
+ allOf:
2466
+ - $ref: '#/components/schemas/ChartExtDeploymentDisplayIcon'
2467
+ nullable: true
2468
+ ChartExtDeploymentDisplayIcon:
2469
+ type: object
2470
+ required:
2471
+ - font_awesome
2472
+ properties:
2473
+ font_awesome:
2474
+ type: string
2475
+ ChartExtDeploymentDisplayName:
2476
+ oneOf:
2477
+ - type: string
2478
+ enum:
2479
+ - DeploymentName
2480
+ - type: object
2481
+ required:
2482
+ - InputField
2483
+ properties:
2484
+ InputField:
2485
+ $ref: '#/components/schemas/ChartExtDeploymentDisplayNameInputField'
2486
+ ChartExtDeploymentDisplayNameInputField:
2487
+ type: object
2488
+ required:
2489
+ - name
2490
+ properties:
2491
+ name:
2492
+ type: string
2493
+ ChartExtFeatures:
2494
+ oneOf:
2495
+ - $ref: '#/components/schemas/ChartExtFeaturesV1Beta2'
2496
+ - $ref: '#/components/schemas/ChartExtFeaturesV1Beta1'
2497
+ - $ref: '#/components/schemas/ChartExtFeaturesV0'
2498
+ ChartExtFeaturesSpec:
2499
+ type: object
2500
+ properties:
2501
+ ingress:
2502
+ $ref: '#/components/schemas/ChartExtIngress'
2503
+ status:
2504
+ allOf:
2505
+ - $ref: '#/components/schemas/ChartExtStatusFeature'
2506
+ nullable: true
2507
+ cardinality:
2508
+ $ref: '#/components/schemas/ChartExtCardinality'
2509
+ reinstall_dependencies:
2510
+ type: boolean
2511
+ description: |-
2512
+ Should dependent deployments be reinstalled when this deployment
2513
+ config/values are updated. This doesn't apply to renames or
2514
+ moving between clusters which always reinstalls dependencies.
2515
+ node_selector_paths:
2516
+ type: array
2517
+ items:
2518
+ type: array
2519
+ items:
2520
+ type: string
2521
+ description: |-
2522
+ Paths to inject the node selector to. Node selector is always
2523
+ added at the values top level `nodeSelector`.
2524
+ tolerations_paths:
2525
+ type: array
2526
+ items:
2527
+ type: array
2528
+ items:
2529
+ type: string
2530
+ description: Same for tolerations
2531
+ display:
2532
+ $ref: '#/components/schemas/ChartExtDeploymentDisplay'
2533
+ ChartExtFeaturesV0:
2534
+ type: object
2535
+ properties:
2536
+ standard_ingress:
2537
+ type: boolean
2538
+ description: |-
2539
+ When true, values.yaml is injected with an `ingress` section
2540
+ that matches the structure generated by `helm create`. This
2541
+ generates the hostname and sets TLS correctly.
2542
+ status:
2543
+ allOf:
2544
+ - $ref: '#/components/schemas/ChartExtStatusFeature'
2545
+ nullable: true
2546
+ cardinality:
2547
+ $ref: '#/components/schemas/ChartExtCardinality'
2548
+ reinstall_dependencies:
2549
+ type: boolean
2550
+ description: |-
2551
+ Should dependent deployments be reinstalled when this deployment
2552
+ config/values are updated. This doesn't apply to renames or
2553
+ moving between clusters which always reinstalls dependencies.
2554
+ node_selector_paths:
2555
+ type: array
2556
+ items:
2557
+ type: array
2558
+ items:
2559
+ type: string
2560
+ description: |-
2561
+ Paths to inject the node selector to. Node selector is always
2562
+ added at the values top level `nodeSelector`.
2563
+ tolerations_paths:
2564
+ type: array
2565
+ items:
2566
+ type: array
2567
+ items:
2568
+ type: string
2569
+ description: Same for tolerations
2570
+ ChartExtFeaturesV1Beta1:
2571
+ type: object
2572
+ required:
2573
+ - apiVersion
2574
+ - kind
2575
+ - spec
2576
+ properties:
2577
+ apiVersion:
2578
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
2579
+ kind:
2580
+ $ref: '#/components/schemas/ChartExtKindFeatures'
2581
+ spec:
2582
+ $ref: '#/components/schemas/ChartExtFeaturesV0'
2583
+ ChartExtFeaturesV1Beta2:
2584
+ type: object
2585
+ required:
2586
+ - apiVersion
2587
+ - kind
2588
+ - spec
2589
+ properties:
2590
+ apiVersion:
2591
+ $ref: '#/components/schemas/ChartExtVersionV1Beta2'
2592
+ kind:
2593
+ $ref: '#/components/schemas/ChartExtKindFeatures'
2594
+ spec:
2595
+ $ref: '#/components/schemas/ChartExtFeaturesSpec'
2596
+ ChartExtIngress:
2597
+ type: object
2598
+ required:
2599
+ - enabled
2600
+ properties:
2601
+ enabled:
2602
+ type: boolean
2603
+ hostname_format:
2604
+ $ref: '#/components/schemas/ChartExtIngressHostnameFormat'
2605
+ ChartExtIngressHostnameFormat:
2606
+ type: string
2607
+ enum:
2608
+ - Name
2609
+ - KindAndName
2610
+ ChartExtKindAction:
2611
+ type: string
2612
+ enum:
2613
+ - Action
2614
+ ChartExtKindFeatures:
2615
+ type: string
2616
+ enum:
2617
+ - Features
2618
+ ChartExtKindResourceType:
2619
+ type: string
2620
+ enum:
2621
+ - ResourceType
2622
+ ChartExtKindValuesUi:
2623
+ type: string
2624
+ enum:
2625
+ - ValuesUi
2626
+ ChartExtResourceLifecycleActionV1Beta1:
2627
+ type: object
2628
+ properties:
2629
+ allowed_role:
2630
+ allOf:
2631
+ - $ref: '#/components/schemas/ChartExtActionUserDeploymentRole'
2632
+ nullable: true
2633
+ target:
2634
+ allOf:
2635
+ - $ref: '#/components/schemas/ChartExtActionTarget'
2636
+ nullable: true
2637
+ ChartExtResourceLifecycleV1Beta1:
2638
+ type: object
2639
+ properties:
2640
+ create:
2641
+ allOf:
2642
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
2643
+ nullable: true
2644
+ update:
2645
+ allOf:
2646
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
2647
+ nullable: true
2648
+ delete:
2649
+ allOf:
2650
+ - $ref: '#/components/schemas/ChartExtResourceLifecycleActionV1Beta1'
2651
+ nullable: true
2652
+ ChartExtResourceType:
2653
+ oneOf:
2654
+ - $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1'
2655
+ ChartExtResourceTypeV1Beta1:
2656
+ type: object
2657
+ required:
2658
+ - apiVersion
2659
+ - kind
2660
+ - key
2661
+ - spec
2662
+ properties:
2663
+ apiVersion:
2664
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
2665
+ kind:
2666
+ $ref: '#/components/schemas/ChartExtKindResourceType'
2667
+ key:
2668
+ type: string
2669
+ spec:
2670
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
2671
+ ChartExtResourceTypeV1Beta1Spec:
2672
+ type: object
2673
+ required:
2674
+ - name_singular
2675
+ - name_plural
2676
+ - fontawesome_icon
2677
+ - values_ui
2678
+ properties:
2679
+ name_singular:
2680
+ type: string
2681
+ name_plural:
2682
+ type: string
2683
+ fontawesome_icon:
2684
+ type: string
2685
+ global:
2686
+ type: boolean
2687
+ values_ui:
2688
+ $ref: '#/components/schemas/UiSchemaV0'
2689
+ lifecycle:
2690
+ $ref: '#/components/schemas/ChartExtResourceLifecycleV1Beta1'
2691
+ ChartExtResourceTypes:
2692
+ type: array
2693
+ items:
2694
+ $ref: '#/components/schemas/ChartExtResourceType'
2695
+ ChartExtStatusFeature:
2696
+ type: object
2697
+ required:
2698
+ - endpoint
2699
+ - path
2700
+ - refresh_interval_secs
2701
+ properties:
2702
+ endpoint:
2703
+ $ref: '#/components/schemas/ChartExtActionEndpoint'
2704
+ path:
2705
+ type: string
2706
+ refresh_interval_secs:
2707
+ type: integer
2708
+ format: int64
2709
+ minimum: 0.0
2710
+ ChartExtVersionV1Beta1:
2711
+ type: string
2712
+ enum:
2713
+ - platz.io/v1beta1
2714
+ ChartExtVersionV1Beta2:
2715
+ type: string
2716
+ enum:
2717
+ - platz.io/v1beta2
2718
+ ChartMetadata:
2719
+ type: object
2720
+ required:
2721
+ - version
2722
+ properties:
2723
+ version:
2724
+ type: string
2725
+ git_commit:
2726
+ type: string
2727
+ nullable: true
2728
+ git_branch:
2729
+ type: string
2730
+ nullable: true
2731
+ git_repo:
2732
+ type: string
2733
+ nullable: true
2734
+ git_provider:
2735
+ type: string
2736
+ nullable: true
2321
2737
  CreateDeploymentTask:
2322
2738
  type: object
2323
2739
  required:
@@ -2346,7 +2762,6 @@ components:
2346
2762
  - cluster_id
2347
2763
  - enabled
2348
2764
  - status
2349
- - reported_status
2350
2765
  - helm_chart_id
2351
2766
  - config
2352
2767
  properties:
@@ -2378,7 +2793,9 @@ components:
2378
2793
  format: uuid
2379
2794
  nullable: true
2380
2795
  reported_status:
2381
- $ref: '#/components/schemas/DeploymentReportedStatus'
2796
+ allOf:
2797
+ - $ref: '#/components/schemas/DeploymentReportedStatus'
2798
+ nullable: true
2382
2799
  helm_chart_id:
2383
2800
  type: string
2384
2801
  format: uuid
@@ -2616,7 +3033,8 @@ components:
2616
3033
  type: string
2617
3034
  key:
2618
3035
  type: string
2619
- spec: {}
3036
+ spec:
3037
+ $ref: '#/components/schemas/ChartExtResourceTypeV1Beta1Spec'
2620
3038
  DeploymentRestartK8sResourceTask:
2621
3039
  type: object
2622
3040
  required:
@@ -2844,12 +3262,20 @@ components:
2844
3262
  available:
2845
3263
  type: boolean
2846
3264
  values_ui:
3265
+ allOf:
3266
+ - $ref: '#/components/schemas/UiSchema'
2847
3267
  nullable: true
2848
3268
  actions_schema:
3269
+ allOf:
3270
+ - $ref: '#/components/schemas/ChartExtActions'
2849
3271
  nullable: true
2850
3272
  features:
3273
+ allOf:
3274
+ - $ref: '#/components/schemas/ChartExtFeatures'
2851
3275
  nullable: true
2852
3276
  resource_types:
3277
+ allOf:
3278
+ - $ref: '#/components/schemas/ChartExtResourceTypes'
2853
3279
  nullable: true
2854
3280
  error:
2855
3281
  type: string
@@ -3174,6 +3600,18 @@ components:
3174
3600
  type: string
3175
3601
  name:
3176
3602
  type: string
3603
+ SerializedUiSchemaInputType:
3604
+ type: object
3605
+ required:
3606
+ - type
3607
+ properties:
3608
+ type:
3609
+ type: string
3610
+ itemType:
3611
+ type: string
3612
+ nullable: true
3613
+ collection:
3614
+ nullable: true
3177
3615
  ServerInfo:
3178
3616
  type: object
3179
3617
  required:
@@ -3188,6 +3626,205 @@ components:
3188
3626
  properties:
3189
3627
  redirect_url:
3190
3628
  type: string
3629
+ UiSchema:
3630
+ oneOf:
3631
+ - $ref: '#/components/schemas/UiSchemaV1Beta1'
3632
+ - $ref: '#/components/schemas/UiSchemaV0'
3633
+ UiSchemaFieldValuePair:
3634
+ type: object
3635
+ required:
3636
+ - field
3637
+ - value
3638
+ properties:
3639
+ field:
3640
+ type: string
3641
+ value: {}
3642
+ UiSchemaInput:
3643
+ allOf:
3644
+ - $ref: '#/components/schemas/UiSchemaInputType'
3645
+ - type: object
3646
+ required:
3647
+ - id
3648
+ - label
3649
+ properties:
3650
+ id:
3651
+ type: string
3652
+ label:
3653
+ type: string
3654
+ initialValue:
3655
+ nullable: true
3656
+ helpText:
3657
+ type: string
3658
+ nullable: true
3659
+ required:
3660
+ type: boolean
3661
+ sensitive:
3662
+ type: boolean
3663
+ options:
3664
+ type: array
3665
+ items:
3666
+ $ref: '#/components/schemas/UiSchemaInputFieldOption'
3667
+ nullable: true
3668
+ showIfAll:
3669
+ type: array
3670
+ items:
3671
+ $ref: '#/components/schemas/UiSchemaFieldValuePair'
3672
+ nullable: true
3673
+ filters:
3674
+ type: array
3675
+ items:
3676
+ $ref: '#/components/schemas/UiSchemaInputFieldValue'
3677
+ nullable: true
3678
+ minimum:
3679
+ type: string
3680
+ nullable: true
3681
+ maximum:
3682
+ type: string
3683
+ nullable: true
3684
+ step:
3685
+ type: string
3686
+ nullable: true
3687
+ UiSchemaInputFieldOption:
3688
+ type: object
3689
+ required:
3690
+ - value
3691
+ properties:
3692
+ value: {}
3693
+ label:
3694
+ type: string
3695
+ nullable: true
3696
+ helpText:
3697
+ type: string
3698
+ nullable: true
3699
+ UiSchemaInputFieldValue:
3700
+ type: object
3701
+ required:
3702
+ - field
3703
+ - value
3704
+ properties:
3705
+ field:
3706
+ type: string
3707
+ value: {}
3708
+ UiSchemaInputRef:
3709
+ oneOf:
3710
+ - type: object
3711
+ required:
3712
+ - FieldValue
3713
+ properties:
3714
+ FieldValue:
3715
+ $ref: '#/components/schemas/UiSchemaInputRefField'
3716
+ - type: object
3717
+ required:
3718
+ - FieldProperty
3719
+ properties:
3720
+ FieldProperty:
3721
+ $ref: '#/components/schemas/UiSchemaInputRefProperty'
3722
+ UiSchemaInputRefField:
3723
+ type: object
3724
+ required:
3725
+ - input
3726
+ properties:
3727
+ input:
3728
+ type: string
3729
+ UiSchemaInputRefProperty:
3730
+ type: object
3731
+ required:
3732
+ - input
3733
+ - property
3734
+ properties:
3735
+ input:
3736
+ type: string
3737
+ property:
3738
+ type: string
3739
+ UiSchemaInputSingleType:
3740
+ oneOf:
3741
+ - type: string
3742
+ enum:
3743
+ - text
3744
+ - type: string
3745
+ enum:
3746
+ - number
3747
+ - type: object
3748
+ required:
3749
+ - CollectionSelect
3750
+ properties:
3751
+ CollectionSelect:
3752
+ type: object
3753
+ required:
3754
+ - collection
3755
+ properties:
3756
+ collection: {}
3757
+ - type: string
3758
+ enum:
3759
+ - RadioSelect
3760
+ - type: string
3761
+ enum:
3762
+ - DaysAndHour
3763
+ - type: string
3764
+ enum:
3765
+ - Checkbox
3766
+ UiSchemaInputType:
3767
+ type: object
3768
+ required:
3769
+ - single_type
3770
+ - is_array
3771
+ properties:
3772
+ single_type:
3773
+ $ref: '#/components/schemas/UiSchemaInputSingleType'
3774
+ is_array:
3775
+ type: boolean
3776
+ UiSchemaOutputSecrets:
3777
+ type: object
3778
+ additionalProperties:
3779
+ type: object
3780
+ additionalProperties:
3781
+ $ref: '#/components/schemas/UiSchemaInputRef'
3782
+ UiSchemaOutputValue:
3783
+ type: object
3784
+ required:
3785
+ - path
3786
+ - value
3787
+ properties:
3788
+ path:
3789
+ type: array
3790
+ items:
3791
+ type: string
3792
+ value:
3793
+ $ref: '#/components/schemas/UiSchemaInputRef'
3794
+ UiSchemaOutputs:
3795
+ type: object
3796
+ required:
3797
+ - values
3798
+ properties:
3799
+ values:
3800
+ type: array
3801
+ items:
3802
+ $ref: '#/components/schemas/UiSchemaOutputValue'
3803
+ secrets:
3804
+ $ref: '#/components/schemas/UiSchemaOutputSecrets'
3805
+ UiSchemaV0:
3806
+ type: object
3807
+ required:
3808
+ - inputs
3809
+ properties:
3810
+ inputs:
3811
+ type: array
3812
+ items:
3813
+ $ref: '#/components/schemas/UiSchemaInput'
3814
+ outputs:
3815
+ $ref: '#/components/schemas/UiSchemaOutputs'
3816
+ UiSchemaV1Beta1:
3817
+ allOf:
3818
+ - $ref: '#/components/schemas/UiSchemaV0'
3819
+ - type: object
3820
+ required:
3821
+ - apiVersion
3822
+ - kind
3823
+ properties:
3824
+ apiVersion:
3825
+ $ref: '#/components/schemas/ChartExtVersionV1Beta1'
3826
+ kind:
3827
+ $ref: '#/components/schemas/ChartExtKindValuesUi'
3191
3828
  UpdateDeployment:
3192
3829
  type: object
3193
3830
  properties: