@meshery/schemas 1.3.16 → 1.3.17

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 (40) hide show
  1. package/dist/cloudApi.d.mts +0 -600
  2. package/dist/cloudApi.d.ts +0 -600
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +15 -15
  6. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +15 -15
  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/evaluation/EvaluationSchema.js +20 -20
  10. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +20 -20
  11. package/dist/constructs/v1beta1/model/ModelSchema.js +1 -1
  12. package/dist/constructs/v1beta1/model/ModelSchema.mjs +1 -1
  13. package/dist/constructs/v1beta1/pattern/PatternSchema.js +55 -55
  14. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +55 -55
  15. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +10 -10
  16. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +10 -10
  17. package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
  18. package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
  19. package/dist/constructs/v1beta2/design/DesignSchema.js +55 -55
  20. package/dist/constructs/v1beta2/design/DesignSchema.mjs +55 -55
  21. package/dist/constructs/v1beta2/relationship/RelationshipSchema.js +15 -15
  22. package/dist/constructs/v1beta2/relationship/RelationshipSchema.mjs +15 -15
  23. package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
  24. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
  25. package/dist/constructs/v1beta3/connection/Connection.d.ts +167 -1979
  26. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -25
  27. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -25
  28. package/dist/constructs/v1beta3/design/DesignSchema.js +5 -5
  29. package/dist/constructs/v1beta3/design/DesignSchema.mjs +5 -5
  30. package/dist/constructs/v1beta3/relationship/RelationshipSchema.js +15 -15
  31. package/dist/constructs/v1beta3/relationship/RelationshipSchema.mjs +15 -15
  32. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +10 -10
  33. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +10 -10
  34. package/dist/index.js +153 -153
  35. package/dist/index.mjs +153 -153
  36. package/dist/mesheryApi.d.mts +0 -600
  37. package/dist/mesheryApi.d.ts +0 -600
  38. package/dist/mesheryApi.js +1 -1
  39. package/dist/mesheryApi.mjs +1 -1
  40. package/package.json +1 -1
@@ -3780,154 +3780,6 @@ type GetConnectionsApiResponse = {
3780
3780
  /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
3781
3781
  kind: string;
3782
3782
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
3783
- model?: {
3784
- /** Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design). */
3785
- id: string;
3786
- /** Specifies the version of the schema used for the definition. */
3787
- schemaVersion: string;
3788
- /** Version of the model definition. */
3789
- version: string;
3790
- /** The unique name for the model within the scope of a registrant. */
3791
- name: string;
3792
- /** Human-readable name for the model. */
3793
- displayName: string;
3794
- /** Description of the model. */
3795
- description: string;
3796
- /** Status of model, including:
3797
- - 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.
3798
- - maintenance: model is unavailable for a period of time.
3799
- - enabled: model is available for use for all users of this Meshery Server.
3800
- - ignored: model is unavailable for use for all users of this Meshery Server. */
3801
- status: "ignored" | "enabled" | "duplicate";
3802
- /** 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 */
3803
- registrant: {
3804
- /** Connection ID */
3805
- id: string;
3806
- /** Connection Name */
3807
- name: string;
3808
- /** Associated Credential ID */
3809
- credentialId?: string;
3810
- /** Connection Type (platform, telemetry, collaboration) */
3811
- type: string;
3812
- /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
3813
- subType: string;
3814
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
3815
- kind: string;
3816
- /** Additional connection metadata */
3817
- metadata?: object;
3818
- /** Connection Status */
3819
- status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
3820
- /** User ID who owns this connection */
3821
- user_id?: string;
3822
- created_at?: string;
3823
- updated_at?: string;
3824
- /** SQL null Timestamp to handle null values of time. */
3825
- deleted_at?: string;
3826
- /** Associated environments for this connection */
3827
- environments?: {
3828
- /** ID */
3829
- id: string;
3830
- /** Specifies the version of the schema to which the environment conforms. */
3831
- schemaVersion: string;
3832
- /** Environment name */
3833
- name: string;
3834
- /** Environment description */
3835
- description: string;
3836
- /** Environment organization ID */
3837
- organization_id: string;
3838
- /** Environment owner */
3839
- owner?: string;
3840
- /** Timestamp when the resource was created. */
3841
- created_at?: string;
3842
- /** Additional metadata associated with the environment. */
3843
- metadata?: object;
3844
- /** Timestamp when the resource was updated. */
3845
- updated_at?: string;
3846
- /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
3847
- deleted_at?: string | null;
3848
- }[];
3849
- /** Specifies the version of the schema used for the definition. */
3850
- schemaVersion: string;
3851
- };
3852
- /** ID of the registrant. */
3853
- registrantId: string;
3854
- /** ID of the category. */
3855
- categoryId: string;
3856
- /** Category of the model. */
3857
- category: {
3858
- /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
3859
- id: string;
3860
- /** The category of the model that determines the main grouping. */
3861
- 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";
3862
- /** Additional metadata associated with the category. */
3863
- metadata: object;
3864
- };
3865
- /** Sub category of the model determines the secondary grouping. */
3866
- 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";
3867
- /** Metadata containing additional information associated with the model. */
3868
- metadata?: {
3869
- /** Capabilities associated with the model */
3870
- capabilities?: {
3871
- /** Specifies the version of the schema to which the capability definition conforms. */
3872
- schemaVersion: string;
3873
- /** Version of the capability definition. */
3874
- version: string;
3875
- /** Name of the capability in human-readible format. */
3876
- displayName: string;
3877
- /** A written representation of the purpose and characteristics of the capability. */
3878
- description: string;
3879
- /** Top-level categorization of the capability */
3880
- kind: "action" | "mutate" | "view" | "interaction";
3881
- /** Classification of capabilities. Used to group capabilities similar in nature. */
3882
- type: string;
3883
- /** Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
3884
- subType: string;
3885
- /** Key that backs the capability. */
3886
- key: string;
3887
- /** State of the entity in which the capability is applicable. */
3888
- entityState: ("declaration" | "instance")[];
3889
- /** Status of the capability */
3890
- status: "enabled" | "disabled";
3891
- /** Metadata contains additional information associated with the capability. Extension point. */
3892
- metadata?: {
3893
- [key: string]: any;
3894
- };
3895
- }[];
3896
- /** Indicates whether the model and its entities should be treated as deployable entities or as logical representations. */
3897
- isAnnotation?: boolean;
3898
- /** Primary color associated with the model. */
3899
- primaryColor?: string;
3900
- /** Secondary color associated with the model. */
3901
- secondaryColor?: string;
3902
- /** SVG representation of the model in white color. */
3903
- svgWhite: string;
3904
- /** SVG representation of the model in colored format. */
3905
- svgColor: string;
3906
- /** SVG representation of the complete model. */
3907
- svgComplete?: string;
3908
- /** 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) */
3909
- 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";
3910
- [key: string]: any;
3911
- };
3912
- /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3913
- model: {
3914
- /** Version of the model as defined by the registrant. */
3915
- version: string;
3916
- };
3917
- /** The relationships of the model. */
3918
- relationships: any;
3919
- /** The components of the model. */
3920
- components: any;
3921
- /** Number of components associated with the model. */
3922
- componentsCount: number;
3923
- /** Number of relationships associated with the model. */
3924
- relationshipsCount: number;
3925
- /** Timestamp when the resource was created. */
3926
- created_at?: string;
3927
- /** Timestamp when the resource was updated. */
3928
- updated_at?: string;
3929
- };
3930
- /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
3931
3783
  modelReference?: {
3932
3784
  /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
3933
3785
  id: string;
@@ -3947,8 +3799,6 @@ type GetConnectionsApiResponse = {
3947
3799
  kind: string;
3948
3800
  };
3949
3801
  };
3950
- /** Foreign key to the model to which the component belongs. Populated by the ORM from the `model_id` column and suppressed on the JSON wire; consumers use the nested `model` object for wire-level access. */
3951
- modelId?: string;
3952
3802
  /** Additional connection metadata */
3953
3803
  metadata?: object;
3954
3804
  /** Schema for the credential Associated with the connection */
@@ -4187,154 +4037,6 @@ type RegisterConnectionApiResponse = {
4187
4037
  /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
4188
4038
  kind: string;
4189
4039
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4190
- model?: {
4191
- /** Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design). */
4192
- id: string;
4193
- /** Specifies the version of the schema used for the definition. */
4194
- schemaVersion: string;
4195
- /** Version of the model definition. */
4196
- version: string;
4197
- /** The unique name for the model within the scope of a registrant. */
4198
- name: string;
4199
- /** Human-readable name for the model. */
4200
- displayName: string;
4201
- /** Description of the model. */
4202
- description: string;
4203
- /** Status of model, including:
4204
- - 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.
4205
- - maintenance: model is unavailable for a period of time.
4206
- - enabled: model is available for use for all users of this Meshery Server.
4207
- - ignored: model is unavailable for use for all users of this Meshery Server. */
4208
- status: "ignored" | "enabled" | "duplicate";
4209
- /** 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 */
4210
- registrant: {
4211
- /** Connection ID */
4212
- id: string;
4213
- /** Connection Name */
4214
- name: string;
4215
- /** Associated Credential ID */
4216
- credentialId?: string;
4217
- /** Connection Type (platform, telemetry, collaboration) */
4218
- type: string;
4219
- /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
4220
- subType: string;
4221
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
4222
- kind: string;
4223
- /** Additional connection metadata */
4224
- metadata?: object;
4225
- /** Connection Status */
4226
- status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4227
- /** User ID who owns this connection */
4228
- user_id?: string;
4229
- created_at?: string;
4230
- updated_at?: string;
4231
- /** SQL null Timestamp to handle null values of time. */
4232
- deleted_at?: string;
4233
- /** Associated environments for this connection */
4234
- environments?: {
4235
- /** ID */
4236
- id: string;
4237
- /** Specifies the version of the schema to which the environment conforms. */
4238
- schemaVersion: string;
4239
- /** Environment name */
4240
- name: string;
4241
- /** Environment description */
4242
- description: string;
4243
- /** Environment organization ID */
4244
- organization_id: string;
4245
- /** Environment owner */
4246
- owner?: string;
4247
- /** Timestamp when the resource was created. */
4248
- created_at?: string;
4249
- /** Additional metadata associated with the environment. */
4250
- metadata?: object;
4251
- /** Timestamp when the resource was updated. */
4252
- updated_at?: string;
4253
- /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
4254
- deleted_at?: string | null;
4255
- }[];
4256
- /** Specifies the version of the schema used for the definition. */
4257
- schemaVersion: string;
4258
- };
4259
- /** ID of the registrant. */
4260
- registrantId: string;
4261
- /** ID of the category. */
4262
- categoryId: string;
4263
- /** Category of the model. */
4264
- category: {
4265
- /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
4266
- id: string;
4267
- /** The category of the model that determines the main grouping. */
4268
- 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";
4269
- /** Additional metadata associated with the category. */
4270
- metadata: object;
4271
- };
4272
- /** Sub category of the model determines the secondary grouping. */
4273
- 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";
4274
- /** Metadata containing additional information associated with the model. */
4275
- metadata?: {
4276
- /** Capabilities associated with the model */
4277
- capabilities?: {
4278
- /** Specifies the version of the schema to which the capability definition conforms. */
4279
- schemaVersion: string;
4280
- /** Version of the capability definition. */
4281
- version: string;
4282
- /** Name of the capability in human-readible format. */
4283
- displayName: string;
4284
- /** A written representation of the purpose and characteristics of the capability. */
4285
- description: string;
4286
- /** Top-level categorization of the capability */
4287
- kind: "action" | "mutate" | "view" | "interaction";
4288
- /** Classification of capabilities. Used to group capabilities similar in nature. */
4289
- type: string;
4290
- /** Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
4291
- subType: string;
4292
- /** Key that backs the capability. */
4293
- key: string;
4294
- /** State of the entity in which the capability is applicable. */
4295
- entityState: ("declaration" | "instance")[];
4296
- /** Status of the capability */
4297
- status: "enabled" | "disabled";
4298
- /** Metadata contains additional information associated with the capability. Extension point. */
4299
- metadata?: {
4300
- [key: string]: any;
4301
- };
4302
- }[];
4303
- /** Indicates whether the model and its entities should be treated as deployable entities or as logical representations. */
4304
- isAnnotation?: boolean;
4305
- /** Primary color associated with the model. */
4306
- primaryColor?: string;
4307
- /** Secondary color associated with the model. */
4308
- secondaryColor?: string;
4309
- /** SVG representation of the model in white color. */
4310
- svgWhite: string;
4311
- /** SVG representation of the model in colored format. */
4312
- svgColor: string;
4313
- /** SVG representation of the complete model. */
4314
- svgComplete?: string;
4315
- /** 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) */
4316
- 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";
4317
- [key: string]: any;
4318
- };
4319
- /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
4320
- model: {
4321
- /** Version of the model as defined by the registrant. */
4322
- version: string;
4323
- };
4324
- /** The relationships of the model. */
4325
- relationships: any;
4326
- /** The components of the model. */
4327
- components: any;
4328
- /** Number of components associated with the model. */
4329
- componentsCount: number;
4330
- /** Number of relationships associated with the model. */
4331
- relationshipsCount: number;
4332
- /** Timestamp when the resource was created. */
4333
- created_at?: string;
4334
- /** Timestamp when the resource was updated. */
4335
- updated_at?: string;
4336
- };
4337
- /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4338
4040
  modelReference?: {
4339
4041
  /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
4340
4042
  id: string;
@@ -4354,8 +4056,6 @@ type RegisterConnectionApiResponse = {
4354
4056
  kind: string;
4355
4057
  };
4356
4058
  };
4357
- /** Foreign key to the model to which the component belongs. Populated by the ORM from the `model_id` column and suppressed on the JSON wire; consumers use the nested `model` object for wire-level access. */
4358
- modelId?: string;
4359
4059
  /** Additional connection metadata */
4360
4060
  metadata?: object;
4361
4061
  /** Schema for the credential Associated with the connection */
@@ -4719,154 +4419,6 @@ type GetConnectionByIdApiResponse = {
4719
4419
  /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
4720
4420
  kind: string;
4721
4421
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4722
- model?: {
4723
- /** Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design). */
4724
- id: string;
4725
- /** Specifies the version of the schema used for the definition. */
4726
- schemaVersion: string;
4727
- /** Version of the model definition. */
4728
- version: string;
4729
- /** The unique name for the model within the scope of a registrant. */
4730
- name: string;
4731
- /** Human-readable name for the model. */
4732
- displayName: string;
4733
- /** Description of the model. */
4734
- description: string;
4735
- /** Status of model, including:
4736
- - 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.
4737
- - maintenance: model is unavailable for a period of time.
4738
- - enabled: model is available for use for all users of this Meshery Server.
4739
- - ignored: model is unavailable for use for all users of this Meshery Server. */
4740
- status: "ignored" | "enabled" | "duplicate";
4741
- /** 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 */
4742
- registrant: {
4743
- /** Connection ID */
4744
- id: string;
4745
- /** Connection Name */
4746
- name: string;
4747
- /** Associated Credential ID */
4748
- credentialId?: string;
4749
- /** Connection Type (platform, telemetry, collaboration) */
4750
- type: string;
4751
- /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
4752
- subType: string;
4753
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
4754
- kind: string;
4755
- /** Additional connection metadata */
4756
- metadata?: object;
4757
- /** Connection Status */
4758
- status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4759
- /** User ID who owns this connection */
4760
- user_id?: string;
4761
- created_at?: string;
4762
- updated_at?: string;
4763
- /** SQL null Timestamp to handle null values of time. */
4764
- deleted_at?: string;
4765
- /** Associated environments for this connection */
4766
- environments?: {
4767
- /** ID */
4768
- id: string;
4769
- /** Specifies the version of the schema to which the environment conforms. */
4770
- schemaVersion: string;
4771
- /** Environment name */
4772
- name: string;
4773
- /** Environment description */
4774
- description: string;
4775
- /** Environment organization ID */
4776
- organization_id: string;
4777
- /** Environment owner */
4778
- owner?: string;
4779
- /** Timestamp when the resource was created. */
4780
- created_at?: string;
4781
- /** Additional metadata associated with the environment. */
4782
- metadata?: object;
4783
- /** Timestamp when the resource was updated. */
4784
- updated_at?: string;
4785
- /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
4786
- deleted_at?: string | null;
4787
- }[];
4788
- /** Specifies the version of the schema used for the definition. */
4789
- schemaVersion: string;
4790
- };
4791
- /** ID of the registrant. */
4792
- registrantId: string;
4793
- /** ID of the category. */
4794
- categoryId: string;
4795
- /** Category of the model. */
4796
- category: {
4797
- /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
4798
- id: string;
4799
- /** The category of the model that determines the main grouping. */
4800
- 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";
4801
- /** Additional metadata associated with the category. */
4802
- metadata: object;
4803
- };
4804
- /** Sub category of the model determines the secondary grouping. */
4805
- 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";
4806
- /** Metadata containing additional information associated with the model. */
4807
- metadata?: {
4808
- /** Capabilities associated with the model */
4809
- capabilities?: {
4810
- /** Specifies the version of the schema to which the capability definition conforms. */
4811
- schemaVersion: string;
4812
- /** Version of the capability definition. */
4813
- version: string;
4814
- /** Name of the capability in human-readible format. */
4815
- displayName: string;
4816
- /** A written representation of the purpose and characteristics of the capability. */
4817
- description: string;
4818
- /** Top-level categorization of the capability */
4819
- kind: "action" | "mutate" | "view" | "interaction";
4820
- /** Classification of capabilities. Used to group capabilities similar in nature. */
4821
- type: string;
4822
- /** Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
4823
- subType: string;
4824
- /** Key that backs the capability. */
4825
- key: string;
4826
- /** State of the entity in which the capability is applicable. */
4827
- entityState: ("declaration" | "instance")[];
4828
- /** Status of the capability */
4829
- status: "enabled" | "disabled";
4830
- /** Metadata contains additional information associated with the capability. Extension point. */
4831
- metadata?: {
4832
- [key: string]: any;
4833
- };
4834
- }[];
4835
- /** Indicates whether the model and its entities should be treated as deployable entities or as logical representations. */
4836
- isAnnotation?: boolean;
4837
- /** Primary color associated with the model. */
4838
- primaryColor?: string;
4839
- /** Secondary color associated with the model. */
4840
- secondaryColor?: string;
4841
- /** SVG representation of the model in white color. */
4842
- svgWhite: string;
4843
- /** SVG representation of the model in colored format. */
4844
- svgColor: string;
4845
- /** SVG representation of the complete model. */
4846
- svgComplete?: string;
4847
- /** 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) */
4848
- 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";
4849
- [key: string]: any;
4850
- };
4851
- /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
4852
- model: {
4853
- /** Version of the model as defined by the registrant. */
4854
- version: string;
4855
- };
4856
- /** The relationships of the model. */
4857
- relationships: any;
4858
- /** The components of the model. */
4859
- components: any;
4860
- /** Number of components associated with the model. */
4861
- componentsCount: number;
4862
- /** Number of relationships associated with the model. */
4863
- relationshipsCount: number;
4864
- /** Timestamp when the resource was created. */
4865
- created_at?: string;
4866
- /** Timestamp when the resource was updated. */
4867
- updated_at?: string;
4868
- };
4869
- /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4870
4422
  modelReference?: {
4871
4423
  /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
4872
4424
  id: string;
@@ -4886,8 +4438,6 @@ type GetConnectionByIdApiResponse = {
4886
4438
  kind: string;
4887
4439
  };
4888
4440
  };
4889
- /** Foreign key to the model to which the component belongs. Populated by the ORM from the `model_id` column and suppressed on the JSON wire; consumers use the nested `model` object for wire-level access. */
4890
- modelId?: string;
4891
4441
  /** Additional connection metadata */
4892
4442
  metadata?: object;
4893
4443
  /** Schema for the credential Associated with the connection */
@@ -5097,154 +4647,6 @@ type UpdateConnectionApiResponse = {
5097
4647
  /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
5098
4648
  kind: string;
5099
4649
  /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
5100
- model?: {
5101
- /** Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design). */
5102
- id: string;
5103
- /** Specifies the version of the schema used for the definition. */
5104
- schemaVersion: string;
5105
- /** Version of the model definition. */
5106
- version: string;
5107
- /** The unique name for the model within the scope of a registrant. */
5108
- name: string;
5109
- /** Human-readable name for the model. */
5110
- displayName: string;
5111
- /** Description of the model. */
5112
- description: string;
5113
- /** Status of model, including:
5114
- - 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.
5115
- - maintenance: model is unavailable for a period of time.
5116
- - enabled: model is available for use for all users of this Meshery Server.
5117
- - ignored: model is unavailable for use for all users of this Meshery Server. */
5118
- status: "ignored" | "enabled" | "duplicate";
5119
- /** 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 */
5120
- registrant: {
5121
- /** Connection ID */
5122
- id: string;
5123
- /** Connection Name */
5124
- name: string;
5125
- /** Associated Credential ID */
5126
- credentialId?: string;
5127
- /** Connection Type (platform, telemetry, collaboration) */
5128
- type: string;
5129
- /** Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
5130
- subType: string;
5131
- /** Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
5132
- kind: string;
5133
- /** Additional connection metadata */
5134
- metadata?: object;
5135
- /** Connection Status */
5136
- status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
5137
- /** User ID who owns this connection */
5138
- user_id?: string;
5139
- created_at?: string;
5140
- updated_at?: string;
5141
- /** SQL null Timestamp to handle null values of time. */
5142
- deleted_at?: string;
5143
- /** Associated environments for this connection */
5144
- environments?: {
5145
- /** ID */
5146
- id: string;
5147
- /** Specifies the version of the schema to which the environment conforms. */
5148
- schemaVersion: string;
5149
- /** Environment name */
5150
- name: string;
5151
- /** Environment description */
5152
- description: string;
5153
- /** Environment organization ID */
5154
- organization_id: string;
5155
- /** Environment owner */
5156
- owner?: string;
5157
- /** Timestamp when the resource was created. */
5158
- created_at?: string;
5159
- /** Additional metadata associated with the environment. */
5160
- metadata?: object;
5161
- /** Timestamp when the resource was updated. */
5162
- updated_at?: string;
5163
- /** Timestamp when the environment was soft deleted. Null while the environment remains active. */
5164
- deleted_at?: string | null;
5165
- }[];
5166
- /** Specifies the version of the schema used for the definition. */
5167
- schemaVersion: string;
5168
- };
5169
- /** ID of the registrant. */
5170
- registrantId: string;
5171
- /** ID of the category. */
5172
- categoryId: string;
5173
- /** Category of the model. */
5174
- category: {
5175
- /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
5176
- id: string;
5177
- /** The category of the model that determines the main grouping. */
5178
- 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";
5179
- /** Additional metadata associated with the category. */
5180
- metadata: object;
5181
- };
5182
- /** Sub category of the model determines the secondary grouping. */
5183
- 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";
5184
- /** Metadata containing additional information associated with the model. */
5185
- metadata?: {
5186
- /** Capabilities associated with the model */
5187
- capabilities?: {
5188
- /** Specifies the version of the schema to which the capability definition conforms. */
5189
- schemaVersion: string;
5190
- /** Version of the capability definition. */
5191
- version: string;
5192
- /** Name of the capability in human-readible format. */
5193
- displayName: string;
5194
- /** A written representation of the purpose and characteristics of the capability. */
5195
- description: string;
5196
- /** Top-level categorization of the capability */
5197
- kind: "action" | "mutate" | "view" | "interaction";
5198
- /** Classification of capabilities. Used to group capabilities similar in nature. */
5199
- type: string;
5200
- /** Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
5201
- subType: string;
5202
- /** Key that backs the capability. */
5203
- key: string;
5204
- /** State of the entity in which the capability is applicable. */
5205
- entityState: ("declaration" | "instance")[];
5206
- /** Status of the capability */
5207
- status: "enabled" | "disabled";
5208
- /** Metadata contains additional information associated with the capability. Extension point. */
5209
- metadata?: {
5210
- [key: string]: any;
5211
- };
5212
- }[];
5213
- /** Indicates whether the model and its entities should be treated as deployable entities or as logical representations. */
5214
- isAnnotation?: boolean;
5215
- /** Primary color associated with the model. */
5216
- primaryColor?: string;
5217
- /** Secondary color associated with the model. */
5218
- secondaryColor?: string;
5219
- /** SVG representation of the model in white color. */
5220
- svgWhite: string;
5221
- /** SVG representation of the model in colored format. */
5222
- svgColor: string;
5223
- /** SVG representation of the complete model. */
5224
- svgComplete?: string;
5225
- /** 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) */
5226
- 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";
5227
- [key: string]: any;
5228
- };
5229
- /** Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
5230
- model: {
5231
- /** Version of the model as defined by the registrant. */
5232
- version: string;
5233
- };
5234
- /** The relationships of the model. */
5235
- relationships: any;
5236
- /** The components of the model. */
5237
- components: any;
5238
- /** Number of components associated with the model. */
5239
- componentsCount: number;
5240
- /** Number of relationships associated with the model. */
5241
- relationshipsCount: number;
5242
- /** Timestamp when the resource was created. */
5243
- created_at?: string;
5244
- /** Timestamp when the resource was updated. */
5245
- updated_at?: string;
5246
- };
5247
- /** Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
5248
4650
  modelReference?: {
5249
4651
  /** A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas. */
5250
4652
  id: string;
@@ -5264,8 +4666,6 @@ type UpdateConnectionApiResponse = {
5264
4666
  kind: string;
5265
4667
  };
5266
4668
  };
5267
- /** Foreign key to the model to which the component belongs. Populated by the ORM from the `model_id` column and suppressed on the JSON wire; consumers use the nested `model` object for wire-level access. */
5268
- modelId?: string;
5269
4669
  /** Additional connection metadata */
5270
4670
  metadata?: object;
5271
4671
  /** Schema for the credential Associated with the connection */