@meshery/schemas 1.3.44 → 1.3.46
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +882 -4
- package/dist/cloudApi.d.ts +882 -4
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +1424 -3
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +49 -1
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +49 -1
- package/dist/constructs/v1beta2/design/Design.d.ts +1557 -47
- package/dist/constructs/v1beta2/design/DesignSchema.js +137 -45
- package/dist/constructs/v1beta2/design/DesignSchema.mjs +137 -45
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +34 -17
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.js +34 -17
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.mjs +34 -17
- package/dist/constructs/v1beta3/design/Design.d.ts +371 -7
- package/dist/constructs/v1beta3/design/DesignSchema.js +14 -5
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +14 -5
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +685 -100
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.js +468 -18
- package/dist/constructs/v1beta3/relationship/RelationshipSchema.mjs +468 -18
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +436 -0
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +1 -1
- package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +1 -1
- package/dist/index.d.mts +74 -37
- package/dist/index.d.ts +74 -37
- package/dist/index.js +226 -69
- package/dist/index.mjs +226 -69
- package/dist/mesheryApi.d.mts +235 -3
- package/dist/mesheryApi.d.ts +235 -3
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +71 -1
- package/dist/permissions.d.ts +71 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +2 -2
|
@@ -15433,15 +15433,1436 @@ export interface operations {
|
|
|
15433
15433
|
};
|
|
15434
15434
|
};
|
|
15435
15435
|
responses: {
|
|
15436
|
-
/** @description Successful
|
|
15436
|
+
/** @description Successful import. The response body is a JSON array of the saved designs, not a message envelope. The import path saves exactly one design, so the array carries a single element and consumers read the imported design as the first element. */
|
|
15437
15437
|
200: {
|
|
15438
15438
|
headers: {
|
|
15439
15439
|
[name: string]: unknown;
|
|
15440
15440
|
};
|
|
15441
15441
|
content: {
|
|
15442
15442
|
"application/json": {
|
|
15443
|
-
|
|
15444
|
-
|
|
15443
|
+
catalogData?: {
|
|
15444
|
+
/** @description Tracks the specific content version that has been made available in the Catalog. */
|
|
15445
|
+
publishedVersion?: string;
|
|
15446
|
+
/** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
|
|
15447
|
+
class?: string & ("official" | "verified" | "reference architecture");
|
|
15448
|
+
/**
|
|
15449
|
+
* Model
|
|
15450
|
+
* @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
|
|
15451
|
+
*/
|
|
15452
|
+
compatibility: "kubernetes"[];
|
|
15453
|
+
/**
|
|
15454
|
+
* Caveats and Considerations
|
|
15455
|
+
* @description Specific stipulations to consider and known behaviors to be aware of when using this design.
|
|
15456
|
+
*/
|
|
15457
|
+
pattern_caveats: string;
|
|
15458
|
+
/**
|
|
15459
|
+
* Description
|
|
15460
|
+
* @description Purpose of the design along with its intended and unintended uses.
|
|
15461
|
+
*/
|
|
15462
|
+
pattern_info: string;
|
|
15463
|
+
/**
|
|
15464
|
+
* Type
|
|
15465
|
+
* @description Categorization of the type of design or operational flow depicted in this design.
|
|
15466
|
+
* @default Deployment
|
|
15467
|
+
* @enum {string}
|
|
15468
|
+
*/
|
|
15469
|
+
type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
|
|
15470
|
+
/** @description Contains reference to the dark and light mode snapshots of the design. */
|
|
15471
|
+
snapshotURL?: string[];
|
|
15472
|
+
};
|
|
15473
|
+
/** Format: date-time */
|
|
15474
|
+
created_at?: string;
|
|
15475
|
+
/** Format: uuid */
|
|
15476
|
+
user_id?: string;
|
|
15477
|
+
location?: {
|
|
15478
|
+
[key: string]: string;
|
|
15479
|
+
};
|
|
15480
|
+
name?: string;
|
|
15481
|
+
/**
|
|
15482
|
+
* Design Schema
|
|
15483
|
+
* @description Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
|
|
15484
|
+
*/
|
|
15485
|
+
patternFile?: {
|
|
15486
|
+
/**
|
|
15487
|
+
* Format: uuid
|
|
15488
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15489
|
+
*/
|
|
15490
|
+
id: string;
|
|
15491
|
+
/** @description Name of the design; a descriptive, but concise title for the design document. */
|
|
15492
|
+
name: string;
|
|
15493
|
+
/**
|
|
15494
|
+
* @description Specifies the version of the schema to which the design conforms.
|
|
15495
|
+
* @example [
|
|
15496
|
+
* "v1",
|
|
15497
|
+
* "v1alpha1",
|
|
15498
|
+
* "v2beta3",
|
|
15499
|
+
* "v1.custom-suffix",
|
|
15500
|
+
* "models.meshery.io/v1beta1",
|
|
15501
|
+
* "capability.meshery.io/v1alpha1"
|
|
15502
|
+
* ]
|
|
15503
|
+
*/
|
|
15504
|
+
schemaVersion: string;
|
|
15505
|
+
/**
|
|
15506
|
+
* @description Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.
|
|
15507
|
+
* @default v0.0.1
|
|
15508
|
+
*/
|
|
15509
|
+
version: string;
|
|
15510
|
+
metadata?: {
|
|
15511
|
+
/** @description Map of resolved aliases present in the design */
|
|
15512
|
+
resolvedAliases?: {
|
|
15513
|
+
[key: string]: {
|
|
15514
|
+
/**
|
|
15515
|
+
* Format: uuid
|
|
15516
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15517
|
+
*/
|
|
15518
|
+
relationship_id: string;
|
|
15519
|
+
/**
|
|
15520
|
+
* Format: uuid
|
|
15521
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15522
|
+
*/
|
|
15523
|
+
alias_component_id: string;
|
|
15524
|
+
/**
|
|
15525
|
+
* Format: uuid
|
|
15526
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15527
|
+
*/
|
|
15528
|
+
immediate_parent_id: string;
|
|
15529
|
+
immediate_ref_field_path: string[];
|
|
15530
|
+
} & {
|
|
15531
|
+
/**
|
|
15532
|
+
* Format: uuid
|
|
15533
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15534
|
+
*/
|
|
15535
|
+
resolved_parent_id: string;
|
|
15536
|
+
resolved_ref_field_path: string[];
|
|
15537
|
+
};
|
|
15538
|
+
};
|
|
15539
|
+
} & {
|
|
15540
|
+
[key: string]: unknown;
|
|
15541
|
+
};
|
|
15542
|
+
/** @description A list of one or more component declarations. */
|
|
15543
|
+
components: {
|
|
15544
|
+
/**
|
|
15545
|
+
* Format: uuid
|
|
15546
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15547
|
+
*/
|
|
15548
|
+
id: string;
|
|
15549
|
+
/**
|
|
15550
|
+
* @description Specifies the version of the schema to which the component definition conforms.
|
|
15551
|
+
* @default components.meshery.io/v1beta1
|
|
15552
|
+
* @example [
|
|
15553
|
+
* "v1",
|
|
15554
|
+
* "v1alpha1",
|
|
15555
|
+
* "v2beta3",
|
|
15556
|
+
* "v1.custom-suffix",
|
|
15557
|
+
* "models.meshery.io/v1beta1",
|
|
15558
|
+
* "capability.meshery.io/v1alpha1"
|
|
15559
|
+
* ]
|
|
15560
|
+
*/
|
|
15561
|
+
schemaVersion: string;
|
|
15562
|
+
/** @description Version of the component definition. */
|
|
15563
|
+
version: string;
|
|
15564
|
+
/** @description Name of the component in human-readible format. */
|
|
15565
|
+
displayName: string;
|
|
15566
|
+
/** @description A written representation of the purpose and characteristics of the component. */
|
|
15567
|
+
description: string;
|
|
15568
|
+
/**
|
|
15569
|
+
* @description Format specifies the format used in the `component.schema` field. JSON is the default.
|
|
15570
|
+
* @default JSON
|
|
15571
|
+
* @enum {string}
|
|
15572
|
+
*/
|
|
15573
|
+
format: "JSON" | "CUE";
|
|
15574
|
+
/** @description 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 */
|
|
15575
|
+
model: {
|
|
15576
|
+
/**
|
|
15577
|
+
* Format: uuid
|
|
15578
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15579
|
+
*/
|
|
15580
|
+
id: string;
|
|
15581
|
+
/**
|
|
15582
|
+
* @description Specifies the version of the schema used for the definition.
|
|
15583
|
+
* @default models.meshery.io/v1beta1
|
|
15584
|
+
* @example [
|
|
15585
|
+
* "v1",
|
|
15586
|
+
* "v1alpha1",
|
|
15587
|
+
* "v2beta3",
|
|
15588
|
+
* "v1.custom-suffix",
|
|
15589
|
+
* "models.meshery.io/v1beta1",
|
|
15590
|
+
* "capability.meshery.io/v1alpha1"
|
|
15591
|
+
* ]
|
|
15592
|
+
*/
|
|
15593
|
+
schemaVersion: string;
|
|
15594
|
+
/** @description Version of the model definition. */
|
|
15595
|
+
version: string;
|
|
15596
|
+
/**
|
|
15597
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
15598
|
+
* @default untitled-model
|
|
15599
|
+
* @example cert-manager
|
|
15600
|
+
*/
|
|
15601
|
+
name: string;
|
|
15602
|
+
/**
|
|
15603
|
+
* @description Human-readable name for the model.
|
|
15604
|
+
* @default Untitled Model
|
|
15605
|
+
* @example Cert Manager
|
|
15606
|
+
*/
|
|
15607
|
+
displayName: string;
|
|
15608
|
+
/**
|
|
15609
|
+
* @description Description of the model.
|
|
15610
|
+
* @default A new Meshery model.
|
|
15611
|
+
*/
|
|
15612
|
+
description: string;
|
|
15613
|
+
/**
|
|
15614
|
+
* @description Status of model, including:
|
|
15615
|
+
* - 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.
|
|
15616
|
+
* - maintenance: model is unavailable for a period of time.
|
|
15617
|
+
* - enabled: model is available for use for all users of this Meshery Server.
|
|
15618
|
+
* - ignored: model is unavailable for use for all users of this Meshery Server.
|
|
15619
|
+
* @default enabled
|
|
15620
|
+
* @enum {string}
|
|
15621
|
+
*/
|
|
15622
|
+
status: "ignored" | "enabled" | "duplicate";
|
|
15623
|
+
/** @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 */
|
|
15624
|
+
registrant: {
|
|
15625
|
+
/**
|
|
15626
|
+
* Format: uuid
|
|
15627
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15628
|
+
*/
|
|
15629
|
+
id: string;
|
|
15630
|
+
/** @description Connection Name */
|
|
15631
|
+
name: string;
|
|
15632
|
+
/**
|
|
15633
|
+
* Format: uuid
|
|
15634
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15635
|
+
*/
|
|
15636
|
+
credentialId?: string;
|
|
15637
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
15638
|
+
type: string;
|
|
15639
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
15640
|
+
subType: string;
|
|
15641
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
15642
|
+
kind: string;
|
|
15643
|
+
/** @description Additional connection metadata */
|
|
15644
|
+
metadata?: Record<string, never>;
|
|
15645
|
+
/**
|
|
15646
|
+
* @description Connection Status
|
|
15647
|
+
* @enum {string}
|
|
15648
|
+
*/
|
|
15649
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
15650
|
+
/**
|
|
15651
|
+
* Format: uuid
|
|
15652
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15653
|
+
*/
|
|
15654
|
+
user_id?: string;
|
|
15655
|
+
/** Format: date-time */
|
|
15656
|
+
created_at?: string;
|
|
15657
|
+
/** Format: date-time */
|
|
15658
|
+
updated_at?: string;
|
|
15659
|
+
/**
|
|
15660
|
+
* Format: date-time
|
|
15661
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
15662
|
+
*/
|
|
15663
|
+
deleted_at?: string;
|
|
15664
|
+
/** @description Associated environments for this connection */
|
|
15665
|
+
environments?: {
|
|
15666
|
+
/**
|
|
15667
|
+
* Format: uuid
|
|
15668
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15669
|
+
*/
|
|
15670
|
+
id: string;
|
|
15671
|
+
/**
|
|
15672
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
15673
|
+
* @default environments.meshery.io/v1beta1
|
|
15674
|
+
* @example [
|
|
15675
|
+
* "v1",
|
|
15676
|
+
* "v1alpha1",
|
|
15677
|
+
* "v2beta3",
|
|
15678
|
+
* "v1.custom-suffix",
|
|
15679
|
+
* "models.meshery.io/v1beta1",
|
|
15680
|
+
* "capability.meshery.io/v1alpha1"
|
|
15681
|
+
* ]
|
|
15682
|
+
*/
|
|
15683
|
+
schemaVersion: string;
|
|
15684
|
+
/** @description Environment name */
|
|
15685
|
+
name: string;
|
|
15686
|
+
/** @description Environment description */
|
|
15687
|
+
description: string;
|
|
15688
|
+
/**
|
|
15689
|
+
* Format: uuid
|
|
15690
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15691
|
+
*/
|
|
15692
|
+
organization_id: string;
|
|
15693
|
+
/**
|
|
15694
|
+
* Format: uuid
|
|
15695
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15696
|
+
*/
|
|
15697
|
+
owner?: string;
|
|
15698
|
+
/**
|
|
15699
|
+
* Format: date-time
|
|
15700
|
+
* @description Timestamp when the resource was created.
|
|
15701
|
+
*/
|
|
15702
|
+
created_at?: string;
|
|
15703
|
+
/** @description Additional metadata associated with the environment. */
|
|
15704
|
+
metadata?: Record<string, never>;
|
|
15705
|
+
/**
|
|
15706
|
+
* Format: date-time
|
|
15707
|
+
* @description Timestamp when the resource was updated.
|
|
15708
|
+
*/
|
|
15709
|
+
updated_at?: string;
|
|
15710
|
+
/**
|
|
15711
|
+
* Format: date-time
|
|
15712
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
15713
|
+
*/
|
|
15714
|
+
deleted_at?: string | null;
|
|
15715
|
+
}[];
|
|
15716
|
+
/**
|
|
15717
|
+
* @description Specifies the version of the schema used for the definition.
|
|
15718
|
+
* @default connections.meshery.io/v1beta1
|
|
15719
|
+
* @example [
|
|
15720
|
+
* "v1",
|
|
15721
|
+
* "v1alpha1",
|
|
15722
|
+
* "v2beta3",
|
|
15723
|
+
* "v1.custom-suffix",
|
|
15724
|
+
* "models.meshery.io/v1beta1",
|
|
15725
|
+
* "capability.meshery.io/v1alpha1"
|
|
15726
|
+
* ]
|
|
15727
|
+
*/
|
|
15728
|
+
schemaVersion: string;
|
|
15729
|
+
};
|
|
15730
|
+
/**
|
|
15731
|
+
* Format: uuid
|
|
15732
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15733
|
+
*/
|
|
15734
|
+
registrantId: string;
|
|
15735
|
+
/**
|
|
15736
|
+
* Format: uuid
|
|
15737
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15738
|
+
*/
|
|
15739
|
+
categoryId: string;
|
|
15740
|
+
/** @description Category of the model. */
|
|
15741
|
+
category: {
|
|
15742
|
+
/**
|
|
15743
|
+
* Format: uuid
|
|
15744
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15745
|
+
*/
|
|
15746
|
+
id: string;
|
|
15747
|
+
/**
|
|
15748
|
+
* @description The category of the model that determines the main grouping.
|
|
15749
|
+
* @default Uncategorized
|
|
15750
|
+
* @enum {string}
|
|
15751
|
+
*/
|
|
15752
|
+
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";
|
|
15753
|
+
/** @description Additional metadata associated with the category. */
|
|
15754
|
+
metadata: Record<string, never>;
|
|
15755
|
+
};
|
|
15756
|
+
/**
|
|
15757
|
+
* SubCategory
|
|
15758
|
+
* @description Sub category of the model determines the secondary grouping.
|
|
15759
|
+
* @default Uncategorized
|
|
15760
|
+
* @enum {string}
|
|
15761
|
+
*/
|
|
15762
|
+
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";
|
|
15763
|
+
/** @description Metadata containing additional information associated with the model. */
|
|
15764
|
+
metadata?: {
|
|
15765
|
+
/** @description Capabilities associated with the model */
|
|
15766
|
+
capabilities?: {
|
|
15767
|
+
/**
|
|
15768
|
+
* @description Specifies the version of the schema to which the capability definition conforms.
|
|
15769
|
+
* @example [
|
|
15770
|
+
* "v1",
|
|
15771
|
+
* "v1alpha1",
|
|
15772
|
+
* "v2beta3",
|
|
15773
|
+
* "v1.custom-suffix",
|
|
15774
|
+
* "models.meshery.io/v1beta1",
|
|
15775
|
+
* "capability.meshery.io/v1alpha1"
|
|
15776
|
+
* ]
|
|
15777
|
+
*/
|
|
15778
|
+
schemaVersion: string;
|
|
15779
|
+
/** @description Version of the capability definition. */
|
|
15780
|
+
version: string;
|
|
15781
|
+
/** @description Name of the capability in human-readible format. */
|
|
15782
|
+
displayName: string;
|
|
15783
|
+
/** @description A written representation of the purpose and characteristics of the capability. */
|
|
15784
|
+
description: string;
|
|
15785
|
+
/** @description Top-level categorization of the capability */
|
|
15786
|
+
kind: string | "action" | "mutate" | "view" | "interaction";
|
|
15787
|
+
/** @description Classification of capabilities. Used to group capabilities similar in nature. */
|
|
15788
|
+
type: string;
|
|
15789
|
+
/** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
|
|
15790
|
+
subType: string;
|
|
15791
|
+
/** @description Key that backs the capability. */
|
|
15792
|
+
key: string;
|
|
15793
|
+
/** @description State of the entity in which the capability is applicable. */
|
|
15794
|
+
entityState: ("declaration" | "instance")[];
|
|
15795
|
+
/**
|
|
15796
|
+
* @description Status of the capability
|
|
15797
|
+
* @default enabled
|
|
15798
|
+
* @enum {string}
|
|
15799
|
+
*/
|
|
15800
|
+
status: "enabled" | "disabled";
|
|
15801
|
+
/** @description Metadata contains additional information associated with the capability. Extension point. */
|
|
15802
|
+
metadata?: {
|
|
15803
|
+
[key: string]: unknown;
|
|
15804
|
+
};
|
|
15805
|
+
}[];
|
|
15806
|
+
/**
|
|
15807
|
+
* @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
|
|
15808
|
+
* @default false
|
|
15809
|
+
*/
|
|
15810
|
+
isAnnotation: boolean;
|
|
15811
|
+
/**
|
|
15812
|
+
* @description Primary color associated with the model.
|
|
15813
|
+
* @default #00b39f
|
|
15814
|
+
*/
|
|
15815
|
+
primaryColor: string;
|
|
15816
|
+
/**
|
|
15817
|
+
* @description Secondary color associated with the model.
|
|
15818
|
+
* @default #00D3A9
|
|
15819
|
+
*/
|
|
15820
|
+
secondaryColor: string;
|
|
15821
|
+
/**
|
|
15822
|
+
* @description SVG representation of the model in white color.
|
|
15823
|
+
* @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>
|
|
15824
|
+
*/
|
|
15825
|
+
svgWhite: string;
|
|
15826
|
+
/**
|
|
15827
|
+
* @description SVG representation of the model in colored format.
|
|
15828
|
+
* @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>
|
|
15829
|
+
*/
|
|
15830
|
+
svgColor: string;
|
|
15831
|
+
/** @description SVG representation of the complete model. */
|
|
15832
|
+
svgComplete?: string;
|
|
15833
|
+
/**
|
|
15834
|
+
* @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)
|
|
15835
|
+
* @enum {string}
|
|
15836
|
+
*/
|
|
15837
|
+
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";
|
|
15838
|
+
} & {
|
|
15839
|
+
[key: string]: unknown;
|
|
15840
|
+
};
|
|
15841
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
15842
|
+
model: {
|
|
15843
|
+
/** @description Version of the model as defined by the registrant. */
|
|
15844
|
+
version: string;
|
|
15845
|
+
};
|
|
15846
|
+
/** @description The relationships of the model. */
|
|
15847
|
+
relationships: unknown[];
|
|
15848
|
+
/** @description The components of the model. */
|
|
15849
|
+
components: unknown[];
|
|
15850
|
+
/**
|
|
15851
|
+
* @description Number of components associated with the model.
|
|
15852
|
+
* @default 0
|
|
15853
|
+
*/
|
|
15854
|
+
componentsCount: number;
|
|
15855
|
+
/**
|
|
15856
|
+
* @description Number of relationships associated with the model.
|
|
15857
|
+
* @default 0
|
|
15858
|
+
*/
|
|
15859
|
+
relationshipsCount: number;
|
|
15860
|
+
/**
|
|
15861
|
+
* Format: date-time
|
|
15862
|
+
* @description Timestamp when the resource was created.
|
|
15863
|
+
*/
|
|
15864
|
+
created_at?: string;
|
|
15865
|
+
/**
|
|
15866
|
+
* Format: date-time
|
|
15867
|
+
* @description Timestamp when the resource was updated.
|
|
15868
|
+
*/
|
|
15869
|
+
updated_at?: string;
|
|
15870
|
+
};
|
|
15871
|
+
/** @description 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 */
|
|
15872
|
+
modelReference: {
|
|
15873
|
+
/**
|
|
15874
|
+
* Format: uuid
|
|
15875
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15876
|
+
*/
|
|
15877
|
+
id: string;
|
|
15878
|
+
/**
|
|
15879
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
15880
|
+
* @example cert-manager
|
|
15881
|
+
*/
|
|
15882
|
+
name: string;
|
|
15883
|
+
/** @description Version of the model definition. */
|
|
15884
|
+
version: string;
|
|
15885
|
+
/**
|
|
15886
|
+
* @description Human-readable name for the model.
|
|
15887
|
+
* @example Cert Manager
|
|
15888
|
+
*/
|
|
15889
|
+
displayName: string;
|
|
15890
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
15891
|
+
model: {
|
|
15892
|
+
/** @description Version of the model as defined by the registrant. */
|
|
15893
|
+
version: string;
|
|
15894
|
+
};
|
|
15895
|
+
registrant: {
|
|
15896
|
+
/** @description Kind of the registrant. */
|
|
15897
|
+
kind: string;
|
|
15898
|
+
};
|
|
15899
|
+
};
|
|
15900
|
+
/**
|
|
15901
|
+
* Format: uuid
|
|
15902
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
15903
|
+
*/
|
|
15904
|
+
modelId?: string;
|
|
15905
|
+
/** @description Visualization styles for a component */
|
|
15906
|
+
styles?: ({
|
|
15907
|
+
/** @description Primary color of the component used for UI representation. */
|
|
15908
|
+
primaryColor: string;
|
|
15909
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
15910
|
+
secondaryColor?: string;
|
|
15911
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
15912
|
+
svgWhite: string;
|
|
15913
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
15914
|
+
svgColor: string;
|
|
15915
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
15916
|
+
svgComplete: string;
|
|
15917
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
15918
|
+
color?: string;
|
|
15919
|
+
/** @description The opacity of the label text, including its outline. */
|
|
15920
|
+
"text-opacity"?: number;
|
|
15921
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
15922
|
+
"font-family"?: string;
|
|
15923
|
+
/** @description The size of the label text. */
|
|
15924
|
+
"font-size"?: string;
|
|
15925
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
15926
|
+
"font-style"?: string;
|
|
15927
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
15928
|
+
"font-weight"?: string;
|
|
15929
|
+
/**
|
|
15930
|
+
* @description A transformation to apply to the label text
|
|
15931
|
+
* @enum {string}
|
|
15932
|
+
*/
|
|
15933
|
+
"text-transform"?: "none" | "uppercase" | "lowercase";
|
|
15934
|
+
/** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
|
|
15935
|
+
opacity?: number;
|
|
15936
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
15937
|
+
"z-index"?: number;
|
|
15938
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
15939
|
+
label?: string;
|
|
15940
|
+
/** @description The animation to apply to the element. example ripple,bounce,etc */
|
|
15941
|
+
animation?: Record<string, never>;
|
|
15942
|
+
} & {
|
|
15943
|
+
[key: string]: unknown;
|
|
15944
|
+
}) & {
|
|
15945
|
+
/**
|
|
15946
|
+
* @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)
|
|
15947
|
+
* @enum {string}
|
|
15948
|
+
*/
|
|
15949
|
+
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";
|
|
15950
|
+
/** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
|
|
15951
|
+
position?: {
|
|
15952
|
+
/** @description The x-coordinate of the node. */
|
|
15953
|
+
x: number;
|
|
15954
|
+
/** @description The y-coordinate of the node. */
|
|
15955
|
+
y: number;
|
|
15956
|
+
};
|
|
15957
|
+
/** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
|
|
15958
|
+
"body-text"?: string;
|
|
15959
|
+
/** @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'. */
|
|
15960
|
+
"body-text-wrap"?: string;
|
|
15961
|
+
/** @description The maximum width for wrapping text in the node. */
|
|
15962
|
+
"body-text-max-width"?: string;
|
|
15963
|
+
/** @description The opacity of the node's body text, including its outline. */
|
|
15964
|
+
"body-text-opacity"?: number;
|
|
15965
|
+
/** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
15966
|
+
"body-text-background-color"?: string;
|
|
15967
|
+
/** @description The size of the node's body text. */
|
|
15968
|
+
"body-text-font-size"?: number;
|
|
15969
|
+
/** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
15970
|
+
"body-text-color"?: string;
|
|
15971
|
+
/** @description A CSS font weight to be applied to the node's body text. */
|
|
15972
|
+
"body-text-font-weight"?: string;
|
|
15973
|
+
/** @description A CSS horizontal alignment to be applied to the node's body text. */
|
|
15974
|
+
"body-text-horizontal-align"?: string;
|
|
15975
|
+
/** @description A CSS text decoration to be applied to the node's body text. */
|
|
15976
|
+
"body-text-decoration"?: string;
|
|
15977
|
+
/** @description A CSS vertical alignment to be applied to the node's body text. */
|
|
15978
|
+
"body-text-vertical-align"?: string;
|
|
15979
|
+
/** @description The width of the node's body or the width of an edge's line. */
|
|
15980
|
+
width?: number;
|
|
15981
|
+
/** @description The height of the node's body */
|
|
15982
|
+
height?: number;
|
|
15983
|
+
/** @description The URL that points to the image to show in the node. */
|
|
15984
|
+
"background-image"?: string;
|
|
15985
|
+
/** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
15986
|
+
"background-color"?: string;
|
|
15987
|
+
/** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
|
|
15988
|
+
"background-blacken"?: number;
|
|
15989
|
+
/** @description The opacity level of the node's background colour */
|
|
15990
|
+
"background-opacity"?: number;
|
|
15991
|
+
/** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
15992
|
+
"background-position-x"?: string;
|
|
15993
|
+
/** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
15994
|
+
"background-position-y"?: string;
|
|
15995
|
+
/** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
15996
|
+
"background-offset-x"?: string;
|
|
15997
|
+
/** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
|
|
15998
|
+
"background-offset-y"?: string;
|
|
15999
|
+
/** @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'. */
|
|
16000
|
+
"background-fit"?: string;
|
|
16001
|
+
/** @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'. */
|
|
16002
|
+
"background-clip"?: string;
|
|
16003
|
+
/** @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'. */
|
|
16004
|
+
"background-width-relative-to"?: string;
|
|
16005
|
+
/** @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'. */
|
|
16006
|
+
"background-height-relative-to"?: string;
|
|
16007
|
+
/** @description The size of the node's border. */
|
|
16008
|
+
"border-width"?: number;
|
|
16009
|
+
/**
|
|
16010
|
+
* @description The style of the node's border
|
|
16011
|
+
* @enum {string}
|
|
16012
|
+
*/
|
|
16013
|
+
"border-style"?: "solid" | "dotted" | "dashed" | "double";
|
|
16014
|
+
/** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16015
|
+
"border-color"?: string;
|
|
16016
|
+
/** @description The opacity of the node's border */
|
|
16017
|
+
"border-opacity"?: number;
|
|
16018
|
+
/** @description The amount of padding around all sides of the node. */
|
|
16019
|
+
padding?: number;
|
|
16020
|
+
/**
|
|
16021
|
+
* @description The horizontal alignment of a node's label
|
|
16022
|
+
* @enum {string}
|
|
16023
|
+
*/
|
|
16024
|
+
"text-halign"?: "left" | "center" | "right";
|
|
16025
|
+
/**
|
|
16026
|
+
* @description The vertical alignment of a node's label
|
|
16027
|
+
* @enum {string}
|
|
16028
|
+
*/
|
|
16029
|
+
"text-valign"?: "top" | "center" | "bottom";
|
|
16030
|
+
/**
|
|
16031
|
+
* @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
|
|
16032
|
+
* @default no
|
|
16033
|
+
* @enum {string}
|
|
16034
|
+
*/
|
|
16035
|
+
ghost: "yes" | "no";
|
|
16036
|
+
/** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16037
|
+
"active-bg-color"?: string;
|
|
16038
|
+
/** @description The opacity of the active background indicator. Selector needs to be *core*. */
|
|
16039
|
+
"active-bg-opacity"?: string;
|
|
16040
|
+
/** @description The opacity of the active background indicator. Selector needs to be *core*. */
|
|
16041
|
+
"active-bg-size"?: string;
|
|
16042
|
+
/** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16043
|
+
"selection-box-color"?: string;
|
|
16044
|
+
/** @description The size of the border on the selection box. Selector needs to be *core* */
|
|
16045
|
+
"selection-box-border-width"?: number;
|
|
16046
|
+
/** @description The opacity of the selection box. Selector needs to be *core* */
|
|
16047
|
+
"selection-box-opacity"?: number;
|
|
16048
|
+
/** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16049
|
+
"outside-texture-bg-color"?: string;
|
|
16050
|
+
/** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
|
|
16051
|
+
"outside-texture-bg-opacity"?: number;
|
|
16052
|
+
/** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
|
|
16053
|
+
"shape-polygon-points"?: string;
|
|
16054
|
+
/** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16055
|
+
"menu-background-color"?: string;
|
|
16056
|
+
/** @description The opacity of the background of the component menu. */
|
|
16057
|
+
"menu-background-opacity"?: number;
|
|
16058
|
+
/** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16059
|
+
"menu-forground-color"?: string;
|
|
16060
|
+
};
|
|
16061
|
+
/**
|
|
16062
|
+
* @description Meshery manages components in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. ComponentDefinitions may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
|
|
16063
|
+
* @default [
|
|
16064
|
+
* {
|
|
16065
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16066
|
+
* "version": "0.7.0",
|
|
16067
|
+
* "displayName": "Performance Test",
|
|
16068
|
+
* "description": "Initiate a performance test. Meshery will execute the load generation, collect metrics, and present the results.",
|
|
16069
|
+
* "kind": "action",
|
|
16070
|
+
* "type": "operator",
|
|
16071
|
+
* "subType": "perf-test",
|
|
16072
|
+
* "key": "",
|
|
16073
|
+
* "entityState": [
|
|
16074
|
+
* "instance"
|
|
16075
|
+
* ],
|
|
16076
|
+
* "status": "enabled",
|
|
16077
|
+
* "metadata": null
|
|
16078
|
+
* },
|
|
16079
|
+
* {
|
|
16080
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16081
|
+
* "version": "0.7.0",
|
|
16082
|
+
* "displayName": "Workload Configuration",
|
|
16083
|
+
* "description": "Configure the workload specific setting of a component",
|
|
16084
|
+
* "kind": "mutate",
|
|
16085
|
+
* "type": "configuration",
|
|
16086
|
+
* "subType": "config",
|
|
16087
|
+
* "key": "",
|
|
16088
|
+
* "entityState": [
|
|
16089
|
+
* "declaration"
|
|
16090
|
+
* ],
|
|
16091
|
+
* "status": "enabled",
|
|
16092
|
+
* "metadata": null
|
|
16093
|
+
* },
|
|
16094
|
+
* {
|
|
16095
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16096
|
+
* "version": "0.7.0",
|
|
16097
|
+
* "displayName": "Labels and Annotations Configuration",
|
|
16098
|
+
* "description": "Configure Labels And Annotations for the component ",
|
|
16099
|
+
* "kind": "mutate",
|
|
16100
|
+
* "type": "configuration",
|
|
16101
|
+
* "subType": "labels-and-annotations",
|
|
16102
|
+
* "key": "",
|
|
16103
|
+
* "entityState": [
|
|
16104
|
+
* "declaration"
|
|
16105
|
+
* ],
|
|
16106
|
+
* "status": "enabled",
|
|
16107
|
+
* "metadata": null
|
|
16108
|
+
* },
|
|
16109
|
+
* {
|
|
16110
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16111
|
+
* "version": "0.7.0",
|
|
16112
|
+
* "displayName": "Relationships",
|
|
16113
|
+
* "description": "View relationships for the component",
|
|
16114
|
+
* "kind": "view",
|
|
16115
|
+
* "type": "configuration",
|
|
16116
|
+
* "subType": "relationship",
|
|
16117
|
+
* "key": "",
|
|
16118
|
+
* "entityState": [
|
|
16119
|
+
* "declaration",
|
|
16120
|
+
* "instance"
|
|
16121
|
+
* ],
|
|
16122
|
+
* "status": "enabled",
|
|
16123
|
+
* "metadata": null
|
|
16124
|
+
* },
|
|
16125
|
+
* {
|
|
16126
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16127
|
+
* "version": "0.7.0",
|
|
16128
|
+
* "displayName": "Json Schema",
|
|
16129
|
+
* "description": "View Component Definition ",
|
|
16130
|
+
* "kind": "view",
|
|
16131
|
+
* "type": "configuration",
|
|
16132
|
+
* "subType": "definition",
|
|
16133
|
+
* "key": "",
|
|
16134
|
+
* "entityState": [
|
|
16135
|
+
* "declaration",
|
|
16136
|
+
* "instance"
|
|
16137
|
+
* ],
|
|
16138
|
+
* "status": "enabled",
|
|
16139
|
+
* "metadata": null
|
|
16140
|
+
* },
|
|
16141
|
+
* {
|
|
16142
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16143
|
+
* "version": "0.7.0",
|
|
16144
|
+
* "displayName": "Styling",
|
|
16145
|
+
* "description": "Configure the visual styles for the component",
|
|
16146
|
+
* "kind": "mutate",
|
|
16147
|
+
* "type": "style",
|
|
16148
|
+
* "subType": "",
|
|
16149
|
+
* "key": "",
|
|
16150
|
+
* "entityState": [
|
|
16151
|
+
* "declaration"
|
|
16152
|
+
* ],
|
|
16153
|
+
* "status": "enabled",
|
|
16154
|
+
* "metadata": null
|
|
16155
|
+
* },
|
|
16156
|
+
* {
|
|
16157
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16158
|
+
* "version": "0.7.0",
|
|
16159
|
+
* "displayName": "Change Shape",
|
|
16160
|
+
* "description": "Change the shape of the component",
|
|
16161
|
+
* "kind": "mutate",
|
|
16162
|
+
* "type": "style",
|
|
16163
|
+
* "subType": "shape",
|
|
16164
|
+
* "key": "",
|
|
16165
|
+
* "entityState": [
|
|
16166
|
+
* "declaration"
|
|
16167
|
+
* ],
|
|
16168
|
+
* "status": "enabled",
|
|
16169
|
+
* "metadata": null
|
|
16170
|
+
* },
|
|
16171
|
+
* {
|
|
16172
|
+
* "schemaVersion": "capability.meshery.io/v1beta1",
|
|
16173
|
+
* "version": "0.7.0",
|
|
16174
|
+
* "displayName": "Compound Drag And Drop",
|
|
16175
|
+
* "description": "Drag and Drop a component into a parent component in graph view",
|
|
16176
|
+
* "kind": "interaction",
|
|
16177
|
+
* "type": "graph",
|
|
16178
|
+
* "subType": "compoundDnd",
|
|
16179
|
+
* "key": "",
|
|
16180
|
+
* "entityState": [
|
|
16181
|
+
* "declaration"
|
|
16182
|
+
* ],
|
|
16183
|
+
* "status": "enabled",
|
|
16184
|
+
* "metadata": null
|
|
16185
|
+
* }
|
|
16186
|
+
* ]
|
|
16187
|
+
*/
|
|
16188
|
+
capabilities: {
|
|
16189
|
+
/**
|
|
16190
|
+
* @description Specifies the version of the schema to which the capability definition conforms.
|
|
16191
|
+
* @example [
|
|
16192
|
+
* "v1",
|
|
16193
|
+
* "v1alpha1",
|
|
16194
|
+
* "v2beta3",
|
|
16195
|
+
* "v1.custom-suffix",
|
|
16196
|
+
* "models.meshery.io/v1beta1",
|
|
16197
|
+
* "capability.meshery.io/v1alpha1"
|
|
16198
|
+
* ]
|
|
16199
|
+
*/
|
|
16200
|
+
schemaVersion: string;
|
|
16201
|
+
/** @description Version of the capability definition. */
|
|
16202
|
+
version: string;
|
|
16203
|
+
/** @description Name of the capability in human-readible format. */
|
|
16204
|
+
displayName: string;
|
|
16205
|
+
/** @description A written representation of the purpose and characteristics of the capability. */
|
|
16206
|
+
description: string;
|
|
16207
|
+
/** @description Top-level categorization of the capability */
|
|
16208
|
+
kind: string | "action" | "mutate" | "view" | "interaction";
|
|
16209
|
+
/** @description Classification of capabilities. Used to group capabilities similar in nature. */
|
|
16210
|
+
type: string;
|
|
16211
|
+
/** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
|
|
16212
|
+
subType: string;
|
|
16213
|
+
/** @description Key that backs the capability. */
|
|
16214
|
+
key: string;
|
|
16215
|
+
/** @description State of the entity in which the capability is applicable. */
|
|
16216
|
+
entityState: ("declaration" | "instance")[];
|
|
16217
|
+
/**
|
|
16218
|
+
* @description Status of the capability
|
|
16219
|
+
* @default enabled
|
|
16220
|
+
* @enum {string}
|
|
16221
|
+
*/
|
|
16222
|
+
status: "enabled" | "disabled";
|
|
16223
|
+
/** @description Metadata contains additional information associated with the capability. Extension point. */
|
|
16224
|
+
metadata?: {
|
|
16225
|
+
[key: string]: unknown;
|
|
16226
|
+
};
|
|
16227
|
+
}[];
|
|
16228
|
+
/**
|
|
16229
|
+
* @description Status of component, including:
|
|
16230
|
+
* - 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.
|
|
16231
|
+
* - maintenance: model is unavailable for a period of time.
|
|
16232
|
+
* - enabled: model is available for use for all users of this Meshery Server.
|
|
16233
|
+
* - ignored: model is unavailable for use for all users of this Meshery Server.
|
|
16234
|
+
* @default enabled
|
|
16235
|
+
* @enum {string}
|
|
16236
|
+
*/
|
|
16237
|
+
status: "ignored" | "enabled" | "duplicate" | "resolved" | "open";
|
|
16238
|
+
/** @description Metadata contains additional information associated with the component. */
|
|
16239
|
+
metadata: {
|
|
16240
|
+
/** @description Genealogy represents the various representational states of the component. */
|
|
16241
|
+
genealogy: string;
|
|
16242
|
+
/**
|
|
16243
|
+
* @description Identifies whether the component is semantically meaningful or not; identifies whether the component should be treated as deployable entity or is for purposes of logical representation.
|
|
16244
|
+
* @default false
|
|
16245
|
+
*/
|
|
16246
|
+
isAnnotation: boolean;
|
|
16247
|
+
/** @description Identifies whether the component is scoped to namespace or clsuter wide. */
|
|
16248
|
+
isNamespaced: boolean;
|
|
16249
|
+
/** @description 'published' controls whether the component should be registered in Meshery Registry. When the same 'published' property in Models, is set to 'false', the Model property takes precedence with all Entities in the Model not being registered. */
|
|
16250
|
+
published: boolean;
|
|
16251
|
+
/** @description InstanceDetails contains information about the instance of the component. */
|
|
16252
|
+
instanceDetails: Record<string, never>;
|
|
16253
|
+
/** @description Defines the UI schema for rendering the component's configuration. For more details, visit: https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/ . */
|
|
16254
|
+
configurationUISchema: string;
|
|
16255
|
+
} & {
|
|
16256
|
+
[key: string]: unknown;
|
|
16257
|
+
};
|
|
16258
|
+
/** @description The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema). */
|
|
16259
|
+
configuration: Record<string, never>;
|
|
16260
|
+
/** @description data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an */
|
|
16261
|
+
component: {
|
|
16262
|
+
/** @description Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod. */
|
|
16263
|
+
version: string;
|
|
16264
|
+
/** @description The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'. */
|
|
16265
|
+
kind: string;
|
|
16266
|
+
/** @description JSON schema of the object as defined by the registrant. */
|
|
16267
|
+
schema: string;
|
|
16268
|
+
};
|
|
16269
|
+
/**
|
|
16270
|
+
* Format: date-time
|
|
16271
|
+
* @description Timestamp when the resource was created.
|
|
16272
|
+
*/
|
|
16273
|
+
created_at?: string;
|
|
16274
|
+
/**
|
|
16275
|
+
* Format: date-time
|
|
16276
|
+
* @description Timestamp when the resource was updated.
|
|
16277
|
+
*/
|
|
16278
|
+
updated_at?: string;
|
|
16279
|
+
}[];
|
|
16280
|
+
/** @description Design-level preferences */
|
|
16281
|
+
preferences?: {
|
|
16282
|
+
/** @description Map of available layers, where keys are layer names. */
|
|
16283
|
+
layers: Record<string, never>;
|
|
16284
|
+
};
|
|
16285
|
+
/** @description List of relationships between components */
|
|
16286
|
+
relationships: {
|
|
16287
|
+
/**
|
|
16288
|
+
* Format: uuid
|
|
16289
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16290
|
+
*/
|
|
16291
|
+
id: string;
|
|
16292
|
+
/**
|
|
16293
|
+
* @description Specifies the version of the schema used for the relationship definition.
|
|
16294
|
+
* @example [
|
|
16295
|
+
* "v1",
|
|
16296
|
+
* "v1alpha1",
|
|
16297
|
+
* "v2beta3",
|
|
16298
|
+
* "v1.custom-suffix",
|
|
16299
|
+
* "models.meshery.io/v1beta1",
|
|
16300
|
+
* "capability.meshery.io/v1alpha1"
|
|
16301
|
+
* ]
|
|
16302
|
+
*/
|
|
16303
|
+
schemaVersion: string;
|
|
16304
|
+
/** @description Specifies the version of the relationship definition. */
|
|
16305
|
+
version: string;
|
|
16306
|
+
/**
|
|
16307
|
+
* @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
|
|
16308
|
+
* @enum {string}
|
|
16309
|
+
*/
|
|
16310
|
+
kind: "hierarchical" | "edge" | "sibling";
|
|
16311
|
+
/** @description Classification of relationships. Used to group relationships similar in nature. */
|
|
16312
|
+
type: string;
|
|
16313
|
+
/** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
|
|
16314
|
+
subType: string;
|
|
16315
|
+
/**
|
|
16316
|
+
* @description Status of the relationship.
|
|
16317
|
+
* @enum {string}
|
|
16318
|
+
*/
|
|
16319
|
+
status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
|
|
16320
|
+
/** @description Capabilities associated with the relationship. */
|
|
16321
|
+
capabilities?: {
|
|
16322
|
+
/**
|
|
16323
|
+
* @description Specifies the version of the schema to which the capability definition conforms.
|
|
16324
|
+
* @example [
|
|
16325
|
+
* "v1",
|
|
16326
|
+
* "v1alpha1",
|
|
16327
|
+
* "v2beta3",
|
|
16328
|
+
* "v1.custom-suffix",
|
|
16329
|
+
* "models.meshery.io/v1beta1",
|
|
16330
|
+
* "capability.meshery.io/v1alpha1"
|
|
16331
|
+
* ]
|
|
16332
|
+
*/
|
|
16333
|
+
schemaVersion: string;
|
|
16334
|
+
/** @description Version of the capability definition. */
|
|
16335
|
+
version: string;
|
|
16336
|
+
/** @description Name of the capability in human-readible format. */
|
|
16337
|
+
displayName: string;
|
|
16338
|
+
/** @description A written representation of the purpose and characteristics of the capability. */
|
|
16339
|
+
description: string;
|
|
16340
|
+
/** @description Top-level categorization of the capability */
|
|
16341
|
+
kind: string | "action" | "mutate" | "view" | "interaction";
|
|
16342
|
+
/** @description Classification of capabilities. Used to group capabilities similar in nature. */
|
|
16343
|
+
type: string;
|
|
16344
|
+
/** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
|
|
16345
|
+
subType: string;
|
|
16346
|
+
/** @description Key that backs the capability. */
|
|
16347
|
+
key: string;
|
|
16348
|
+
/** @description State of the entity in which the capability is applicable. */
|
|
16349
|
+
entityState: ("declaration" | "instance")[];
|
|
16350
|
+
/**
|
|
16351
|
+
* @description Status of the capability
|
|
16352
|
+
* @default enabled
|
|
16353
|
+
* @enum {string}
|
|
16354
|
+
*/
|
|
16355
|
+
status: "enabled" | "disabled";
|
|
16356
|
+
/** @description Metadata contains additional information associated with the capability. Extension point. */
|
|
16357
|
+
metadata?: {
|
|
16358
|
+
[key: string]: unknown;
|
|
16359
|
+
};
|
|
16360
|
+
}[];
|
|
16361
|
+
/** @description Metadata contains additional information associated with the Relationship. */
|
|
16362
|
+
metadata?: {
|
|
16363
|
+
/** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
|
|
16364
|
+
description?: string;
|
|
16365
|
+
/** @description Visualization styles for a relationship */
|
|
16366
|
+
styles?: {
|
|
16367
|
+
/** @description Primary color of the component used for UI representation. */
|
|
16368
|
+
primaryColor: string;
|
|
16369
|
+
/** @description Secondary color of the entity used for UI representation. */
|
|
16370
|
+
secondaryColor?: string;
|
|
16371
|
+
/** @description White SVG of the entity used for UI representation on dark background. */
|
|
16372
|
+
svgWhite: string;
|
|
16373
|
+
/** @description Colored SVG of the entity used for UI representation on light background. */
|
|
16374
|
+
svgColor: string;
|
|
16375
|
+
/** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
|
|
16376
|
+
svgComplete?: string;
|
|
16377
|
+
/** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16378
|
+
color?: string;
|
|
16379
|
+
/**
|
|
16380
|
+
* Format: float
|
|
16381
|
+
* @description The opacity of the label text, including its outline.
|
|
16382
|
+
*/
|
|
16383
|
+
"text-opacity"?: number;
|
|
16384
|
+
/** @description A comma-separated list of font names to use on the label text. */
|
|
16385
|
+
"font-family"?: string;
|
|
16386
|
+
/** @description The size of the label text. */
|
|
16387
|
+
"font-size"?: string;
|
|
16388
|
+
/** @description A CSS font style to be applied to the label text. */
|
|
16389
|
+
"font-style"?: string;
|
|
16390
|
+
/** @description A CSS font weight to be applied to the label text. */
|
|
16391
|
+
"font-weight"?: string;
|
|
16392
|
+
/**
|
|
16393
|
+
* @description A transformation to apply to the label text
|
|
16394
|
+
* @enum {string}
|
|
16395
|
+
*/
|
|
16396
|
+
"text-transform"?: "none" | "uppercase" | "lowercase";
|
|
16397
|
+
/**
|
|
16398
|
+
* Format: float
|
|
16399
|
+
* @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.See https://js.cytoscape.org/#style/visibility
|
|
16400
|
+
*/
|
|
16401
|
+
opacity?: number;
|
|
16402
|
+
/** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
|
|
16403
|
+
"z-index"?: number;
|
|
16404
|
+
/** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
|
|
16405
|
+
label?: string;
|
|
16406
|
+
/** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
|
|
16407
|
+
"edge-animation"?: string;
|
|
16408
|
+
/**
|
|
16409
|
+
* @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
|
|
16410
|
+
* @enum {string}
|
|
16411
|
+
*/
|
|
16412
|
+
"curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
|
|
16413
|
+
/** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16414
|
+
"line-color"?: string;
|
|
16415
|
+
/**
|
|
16416
|
+
* @description The style of the edge's line.
|
|
16417
|
+
* @enum {string}
|
|
16418
|
+
*/
|
|
16419
|
+
"line-style"?: "solid" | "dotted" | "dashed";
|
|
16420
|
+
/**
|
|
16421
|
+
* @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
|
|
16422
|
+
* @enum {string}
|
|
16423
|
+
*/
|
|
16424
|
+
"line-cap"?: "butt" | "round" | "square";
|
|
16425
|
+
/**
|
|
16426
|
+
* Format: float
|
|
16427
|
+
* @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
|
|
16428
|
+
*/
|
|
16429
|
+
"line-opacity"?: number;
|
|
16430
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16431
|
+
"target-arrow-color"?: string;
|
|
16432
|
+
/**
|
|
16433
|
+
* @description The shape of the edge's source arrow
|
|
16434
|
+
* @enum {string}
|
|
16435
|
+
*/
|
|
16436
|
+
"target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
|
|
16437
|
+
/**
|
|
16438
|
+
* @description The fill state of the edge's source arrow
|
|
16439
|
+
* @enum {string}
|
|
16440
|
+
*/
|
|
16441
|
+
"target-arrow-fill"?: "filled" | "hollow";
|
|
16442
|
+
/** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
|
|
16443
|
+
"mid-target-arrow-color"?: string;
|
|
16444
|
+
/**
|
|
16445
|
+
* @description The shape of the edge's source arrow
|
|
16446
|
+
* @enum {string}
|
|
16447
|
+
*/
|
|
16448
|
+
"mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
|
|
16449
|
+
/**
|
|
16450
|
+
* @description The fill state of the edge's source arrow
|
|
16451
|
+
* @enum {string}
|
|
16452
|
+
*/
|
|
16453
|
+
"mid-target-arrow-fill"?: "filled" | "hollow";
|
|
16454
|
+
/**
|
|
16455
|
+
* Format: float
|
|
16456
|
+
* @description Scaling for the arrow size.
|
|
16457
|
+
*/
|
|
16458
|
+
"arrow-scale"?: number;
|
|
16459
|
+
/** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
|
|
16460
|
+
"source-label"?: string;
|
|
16461
|
+
/** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
|
|
16462
|
+
"target-label"?: string;
|
|
16463
|
+
};
|
|
16464
|
+
/** @description Indicates whether the relationship should be treated as a logical representation only */
|
|
16465
|
+
isAnnotation?: boolean;
|
|
16466
|
+
} & {
|
|
16467
|
+
[key: string]: unknown;
|
|
16468
|
+
};
|
|
16469
|
+
/** @description Model 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 */
|
|
16470
|
+
model: {
|
|
16471
|
+
/**
|
|
16472
|
+
* Format: uuid
|
|
16473
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16474
|
+
*/
|
|
16475
|
+
id: string;
|
|
16476
|
+
/**
|
|
16477
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
16478
|
+
* @example cert-manager
|
|
16479
|
+
*/
|
|
16480
|
+
name: string;
|
|
16481
|
+
/** @description Version of the model definition. */
|
|
16482
|
+
version: string;
|
|
16483
|
+
/**
|
|
16484
|
+
* @description Human-readable name for the model.
|
|
16485
|
+
* @example Cert Manager
|
|
16486
|
+
*/
|
|
16487
|
+
displayName: string;
|
|
16488
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
16489
|
+
model: {
|
|
16490
|
+
/** @description Version of the model as defined by the registrant. */
|
|
16491
|
+
version: string;
|
|
16492
|
+
};
|
|
16493
|
+
registrant: {
|
|
16494
|
+
/** @description Kind of the registrant. */
|
|
16495
|
+
kind: string;
|
|
16496
|
+
};
|
|
16497
|
+
};
|
|
16498
|
+
/**
|
|
16499
|
+
* Format: uuid
|
|
16500
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16501
|
+
*/
|
|
16502
|
+
modelId?: string;
|
|
16503
|
+
/** @description Optional. Assigns the policy to be used for the evaluation of the relationship. Deprecation Notice: In the future, this property is either to be removed or to it is to be an array of optional policy $refs. */
|
|
16504
|
+
evaluationQuery?: string;
|
|
16505
|
+
/** @description Selectors are organized as an array, with each item containing a distinct set of selectors that share a common functionality. This structure allows for flexibility in defining relationships, even when different components are involved. */
|
|
16506
|
+
selectors?: {
|
|
16507
|
+
/** @description Selectors used to define relationships which are allowed. */
|
|
16508
|
+
allow: {
|
|
16509
|
+
/** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
|
|
16510
|
+
from: {
|
|
16511
|
+
/**
|
|
16512
|
+
* Format: uuid
|
|
16513
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16514
|
+
*/
|
|
16515
|
+
id?: string;
|
|
16516
|
+
kind?: string;
|
|
16517
|
+
/** @description Match configuration for selector */
|
|
16518
|
+
match?: {
|
|
16519
|
+
refs?: string[][];
|
|
16520
|
+
from?: {
|
|
16521
|
+
/**
|
|
16522
|
+
* Format: uuid
|
|
16523
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16524
|
+
*/
|
|
16525
|
+
id?: string;
|
|
16526
|
+
kind: string;
|
|
16527
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16528
|
+
mutatorRef?: string[][];
|
|
16529
|
+
mutatedRef?: string[][];
|
|
16530
|
+
}[];
|
|
16531
|
+
to?: {
|
|
16532
|
+
/**
|
|
16533
|
+
* Format: uuid
|
|
16534
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16535
|
+
*/
|
|
16536
|
+
id?: string;
|
|
16537
|
+
kind: string;
|
|
16538
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16539
|
+
mutatorRef?: string[][];
|
|
16540
|
+
mutatedRef?: string[][];
|
|
16541
|
+
}[];
|
|
16542
|
+
};
|
|
16543
|
+
/** @description Match strategy matrix for the selector */
|
|
16544
|
+
match_strategy_matrix?: string[][];
|
|
16545
|
+
/** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
|
|
16546
|
+
model?: {
|
|
16547
|
+
/**
|
|
16548
|
+
* Format: uuid
|
|
16549
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16550
|
+
*/
|
|
16551
|
+
id: string;
|
|
16552
|
+
/**
|
|
16553
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
16554
|
+
* @example cert-manager
|
|
16555
|
+
*/
|
|
16556
|
+
name: string;
|
|
16557
|
+
/** @description Version of the model definition. */
|
|
16558
|
+
version: string;
|
|
16559
|
+
/**
|
|
16560
|
+
* @description Human-readable name for the model.
|
|
16561
|
+
* @example Cert Manager
|
|
16562
|
+
*/
|
|
16563
|
+
displayName: string;
|
|
16564
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
16565
|
+
model: {
|
|
16566
|
+
/** @description Version of the model as defined by the registrant. */
|
|
16567
|
+
version: string;
|
|
16568
|
+
};
|
|
16569
|
+
registrant: {
|
|
16570
|
+
/** @description Kind of the registrant. */
|
|
16571
|
+
kind: string;
|
|
16572
|
+
};
|
|
16573
|
+
};
|
|
16574
|
+
/** @description Patch configuration for the selector */
|
|
16575
|
+
patch?: {
|
|
16576
|
+
/**
|
|
16577
|
+
* @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
16578
|
+
*
|
|
16579
|
+
* add: Inserts a value into an array or adds a member to an object.
|
|
16580
|
+
* replace: Replaces a value.
|
|
16581
|
+
* merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
16582
|
+
* strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
16583
|
+
* remove: Removes a value.
|
|
16584
|
+
* copy: Copies a value from one location to another.
|
|
16585
|
+
* move: Moves a value from one location to another.
|
|
16586
|
+
* test: Tests that a value at the target location is equal to a specified value.
|
|
16587
|
+
* @enum {string}
|
|
16588
|
+
*/
|
|
16589
|
+
patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
|
|
16590
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16591
|
+
mutatorRef?: string[][];
|
|
16592
|
+
mutatedRef?: string[][];
|
|
16593
|
+
};
|
|
16594
|
+
}[];
|
|
16595
|
+
/** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
|
|
16596
|
+
to: {
|
|
16597
|
+
/**
|
|
16598
|
+
* Format: uuid
|
|
16599
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16600
|
+
*/
|
|
16601
|
+
id?: string;
|
|
16602
|
+
kind?: string;
|
|
16603
|
+
/** @description Match configuration for selector */
|
|
16604
|
+
match?: {
|
|
16605
|
+
refs?: string[][];
|
|
16606
|
+
from?: {
|
|
16607
|
+
/**
|
|
16608
|
+
* Format: uuid
|
|
16609
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16610
|
+
*/
|
|
16611
|
+
id?: string;
|
|
16612
|
+
kind: string;
|
|
16613
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16614
|
+
mutatorRef?: string[][];
|
|
16615
|
+
mutatedRef?: string[][];
|
|
16616
|
+
}[];
|
|
16617
|
+
to?: {
|
|
16618
|
+
/**
|
|
16619
|
+
* Format: uuid
|
|
16620
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16621
|
+
*/
|
|
16622
|
+
id?: string;
|
|
16623
|
+
kind: string;
|
|
16624
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16625
|
+
mutatorRef?: string[][];
|
|
16626
|
+
mutatedRef?: string[][];
|
|
16627
|
+
}[];
|
|
16628
|
+
};
|
|
16629
|
+
/** @description Match strategy matrix for the selector */
|
|
16630
|
+
match_strategy_matrix?: string[][];
|
|
16631
|
+
/** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
|
|
16632
|
+
model?: {
|
|
16633
|
+
/**
|
|
16634
|
+
* Format: uuid
|
|
16635
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16636
|
+
*/
|
|
16637
|
+
id: string;
|
|
16638
|
+
/**
|
|
16639
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
16640
|
+
* @example cert-manager
|
|
16641
|
+
*/
|
|
16642
|
+
name: string;
|
|
16643
|
+
/** @description Version of the model definition. */
|
|
16644
|
+
version: string;
|
|
16645
|
+
/**
|
|
16646
|
+
* @description Human-readable name for the model.
|
|
16647
|
+
* @example Cert Manager
|
|
16648
|
+
*/
|
|
16649
|
+
displayName: string;
|
|
16650
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
16651
|
+
model: {
|
|
16652
|
+
/** @description Version of the model as defined by the registrant. */
|
|
16653
|
+
version: string;
|
|
16654
|
+
};
|
|
16655
|
+
registrant: {
|
|
16656
|
+
/** @description Kind of the registrant. */
|
|
16657
|
+
kind: string;
|
|
16658
|
+
};
|
|
16659
|
+
};
|
|
16660
|
+
/** @description Patch configuration for the selector */
|
|
16661
|
+
patch?: {
|
|
16662
|
+
/**
|
|
16663
|
+
* @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
16664
|
+
*
|
|
16665
|
+
* add: Inserts a value into an array or adds a member to an object.
|
|
16666
|
+
* replace: Replaces a value.
|
|
16667
|
+
* merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
16668
|
+
* strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
16669
|
+
* remove: Removes a value.
|
|
16670
|
+
* copy: Copies a value from one location to another.
|
|
16671
|
+
* move: Moves a value from one location to another.
|
|
16672
|
+
* test: Tests that a value at the target location is equal to a specified value.
|
|
16673
|
+
* @enum {string}
|
|
16674
|
+
*/
|
|
16675
|
+
patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
|
|
16676
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16677
|
+
mutatorRef?: string[][];
|
|
16678
|
+
mutatedRef?: string[][];
|
|
16679
|
+
};
|
|
16680
|
+
}[];
|
|
16681
|
+
};
|
|
16682
|
+
/** @description Optional selectors used to define relationships which should not be created / is restricted. */
|
|
16683
|
+
deny?: {
|
|
16684
|
+
/** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
|
|
16685
|
+
from: {
|
|
16686
|
+
/**
|
|
16687
|
+
* Format: uuid
|
|
16688
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16689
|
+
*/
|
|
16690
|
+
id?: string;
|
|
16691
|
+
kind?: string;
|
|
16692
|
+
/** @description Match configuration for selector */
|
|
16693
|
+
match?: {
|
|
16694
|
+
refs?: string[][];
|
|
16695
|
+
from?: {
|
|
16696
|
+
/**
|
|
16697
|
+
* Format: uuid
|
|
16698
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16699
|
+
*/
|
|
16700
|
+
id?: string;
|
|
16701
|
+
kind: string;
|
|
16702
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16703
|
+
mutatorRef?: string[][];
|
|
16704
|
+
mutatedRef?: string[][];
|
|
16705
|
+
}[];
|
|
16706
|
+
to?: {
|
|
16707
|
+
/**
|
|
16708
|
+
* Format: uuid
|
|
16709
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16710
|
+
*/
|
|
16711
|
+
id?: string;
|
|
16712
|
+
kind: string;
|
|
16713
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16714
|
+
mutatorRef?: string[][];
|
|
16715
|
+
mutatedRef?: string[][];
|
|
16716
|
+
}[];
|
|
16717
|
+
};
|
|
16718
|
+
/** @description Match strategy matrix for the selector */
|
|
16719
|
+
match_strategy_matrix?: string[][];
|
|
16720
|
+
/** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
|
|
16721
|
+
model?: {
|
|
16722
|
+
/**
|
|
16723
|
+
* Format: uuid
|
|
16724
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16725
|
+
*/
|
|
16726
|
+
id: string;
|
|
16727
|
+
/**
|
|
16728
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
16729
|
+
* @example cert-manager
|
|
16730
|
+
*/
|
|
16731
|
+
name: string;
|
|
16732
|
+
/** @description Version of the model definition. */
|
|
16733
|
+
version: string;
|
|
16734
|
+
/**
|
|
16735
|
+
* @description Human-readable name for the model.
|
|
16736
|
+
* @example Cert Manager
|
|
16737
|
+
*/
|
|
16738
|
+
displayName: string;
|
|
16739
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
16740
|
+
model: {
|
|
16741
|
+
/** @description Version of the model as defined by the registrant. */
|
|
16742
|
+
version: string;
|
|
16743
|
+
};
|
|
16744
|
+
registrant: {
|
|
16745
|
+
/** @description Kind of the registrant. */
|
|
16746
|
+
kind: string;
|
|
16747
|
+
};
|
|
16748
|
+
};
|
|
16749
|
+
/** @description Patch configuration for the selector */
|
|
16750
|
+
patch?: {
|
|
16751
|
+
/**
|
|
16752
|
+
* @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
16753
|
+
*
|
|
16754
|
+
* add: Inserts a value into an array or adds a member to an object.
|
|
16755
|
+
* replace: Replaces a value.
|
|
16756
|
+
* merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
16757
|
+
* strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
16758
|
+
* remove: Removes a value.
|
|
16759
|
+
* copy: Copies a value from one location to another.
|
|
16760
|
+
* move: Moves a value from one location to another.
|
|
16761
|
+
* test: Tests that a value at the target location is equal to a specified value.
|
|
16762
|
+
* @enum {string}
|
|
16763
|
+
*/
|
|
16764
|
+
patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
|
|
16765
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16766
|
+
mutatorRef?: string[][];
|
|
16767
|
+
mutatedRef?: string[][];
|
|
16768
|
+
};
|
|
16769
|
+
}[];
|
|
16770
|
+
/** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
|
|
16771
|
+
to: {
|
|
16772
|
+
/**
|
|
16773
|
+
* Format: uuid
|
|
16774
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16775
|
+
*/
|
|
16776
|
+
id?: string;
|
|
16777
|
+
kind?: string;
|
|
16778
|
+
/** @description Match configuration for selector */
|
|
16779
|
+
match?: {
|
|
16780
|
+
refs?: string[][];
|
|
16781
|
+
from?: {
|
|
16782
|
+
/**
|
|
16783
|
+
* Format: uuid
|
|
16784
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16785
|
+
*/
|
|
16786
|
+
id?: string;
|
|
16787
|
+
kind: string;
|
|
16788
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16789
|
+
mutatorRef?: string[][];
|
|
16790
|
+
mutatedRef?: string[][];
|
|
16791
|
+
}[];
|
|
16792
|
+
to?: {
|
|
16793
|
+
/**
|
|
16794
|
+
* Format: uuid
|
|
16795
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16796
|
+
*/
|
|
16797
|
+
id?: string;
|
|
16798
|
+
kind: string;
|
|
16799
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16800
|
+
mutatorRef?: string[][];
|
|
16801
|
+
mutatedRef?: string[][];
|
|
16802
|
+
}[];
|
|
16803
|
+
};
|
|
16804
|
+
/** @description Match strategy matrix for the selector */
|
|
16805
|
+
match_strategy_matrix?: string[][];
|
|
16806
|
+
/** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
|
|
16807
|
+
model?: {
|
|
16808
|
+
/**
|
|
16809
|
+
* Format: uuid
|
|
16810
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
16811
|
+
*/
|
|
16812
|
+
id: string;
|
|
16813
|
+
/**
|
|
16814
|
+
* @description The unique name for the model within the scope of a registrant.
|
|
16815
|
+
* @example cert-manager
|
|
16816
|
+
*/
|
|
16817
|
+
name: string;
|
|
16818
|
+
/** @description Version of the model definition. */
|
|
16819
|
+
version: string;
|
|
16820
|
+
/**
|
|
16821
|
+
* @description Human-readable name for the model.
|
|
16822
|
+
* @example Cert Manager
|
|
16823
|
+
*/
|
|
16824
|
+
displayName: string;
|
|
16825
|
+
/** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
|
|
16826
|
+
model: {
|
|
16827
|
+
/** @description Version of the model as defined by the registrant. */
|
|
16828
|
+
version: string;
|
|
16829
|
+
};
|
|
16830
|
+
registrant: {
|
|
16831
|
+
/** @description Kind of the registrant. */
|
|
16832
|
+
kind: string;
|
|
16833
|
+
};
|
|
16834
|
+
};
|
|
16835
|
+
/** @description Patch configuration for the selector */
|
|
16836
|
+
patch?: {
|
|
16837
|
+
/**
|
|
16838
|
+
* @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
16839
|
+
*
|
|
16840
|
+
* add: Inserts a value into an array or adds a member to an object.
|
|
16841
|
+
* replace: Replaces a value.
|
|
16842
|
+
* merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
16843
|
+
* strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
16844
|
+
* remove: Removes a value.
|
|
16845
|
+
* copy: Copies a value from one location to another.
|
|
16846
|
+
* move: Moves a value from one location to another.
|
|
16847
|
+
* test: Tests that a value at the target location is equal to a specified value.
|
|
16848
|
+
* @enum {string}
|
|
16849
|
+
*/
|
|
16850
|
+
patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
|
|
16851
|
+
/** @description JSON ref to value from where patch should be applied. */
|
|
16852
|
+
mutatorRef?: string[][];
|
|
16853
|
+
mutatedRef?: string[][];
|
|
16854
|
+
};
|
|
16855
|
+
}[];
|
|
16856
|
+
};
|
|
16857
|
+
}[];
|
|
16858
|
+
}[];
|
|
16859
|
+
};
|
|
16860
|
+
/** Format: date-time */
|
|
16861
|
+
updated_at?: string;
|
|
16862
|
+
/** Format: uuid */
|
|
16863
|
+
id?: string;
|
|
16864
|
+
visibility?: string;
|
|
16865
|
+
}[];
|
|
15445
16866
|
};
|
|
15446
16867
|
};
|
|
15447
16868
|
/** @description Invalid request format */
|