@meshery/schemas 1.3.22 → 1.3.23

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 (90) hide show
  1. package/dist/cloudApi.d.mts +5239 -3023
  2. package/dist/cloudApi.d.ts +5239 -3023
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  6. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  7. package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
  8. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
  9. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  10. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  11. package/dist/constructs/v1beta1/credential/CredentialSchema.js +8 -8
  12. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +8 -8
  13. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
  14. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
  15. package/dist/constructs/v1beta1/model/Model.d.ts +586 -2
  16. package/dist/constructs/v1beta1/model/ModelSchema.js +10 -2
  17. package/dist/constructs/v1beta1/model/ModelSchema.mjs +10 -2
  18. package/dist/constructs/v1beta1/pattern/PatternSchema.js +11 -11
  19. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +11 -11
  20. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +6 -6
  21. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +6 -6
  22. package/dist/constructs/v1beta1/system/System.d.ts +112 -0
  23. package/dist/constructs/v1beta1/system/SystemSchema.js +1 -1
  24. package/dist/constructs/v1beta1/system/SystemSchema.mjs +1 -1
  25. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  26. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  27. package/dist/constructs/v1beta1/token/TokenSchema.js +1 -1
  28. package/dist/constructs/v1beta1/token/TokenSchema.mjs +1 -1
  29. package/dist/constructs/v1beta1/view/ViewSchema.js +4 -4
  30. package/dist/constructs/v1beta1/view/ViewSchema.mjs +4 -4
  31. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +4 -4
  32. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +4 -4
  33. package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
  34. package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
  35. package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
  36. package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
  37. package/dist/constructs/v1beta2/connection/ConnectionSchema.js +1 -1
  38. package/dist/constructs/v1beta2/connection/ConnectionSchema.mjs +1 -1
  39. package/dist/constructs/v1beta2/credential/CredentialSchema.js +6 -6
  40. package/dist/constructs/v1beta2/credential/CredentialSchema.mjs +6 -6
  41. package/dist/constructs/v1beta2/design/DesignSchema.js +11 -11
  42. package/dist/constructs/v1beta2/design/DesignSchema.mjs +11 -11
  43. package/dist/constructs/v1beta2/model/Model.d.ts +587 -3
  44. package/dist/constructs/v1beta2/model/ModelSchema.js +10 -2
  45. package/dist/constructs/v1beta2/model/ModelSchema.mjs +10 -2
  46. package/dist/constructs/v1beta2/organization/Organization.d.ts +434 -0
  47. package/dist/constructs/v1beta2/organization/OrganizationSchema.js +1 -1
  48. package/dist/constructs/v1beta2/organization/OrganizationSchema.mjs +1 -1
  49. package/dist/constructs/v1beta2/schedule/ScheduleSchema.js +5 -5
  50. package/dist/constructs/v1beta2/schedule/ScheduleSchema.mjs +5 -5
  51. package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
  52. package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
  53. package/dist/constructs/v1beta2/token/TokenSchema.js +1 -1
  54. package/dist/constructs/v1beta2/token/TokenSchema.mjs +1 -1
  55. package/dist/constructs/v1beta2/user/User.d.ts +695 -0
  56. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  57. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  58. package/dist/constructs/v1beta2/view/ViewSchema.js +4 -4
  59. package/dist/constructs/v1beta2/view/ViewSchema.mjs +4 -4
  60. package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
  61. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
  62. package/dist/constructs/v1beta3/connection/Connection.d.ts +173 -1
  63. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  64. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  65. package/dist/constructs/v1beta3/design/Design.d.ts +3569 -2245
  66. package/dist/constructs/v1beta3/design/DesignSchema.js +56 -12
  67. package/dist/constructs/v1beta3/design/DesignSchema.mjs +56 -12
  68. package/dist/constructs/v1beta3/environment/Environment.d.ts +42 -0
  69. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  70. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  71. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +188 -1
  72. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  73. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  74. package/dist/constructs/v1beta3/pattern_resource/PatternResource.d.ts +701 -0
  75. package/dist/constructs/v1beta3/pattern_resource/PatternResource.js +1 -0
  76. package/dist/constructs/v1beta3/pattern_resource/PatternResource.mjs +0 -0
  77. package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.d.ts +2 -0
  78. package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.js +78 -0
  79. package/dist/constructs/v1beta3/pattern_resource/PatternResourceSchema.mjs +78 -0
  80. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +4 -4
  81. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +4 -4
  82. package/dist/index.d.mts +573 -1
  83. package/dist/index.d.ts +573 -1
  84. package/dist/index.js +41 -33
  85. package/dist/index.mjs +41 -33
  86. package/dist/mesheryApi.d.mts +905 -734
  87. package/dist/mesheryApi.d.ts +905 -734
  88. package/dist/mesheryApi.js +1 -1
  89. package/dist/mesheryApi.mjs +1 -1
  90. package/package.json +1 -1
@@ -464,8 +464,300 @@ export interface components {
464
464
  total_count?: number;
465
465
  /** @description The models matching the list-endpoint query. */
466
466
  models?: {
467
- /** @description Version of the model as defined by the registrant. */
467
+ /**
468
+ * Format: uuid
469
+ * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
470
+ */
471
+ id: string;
472
+ /**
473
+ * @description Specifies the version of the schema used for the definition.
474
+ * @default models.meshery.io/v1beta1
475
+ * @example [
476
+ * "v1",
477
+ * "v1alpha1",
478
+ * "v2beta3",
479
+ * "v1.custom-suffix",
480
+ * "models.meshery.io/v1beta1",
481
+ * "capability.meshery.io/v1alpha1"
482
+ * ]
483
+ */
484
+ schemaVersion: string;
485
+ /** @description Version of the model definition. */
468
486
  version: string;
487
+ /**
488
+ * @description The unique name for the model within the scope of a registrant.
489
+ * @default untitled-model
490
+ * @example cert-manager
491
+ */
492
+ name: string;
493
+ /**
494
+ * @description Human-readable name for the model.
495
+ * @default Untitled Model
496
+ * @example Cert Manager
497
+ */
498
+ displayName: string;
499
+ /**
500
+ * @description Description of the model.
501
+ * @default A new Meshery model.
502
+ */
503
+ description: string;
504
+ /**
505
+ * @description Status of model, including:
506
+ * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
507
+ * - maintenance: model is unavailable for a period of time.
508
+ * - enabled: model is available for use for all users of this Meshery Server.
509
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
510
+ * @default enabled
511
+ * @enum {string}
512
+ */
513
+ status: "ignored" | "enabled" | "duplicate";
514
+ /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
515
+ registrant: {
516
+ /**
517
+ * Format: uuid
518
+ * @description Connection ID
519
+ */
520
+ id: string;
521
+ /** @description Connection Name */
522
+ name: string;
523
+ /**
524
+ * Format: uuid
525
+ * @description Associated Credential ID
526
+ */
527
+ credentialId?: string;
528
+ /** @description Connection Type (platform, telemetry, collaboration) */
529
+ type: string;
530
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
531
+ subType: string;
532
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
533
+ kind: string;
534
+ /** @description Additional connection metadata */
535
+ metadata?: Record<string, never>;
536
+ /**
537
+ * @description Connection Status
538
+ * @enum {string}
539
+ */
540
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
541
+ /**
542
+ * Format: uuid
543
+ * @description User ID who owns this connection
544
+ */
545
+ user_id?: string;
546
+ /** Format: date-time */
547
+ created_at?: string;
548
+ /** Format: date-time */
549
+ updated_at?: string;
550
+ /**
551
+ * Format: date-time
552
+ * @description SQL null Timestamp to handle null values of time.
553
+ */
554
+ deleted_at?: string;
555
+ /** @description Associated environments for this connection */
556
+ environments?: {
557
+ /**
558
+ * Format: uuid
559
+ * @description ID
560
+ */
561
+ id: string;
562
+ /**
563
+ * @description Specifies the version of the schema to which the environment conforms.
564
+ * @default environments.meshery.io/v1beta1
565
+ * @example [
566
+ * "v1",
567
+ * "v1alpha1",
568
+ * "v2beta3",
569
+ * "v1.custom-suffix",
570
+ * "models.meshery.io/v1beta1",
571
+ * "capability.meshery.io/v1alpha1"
572
+ * ]
573
+ */
574
+ schemaVersion: string;
575
+ /** @description Environment name */
576
+ name: string;
577
+ /** @description Environment description */
578
+ description: string;
579
+ /**
580
+ * Format: uuid
581
+ * @description Environment organization ID
582
+ */
583
+ organization_id: string;
584
+ /**
585
+ * Format: uuid
586
+ * @description Environment owner
587
+ */
588
+ owner?: string;
589
+ /**
590
+ * Format: date-time
591
+ * @description Timestamp when the resource was created.
592
+ */
593
+ created_at?: string;
594
+ /** @description Additional metadata associated with the environment. */
595
+ metadata?: Record<string, never>;
596
+ /**
597
+ * Format: date-time
598
+ * @description Timestamp when the resource was updated.
599
+ */
600
+ updated_at?: string;
601
+ /**
602
+ * Format: date-time
603
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
604
+ */
605
+ deleted_at?: string | null;
606
+ }[];
607
+ /**
608
+ * @description Specifies the version of the schema used for the definition.
609
+ * @default connections.meshery.io/v1beta1
610
+ * @example [
611
+ * "v1",
612
+ * "v1alpha1",
613
+ * "v2beta3",
614
+ * "v1.custom-suffix",
615
+ * "models.meshery.io/v1beta1",
616
+ * "capability.meshery.io/v1alpha1"
617
+ * ]
618
+ */
619
+ schemaVersion: string;
620
+ };
621
+ /**
622
+ * Format: uuid
623
+ * @description ID of the registrant.
624
+ */
625
+ registrantId: string;
626
+ /**
627
+ * Format: uuid
628
+ * @description ID of the category.
629
+ */
630
+ categoryId: string;
631
+ /** @description Category of the model. */
632
+ category: {
633
+ /**
634
+ * Format: uuid
635
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
636
+ */
637
+ id: string;
638
+ /**
639
+ * @description The category of the model that determines the main grouping.
640
+ * @default Uncategorized
641
+ * @enum {string}
642
+ */
643
+ name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
644
+ /** @description Additional metadata associated with the category. */
645
+ metadata: Record<string, never>;
646
+ };
647
+ /**
648
+ * SubCategory
649
+ * @description Sub category of the model determines the secondary grouping.
650
+ * @default Uncategorized
651
+ * @enum {string}
652
+ */
653
+ subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
654
+ /** @description Metadata containing additional information associated with the model. */
655
+ metadata?: {
656
+ /** @description Capabilities associated with the model */
657
+ capabilities?: {
658
+ /**
659
+ * @description Specifies the version of the schema to which the capability definition conforms.
660
+ * @example [
661
+ * "v1",
662
+ * "v1alpha1",
663
+ * "v2beta3",
664
+ * "v1.custom-suffix",
665
+ * "models.meshery.io/v1beta1",
666
+ * "capability.meshery.io/v1alpha1"
667
+ * ]
668
+ */
669
+ schemaVersion: string;
670
+ /** @description Version of the capability definition. */
671
+ version: string;
672
+ /** @description Name of the capability in human-readible format. */
673
+ displayName: string;
674
+ /** @description A written representation of the purpose and characteristics of the capability. */
675
+ description: string;
676
+ /** @description Top-level categorization of the capability */
677
+ kind: string | "action" | "mutate" | "view" | "interaction";
678
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
679
+ type: string;
680
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
681
+ subType: string;
682
+ /** @description Key that backs the capability. */
683
+ key: string;
684
+ /** @description State of the entity in which the capability is applicable. */
685
+ entityState: ("declaration" | "instance")[];
686
+ /**
687
+ * @description Status of the capability
688
+ * @default enabled
689
+ * @enum {string}
690
+ */
691
+ status: "enabled" | "disabled";
692
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
693
+ metadata?: {
694
+ [key: string]: unknown;
695
+ };
696
+ }[];
697
+ /**
698
+ * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
699
+ * @default false
700
+ */
701
+ isAnnotation: boolean;
702
+ /**
703
+ * @description Primary color associated with the model.
704
+ * @default #00b39f
705
+ */
706
+ primaryColor: string;
707
+ /**
708
+ * @description Secondary color associated with the model.
709
+ * @default #00D3A9
710
+ */
711
+ secondaryColor: string;
712
+ /**
713
+ * @description SVG representation of the model in white color.
714
+ * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
715
+ */
716
+ svgWhite: string;
717
+ /**
718
+ * @description SVG representation of the model in colored format.
719
+ * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
720
+ */
721
+ svgColor: string;
722
+ /** @description SVG representation of the complete model. */
723
+ svgComplete?: string;
724
+ /**
725
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
726
+ * @enum {string}
727
+ */
728
+ shape?: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
729
+ } & {
730
+ [key: string]: unknown;
731
+ };
732
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
733
+ model: {
734
+ /** @description Version of the model as defined by the registrant. */
735
+ version: string;
736
+ };
737
+ /** @description The relationships of the model. */
738
+ relationships: unknown[];
739
+ /** @description The components of the model. */
740
+ components: unknown[];
741
+ /**
742
+ * @description Number of components associated with the model.
743
+ * @default 0
744
+ */
745
+ componentsCount: number;
746
+ /**
747
+ * @description Number of relationships associated with the model.
748
+ * @default 0
749
+ */
750
+ relationshipsCount: number;
751
+ /**
752
+ * Format: date-time
753
+ * @description Timestamp when the resource was created.
754
+ */
755
+ created_at?: string;
756
+ /**
757
+ * Format: date-time
758
+ * @description Timestamp when the resource was updated.
759
+ */
760
+ updated_at?: string;
469
761
  }[];
470
762
  };
471
763
  };
@@ -608,8 +900,300 @@ export interface operations {
608
900
  total_count?: number;
609
901
  /** @description The models matching the list-endpoint query. */
610
902
  models?: {
611
- /** @description Version of the model as defined by the registrant. */
903
+ /**
904
+ * Format: uuid
905
+ * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
906
+ */
907
+ id: string;
908
+ /**
909
+ * @description Specifies the version of the schema used for the definition.
910
+ * @default models.meshery.io/v1beta1
911
+ * @example [
912
+ * "v1",
913
+ * "v1alpha1",
914
+ * "v2beta3",
915
+ * "v1.custom-suffix",
916
+ * "models.meshery.io/v1beta1",
917
+ * "capability.meshery.io/v1alpha1"
918
+ * ]
919
+ */
920
+ schemaVersion: string;
921
+ /** @description Version of the model definition. */
612
922
  version: string;
923
+ /**
924
+ * @description The unique name for the model within the scope of a registrant.
925
+ * @default untitled-model
926
+ * @example cert-manager
927
+ */
928
+ name: string;
929
+ /**
930
+ * @description Human-readable name for the model.
931
+ * @default Untitled Model
932
+ * @example Cert Manager
933
+ */
934
+ displayName: string;
935
+ /**
936
+ * @description Description of the model.
937
+ * @default A new Meshery model.
938
+ */
939
+ description: string;
940
+ /**
941
+ * @description Status of model, including:
942
+ * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
943
+ * - maintenance: model is unavailable for a period of time.
944
+ * - enabled: model is available for use for all users of this Meshery Server.
945
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
946
+ * @default enabled
947
+ * @enum {string}
948
+ */
949
+ status: "ignored" | "enabled" | "duplicate";
950
+ /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
951
+ registrant: {
952
+ /**
953
+ * Format: uuid
954
+ * @description Connection ID
955
+ */
956
+ id: string;
957
+ /** @description Connection Name */
958
+ name: string;
959
+ /**
960
+ * Format: uuid
961
+ * @description Associated Credential ID
962
+ */
963
+ credentialId?: string;
964
+ /** @description Connection Type (platform, telemetry, collaboration) */
965
+ type: string;
966
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
967
+ subType: string;
968
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
969
+ kind: string;
970
+ /** @description Additional connection metadata */
971
+ metadata?: Record<string, never>;
972
+ /**
973
+ * @description Connection Status
974
+ * @enum {string}
975
+ */
976
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
977
+ /**
978
+ * Format: uuid
979
+ * @description User ID who owns this connection
980
+ */
981
+ user_id?: string;
982
+ /** Format: date-time */
983
+ created_at?: string;
984
+ /** Format: date-time */
985
+ updated_at?: string;
986
+ /**
987
+ * Format: date-time
988
+ * @description SQL null Timestamp to handle null values of time.
989
+ */
990
+ deleted_at?: string;
991
+ /** @description Associated environments for this connection */
992
+ environments?: {
993
+ /**
994
+ * Format: uuid
995
+ * @description ID
996
+ */
997
+ id: string;
998
+ /**
999
+ * @description Specifies the version of the schema to which the environment conforms.
1000
+ * @default environments.meshery.io/v1beta1
1001
+ * @example [
1002
+ * "v1",
1003
+ * "v1alpha1",
1004
+ * "v2beta3",
1005
+ * "v1.custom-suffix",
1006
+ * "models.meshery.io/v1beta1",
1007
+ * "capability.meshery.io/v1alpha1"
1008
+ * ]
1009
+ */
1010
+ schemaVersion: string;
1011
+ /** @description Environment name */
1012
+ name: string;
1013
+ /** @description Environment description */
1014
+ description: string;
1015
+ /**
1016
+ * Format: uuid
1017
+ * @description Environment organization ID
1018
+ */
1019
+ organization_id: string;
1020
+ /**
1021
+ * Format: uuid
1022
+ * @description Environment owner
1023
+ */
1024
+ owner?: string;
1025
+ /**
1026
+ * Format: date-time
1027
+ * @description Timestamp when the resource was created.
1028
+ */
1029
+ created_at?: string;
1030
+ /** @description Additional metadata associated with the environment. */
1031
+ metadata?: Record<string, never>;
1032
+ /**
1033
+ * Format: date-time
1034
+ * @description Timestamp when the resource was updated.
1035
+ */
1036
+ updated_at?: string;
1037
+ /**
1038
+ * Format: date-time
1039
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
1040
+ */
1041
+ deleted_at?: string | null;
1042
+ }[];
1043
+ /**
1044
+ * @description Specifies the version of the schema used for the definition.
1045
+ * @default connections.meshery.io/v1beta1
1046
+ * @example [
1047
+ * "v1",
1048
+ * "v1alpha1",
1049
+ * "v2beta3",
1050
+ * "v1.custom-suffix",
1051
+ * "models.meshery.io/v1beta1",
1052
+ * "capability.meshery.io/v1alpha1"
1053
+ * ]
1054
+ */
1055
+ schemaVersion: string;
1056
+ };
1057
+ /**
1058
+ * Format: uuid
1059
+ * @description ID of the registrant.
1060
+ */
1061
+ registrantId: string;
1062
+ /**
1063
+ * Format: uuid
1064
+ * @description ID of the category.
1065
+ */
1066
+ categoryId: string;
1067
+ /** @description Category of the model. */
1068
+ category: {
1069
+ /**
1070
+ * Format: uuid
1071
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1072
+ */
1073
+ id: string;
1074
+ /**
1075
+ * @description The category of the model that determines the main grouping.
1076
+ * @default Uncategorized
1077
+ * @enum {string}
1078
+ */
1079
+ name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
1080
+ /** @description Additional metadata associated with the category. */
1081
+ metadata: Record<string, never>;
1082
+ };
1083
+ /**
1084
+ * SubCategory
1085
+ * @description Sub category of the model determines the secondary grouping.
1086
+ * @default Uncategorized
1087
+ * @enum {string}
1088
+ */
1089
+ subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
1090
+ /** @description Metadata containing additional information associated with the model. */
1091
+ metadata?: {
1092
+ /** @description Capabilities associated with the model */
1093
+ capabilities?: {
1094
+ /**
1095
+ * @description Specifies the version of the schema to which the capability definition conforms.
1096
+ * @example [
1097
+ * "v1",
1098
+ * "v1alpha1",
1099
+ * "v2beta3",
1100
+ * "v1.custom-suffix",
1101
+ * "models.meshery.io/v1beta1",
1102
+ * "capability.meshery.io/v1alpha1"
1103
+ * ]
1104
+ */
1105
+ schemaVersion: string;
1106
+ /** @description Version of the capability definition. */
1107
+ version: string;
1108
+ /** @description Name of the capability in human-readible format. */
1109
+ displayName: string;
1110
+ /** @description A written representation of the purpose and characteristics of the capability. */
1111
+ description: string;
1112
+ /** @description Top-level categorization of the capability */
1113
+ kind: string | "action" | "mutate" | "view" | "interaction";
1114
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
1115
+ type: string;
1116
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
1117
+ subType: string;
1118
+ /** @description Key that backs the capability. */
1119
+ key: string;
1120
+ /** @description State of the entity in which the capability is applicable. */
1121
+ entityState: ("declaration" | "instance")[];
1122
+ /**
1123
+ * @description Status of the capability
1124
+ * @default enabled
1125
+ * @enum {string}
1126
+ */
1127
+ status: "enabled" | "disabled";
1128
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
1129
+ metadata?: {
1130
+ [key: string]: unknown;
1131
+ };
1132
+ }[];
1133
+ /**
1134
+ * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
1135
+ * @default false
1136
+ */
1137
+ isAnnotation: boolean;
1138
+ /**
1139
+ * @description Primary color associated with the model.
1140
+ * @default #00b39f
1141
+ */
1142
+ primaryColor: string;
1143
+ /**
1144
+ * @description Secondary color associated with the model.
1145
+ * @default #00D3A9
1146
+ */
1147
+ secondaryColor: string;
1148
+ /**
1149
+ * @description SVG representation of the model in white color.
1150
+ * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
1151
+ */
1152
+ svgWhite: string;
1153
+ /**
1154
+ * @description SVG representation of the model in colored format.
1155
+ * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
1156
+ */
1157
+ svgColor: string;
1158
+ /** @description SVG representation of the complete model. */
1159
+ svgComplete?: string;
1160
+ /**
1161
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
1162
+ * @enum {string}
1163
+ */
1164
+ shape?: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
1165
+ } & {
1166
+ [key: string]: unknown;
1167
+ };
1168
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1169
+ model: {
1170
+ /** @description Version of the model as defined by the registrant. */
1171
+ version: string;
1172
+ };
1173
+ /** @description The relationships of the model. */
1174
+ relationships: unknown[];
1175
+ /** @description The components of the model. */
1176
+ components: unknown[];
1177
+ /**
1178
+ * @description Number of components associated with the model.
1179
+ * @default 0
1180
+ */
1181
+ componentsCount: number;
1182
+ /**
1183
+ * @description Number of relationships associated with the model.
1184
+ * @default 0
1185
+ */
1186
+ relationshipsCount: number;
1187
+ /**
1188
+ * Format: date-time
1189
+ * @description Timestamp when the resource was created.
1190
+ */
1191
+ created_at?: string;
1192
+ /**
1193
+ * Format: date-time
1194
+ * @description Timestamp when the resource was updated.
1195
+ */
1196
+ updated_at?: string;
613
1197
  }[];
614
1198
  };
615
1199
  };