@meshery/schemas 0.8.124 → 0.8.126
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/constructs/v1alpha3/relationship/Relationship.d.mts +1470 -280
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1470 -280
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.mts +6193 -1148
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +6193 -1148
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +133 -17
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +133 -17
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +916 -1088
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +916 -1088
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +5459 -4527
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +5459 -4527
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +52 -68
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +52 -68
- package/dist/constructs/v1beta1/pattern/Pattern.d.mts +958 -1130
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +958 -1130
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +5744 -4812
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +5744 -4812
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +52 -68
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +52 -68
- package/dist/index.js +186 -86
- package/dist/index.mjs +186 -86
- package/dist/mesheryApi.d.mts +342 -412
- package/dist/mesheryApi.d.ts +342 -412
- package/package.json +1 -1
|
@@ -6,51 +6,47 @@
|
|
|
6
6
|
- 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.
|
|
7
7
|
- maintenance: model is unavailable for a period of time.
|
|
8
8
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
9
|
-
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},$id:"https://schemas.meshery.io/relationship.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",required:["schemaVersion","version","model","kind","type","subType"],additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"relationships.meshery.io/v1alpha3"},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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",type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",enum:["hierarchical","edge","sibling"],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.","x-go-name":"RelationshipType",gorm:"column:type",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",default:"enabled",enum:["pending","approved","ignored","enabled","deleted"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},evaluationQuery:{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.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.",items:{$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["schemaVersion","version","displayName","kind","type","entityState","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"}},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"}},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"key",json:"key"}},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed.","x-oapi-codegen-extra-tags":{yaml:"entityState",json:"entityState"}}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata"}}}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},metadata:{type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,"x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id"},properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"},default:false},styles:{anyOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}}},{properties:{"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc ."},"curve-style":{type:"string",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.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge\u2019s line. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"line-style":{type:"string",description:"The style of the edge\u2019s line.",enum:["solid","dotted","dashed"]},"line-cap":{type:"string",description:"The cap style of the edge\u2019s 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.",enum:["butt","round","square"],default:"butt"},"line-opacity":{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge\u2019s 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."},"target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"mid-target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",description:"Scaling for the arrow size.",minimum:0},"source-label":{type:"string",description:"The text to display for an edge\u2019s source label. Can give a path, e.g. data(id) will label with the elements id"},"target-label":{type:"string",description:"The text to display for an edge\u2019s target label. Can give a path, e.g. data(id) will label with the elements id"}}}]},{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}},$comment:"Extension point for additional styles"}],"x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"}}}},selectors:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},type:"array",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.",$comment:"Sets of selectors are interpreted as a logical UNION. Properties within a selector `allow` and `deny` are interpreted as logical AND, while 'from' and 'to' represents a UNION of set of combinatorial pairs.",items:{type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",additionalProperties:false,required:["allow"],properties:{deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
9
|
+
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",type:"object",required:["schemaVersion","version","model","kind","type","subType","id"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.","x-order":8,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-order":13,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",type:"string",enum:["hierarchical","edge","sibling"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.",type:"string","x-go-name":"RelationshipType","x-go-type-skip-optional-pointer":true,"x-order":12,"x-oapi-codegen-extra-tags":{yaml:"type",json:"type",gorm:"column:type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string","x-go-type-skip-optional-pointer":true,"x-order":10,"x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",enum:["enabled","ignored","deleted","approved","pending"],"x-order":11,"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.","x-order":2,items:{"x-go-type":"capability.Capability","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/capability"},$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["description","schemaVersion","version","displayName","kind","type","subType","entityState","key","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability."},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"]},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true}},default:[{description:"Configure the visual styles for the component",displayName:"Styling",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"",type:"style",version:"0.7.0"},{description:"Change the shape of the component",displayName:"Change Shape",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"shape",type:"style",version:"0.7.0"},{description:"Drag and Drop a component into a parent component in graph view",displayName:"Compound Drag And Drop",entityState:["declaration"],key:"",kind:"interaction",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"compoundDnd",type:"graph",version:"0.7.0"},{description:"Add text to nodes body",displayName:"Body Text",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"body-text",type:"style",version:"0.7.0"}]},"x-oapi-codegen-extra-tags":{yaml:"capabilities",json:"capabilities,omitempty",gorm:"type:bytes;serializer:json"}},metadata:{"x-go-type":"Relationship_Metadata","x-order":5,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},styles:{"x-go-type":"RelationshipDefinitionMetadataStyles","x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"},type:"object",description:"Visualization styles for a relationship",required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"primaryColor",json:"primaryColor"}},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"secondaryColor,omitempty",json:"secondaryColor,omitempty"}},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.","x-oapi-codegen-extra-tags":{yaml:"svgWhite",json:"svgWhite"}},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.","x-oapi-codegen-extra-tags":{yaml:"svgColor",json:"svgColor"}},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.","x-oapi-codegen-extra-tags":{yaml:"svgComplete,omitempty",json:"svgComplete,omitempty"}},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.","x-oapi-codegen-extra-tags":{yaml:"color,omitempty",json:"color,omitempty"}},"text-opacity":{type:"number",format:"float",description:"The opacity of the label text, including its outline.","x-go-name":"TextOpacity","x-oapi-codegen-extra-tags":{yaml:"text-opacity,omitempty",json:"text-opacity,omitempty"}},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text.","x-go-name":"FontFamily","x-oapi-codegen-extra-tags":{yaml:"font-family,omitempty",json:"font-family,omitempty"}},"font-size":{type:"string",description:"The size of the label text.","x-go-name":"FontSize","x-oapi-codegen-extra-tags":{yaml:"font-size,omitempty",json:"font-size,omitempty"}},"font-style":{type:"string",description:"A CSS font style to be applied to the label text.","x-go-name":"FontStyle","x-oapi-codegen-extra-tags":{yaml:"font-style,omitempty",json:"font-style,omitempty"}},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text.","x-go-name":"FontWeight","x-oapi-codegen-extra-tags":{yaml:"font-weight,omitempty",json:"font-weight,omitempty"}},"text-transform":{description:"A transformation to apply to the label text","x-go-name":"TextTransform","x-oapi-codegen-extra-tags":{yaml:"text-transform,omitempty",json:"text-transform,omitempty"},type:"string",enum:["none","uppercase","lowercase"]},opacity:{type:"number",format:"float",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","x-go-name":"Opacity","x-oapi-codegen-extra-tags":{yaml:"opacity,omitempty",json:"opacity,omitempty"}},"z-index":{type:"integer",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.","x-go-name":"ZIndex","x-oapi-codegen-extra-tags":{yaml:"z-index,omitempty",json:"z-index,omitempty"}},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id","x-go-name":"Label","x-oapi-codegen-extra-tags":{yaml:"label,omitempty",json:"label,omitempty"}},"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .","x-go-name":"EdgeAnimation","x-oapi-codegen-extra-tags":{yaml:"edge-animation,omitempty",json:"edge-animation,omitempty"}},"curve-style":{"x-go-name":"CurveStyle","x-oapi-codegen-extra-tags":{yaml:"curve-style,omitempty",json:"curve-style,omitempty"},type:"string",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.",enum:["haystack","straight","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"LineColor","x-oapi-codegen-extra-tags":{yaml:"line-color,omitempty",json:"line-color,omitempty"}},"line-style":{"x-go-name":"LineStyle","x-oapi-codegen-extra-tags":{yaml:"line-style,omitempty",json:"line-style,omitempty"},type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},"line-cap":{"x-go-name":"LineCap","x-oapi-codegen-extra-tags":{yaml:"line-cap,omitempty",json:"line-cap,omitempty"},type:"string",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.",enum:["butt","round","square"]},"line-opacity":{type:"number",format:"float",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.","x-go-name":"LineOpacity","x-oapi-codegen-extra-tags":{yaml:"line-opacity,omitempty",json:"line-opacity,omitempty"}},"target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"TargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"target-arrow-color,omitempty",json:"target-arrow-color,omitempty"}},"target-arrow-shape":{"x-go-name":"TargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"target-arrow-shape,omitempty",json:"target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{"x-go-name":"TargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"target-arrow-fill,omitempty",json:"target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"MidTargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-color,omitempty",json:"mid-target-arrow-color,omitempty"}},"mid-target-arrow-shape":{"x-go-name":"MidTargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-shape,omitempty",json:"mid-target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{"x-go-name":"MidTargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-fill,omitempty",json:"mid-target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",format:"float",description:"Scaling for the arrow size.","x-go-name":"ArrowScale","x-oapi-codegen-extra-tags":{yaml:"arrow-scale,omitempty",json:"arrow-scale,omitempty"}},"source-label":{type:"string",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","x-go-name":"SourceLabel","x-oapi-codegen-extra-tags":{yaml:"source-label,omitempty",json:"source-label,omitempty"}},"target-label":{type:"string",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","x-go-name":"TargetLabel","x-oapi-codegen-extra-tags":{yaml:"target-label,omitempty",json:"target-label,omitempty"}}}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"}}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-go-type-skip-optional-pointer":true,"x-order":6,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","x-oapi-codegen-extra-tags":{yaml:"model",json:"model",gorm:"type:bytes;serializer:json"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},modelId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-go-name":"ModelId","x-order":7,"x-oapi-codegen-extra-tags":{json:"-",gorm:"index:idx_relationship_definition_dbs_model_id,column:model_id"}},evaluationQuery:{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.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},selectors:{"x-go-type":"SelectorSet","x-order":9,"x-oapi-codegen-extra-tags":{yaml:"selectors,omitempty",json:"selectors,omitempty",gorm:"type:bytes;serializer:json"},type:"array",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.",items:{"x-go-type":"SelectorSetItem",type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",required:["allow"],properties:{allow:{description:"Selectors used to define relationships which are allowed.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"allow",json:"allow"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
10
10
|
|
|
11
11
|
add: Inserts a value into an array or adds a member to an object.
|
|
12
12
|
replace: Replaces a value.
|
|
13
13
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
14
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
14
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
15
15
|
remove: Removes a value.
|
|
16
16
|
copy: Copies a value from one location to another.
|
|
17
17
|
move: Moves a value from one location to another.
|
|
18
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
19
|
-
|
|
20
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
18
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
19
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
21
20
|
|
|
22
21
|
add: Inserts a value into an array or adds a member to an object.
|
|
23
22
|
replace: Replaces a value.
|
|
24
23
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
25
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
24
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
26
25
|
remove: Removes a value.
|
|
27
26
|
copy: Copies a value from one location to another.
|
|
28
27
|
move: Moves a value from one location to another.
|
|
29
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
30
|
-
|
|
31
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}},allow:{description:"Selectors used to define relationships which are allowed.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match_strategy_matrix:{description:"Strategy criterion for determing how to match the values at mutator/mutated paths",type:"array",items:{type:"array",items:{type:"string"}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
28
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
29
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}},deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"deny,omitempty",json:"deny,omitempty"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
32
30
|
|
|
33
31
|
add: Inserts a value into an array or adds a member to an object.
|
|
34
32
|
replace: Replaces a value.
|
|
35
33
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
36
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
34
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
37
35
|
remove: Removes a value.
|
|
38
36
|
copy: Copies a value from one location to another.
|
|
39
37
|
move: Moves a value from one location to another.
|
|
40
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
41
|
-
|
|
42
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
38
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
39
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
43
40
|
|
|
44
41
|
add: Inserts a value into an array or adds a member to an object.
|
|
45
42
|
replace: Replaces a value.
|
|
46
43
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
47
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
44
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
48
45
|
remove: Removes a value.
|
|
49
46
|
copy: Copies a value from one location to another.
|
|
50
47
|
move: Moves a value from one location to another.
|
|
51
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
52
|
-
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
53
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}},created_at:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}},required:["id","name","schemaVersion","version","components","relationships"]},MesheryPattern:{type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
48
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
49
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}}}}}}}}},required:["id","name","schemaVersion","version","components","relationships"]},MesheryPattern:{type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
54
50
|
- 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.
|
|
55
51
|
- maintenance: model is unavailable for a period of time.
|
|
56
52
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
@@ -58,51 +54,47 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
58
54
|
- 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.
|
|
59
55
|
- maintenance: model is unavailable for a period of time.
|
|
60
56
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
61
|
-
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},$id:"https://schemas.meshery.io/relationship.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",required:["schemaVersion","version","model","kind","type","subType"],additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"relationships.meshery.io/v1alpha3"},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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",type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",enum:["hierarchical","edge","sibling"],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.","x-go-name":"RelationshipType",gorm:"column:type",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",default:"enabled",enum:["pending","approved","ignored","enabled","deleted"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},evaluationQuery:{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.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.",items:{$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["schemaVersion","version","displayName","kind","type","entityState","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"}},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"}},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"key",json:"key"}},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed.","x-oapi-codegen-extra-tags":{yaml:"entityState",json:"entityState"}}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata"}}}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},metadata:{type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,"x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id"},properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"},default:false},styles:{anyOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}}},{properties:{"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc ."},"curve-style":{type:"string",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.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge\u2019s line. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"line-style":{type:"string",description:"The style of the edge\u2019s line.",enum:["solid","dotted","dashed"]},"line-cap":{type:"string",description:"The cap style of the edge\u2019s 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.",enum:["butt","round","square"],default:"butt"},"line-opacity":{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge\u2019s 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."},"target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"mid-target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",description:"Scaling for the arrow size.",minimum:0},"source-label":{type:"string",description:"The text to display for an edge\u2019s source label. Can give a path, e.g. data(id) will label with the elements id"},"target-label":{type:"string",description:"The text to display for an edge\u2019s target label. Can give a path, e.g. data(id) will label with the elements id"}}}]},{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}},$comment:"Extension point for additional styles"}],"x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"}}}},selectors:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},type:"array",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.",$comment:"Sets of selectors are interpreted as a logical UNION. Properties within a selector `allow` and `deny` are interpreted as logical AND, while 'from' and 'to' represents a UNION of set of combinatorial pairs.",items:{type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",additionalProperties:false,required:["allow"],properties:{deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
57
|
+
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",type:"object",required:["schemaVersion","version","model","kind","type","subType","id"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.","x-order":8,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-order":13,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",type:"string",enum:["hierarchical","edge","sibling"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.",type:"string","x-go-name":"RelationshipType","x-go-type-skip-optional-pointer":true,"x-order":12,"x-oapi-codegen-extra-tags":{yaml:"type",json:"type",gorm:"column:type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string","x-go-type-skip-optional-pointer":true,"x-order":10,"x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",enum:["enabled","ignored","deleted","approved","pending"],"x-order":11,"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.","x-order":2,items:{"x-go-type":"capability.Capability","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/capability"},$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["description","schemaVersion","version","displayName","kind","type","subType","entityState","key","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability."},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"]},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true}},default:[{description:"Configure the visual styles for the component",displayName:"Styling",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"",type:"style",version:"0.7.0"},{description:"Change the shape of the component",displayName:"Change Shape",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"shape",type:"style",version:"0.7.0"},{description:"Drag and Drop a component into a parent component in graph view",displayName:"Compound Drag And Drop",entityState:["declaration"],key:"",kind:"interaction",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"compoundDnd",type:"graph",version:"0.7.0"},{description:"Add text to nodes body",displayName:"Body Text",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"body-text",type:"style",version:"0.7.0"}]},"x-oapi-codegen-extra-tags":{yaml:"capabilities",json:"capabilities,omitempty",gorm:"type:bytes;serializer:json"}},metadata:{"x-go-type":"Relationship_Metadata","x-order":5,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},styles:{"x-go-type":"RelationshipDefinitionMetadataStyles","x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"},type:"object",description:"Visualization styles for a relationship",required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"primaryColor",json:"primaryColor"}},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"secondaryColor,omitempty",json:"secondaryColor,omitempty"}},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.","x-oapi-codegen-extra-tags":{yaml:"svgWhite",json:"svgWhite"}},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.","x-oapi-codegen-extra-tags":{yaml:"svgColor",json:"svgColor"}},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.","x-oapi-codegen-extra-tags":{yaml:"svgComplete,omitempty",json:"svgComplete,omitempty"}},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.","x-oapi-codegen-extra-tags":{yaml:"color,omitempty",json:"color,omitempty"}},"text-opacity":{type:"number",format:"float",description:"The opacity of the label text, including its outline.","x-go-name":"TextOpacity","x-oapi-codegen-extra-tags":{yaml:"text-opacity,omitempty",json:"text-opacity,omitempty"}},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text.","x-go-name":"FontFamily","x-oapi-codegen-extra-tags":{yaml:"font-family,omitempty",json:"font-family,omitempty"}},"font-size":{type:"string",description:"The size of the label text.","x-go-name":"FontSize","x-oapi-codegen-extra-tags":{yaml:"font-size,omitempty",json:"font-size,omitempty"}},"font-style":{type:"string",description:"A CSS font style to be applied to the label text.","x-go-name":"FontStyle","x-oapi-codegen-extra-tags":{yaml:"font-style,omitempty",json:"font-style,omitempty"}},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text.","x-go-name":"FontWeight","x-oapi-codegen-extra-tags":{yaml:"font-weight,omitempty",json:"font-weight,omitempty"}},"text-transform":{description:"A transformation to apply to the label text","x-go-name":"TextTransform","x-oapi-codegen-extra-tags":{yaml:"text-transform,omitempty",json:"text-transform,omitempty"},type:"string",enum:["none","uppercase","lowercase"]},opacity:{type:"number",format:"float",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","x-go-name":"Opacity","x-oapi-codegen-extra-tags":{yaml:"opacity,omitempty",json:"opacity,omitempty"}},"z-index":{type:"integer",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.","x-go-name":"ZIndex","x-oapi-codegen-extra-tags":{yaml:"z-index,omitempty",json:"z-index,omitempty"}},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id","x-go-name":"Label","x-oapi-codegen-extra-tags":{yaml:"label,omitempty",json:"label,omitempty"}},"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .","x-go-name":"EdgeAnimation","x-oapi-codegen-extra-tags":{yaml:"edge-animation,omitempty",json:"edge-animation,omitempty"}},"curve-style":{"x-go-name":"CurveStyle","x-oapi-codegen-extra-tags":{yaml:"curve-style,omitempty",json:"curve-style,omitempty"},type:"string",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.",enum:["haystack","straight","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"LineColor","x-oapi-codegen-extra-tags":{yaml:"line-color,omitempty",json:"line-color,omitempty"}},"line-style":{"x-go-name":"LineStyle","x-oapi-codegen-extra-tags":{yaml:"line-style,omitempty",json:"line-style,omitempty"},type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},"line-cap":{"x-go-name":"LineCap","x-oapi-codegen-extra-tags":{yaml:"line-cap,omitempty",json:"line-cap,omitempty"},type:"string",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.",enum:["butt","round","square"]},"line-opacity":{type:"number",format:"float",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.","x-go-name":"LineOpacity","x-oapi-codegen-extra-tags":{yaml:"line-opacity,omitempty",json:"line-opacity,omitempty"}},"target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"TargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"target-arrow-color,omitempty",json:"target-arrow-color,omitempty"}},"target-arrow-shape":{"x-go-name":"TargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"target-arrow-shape,omitempty",json:"target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{"x-go-name":"TargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"target-arrow-fill,omitempty",json:"target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"MidTargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-color,omitempty",json:"mid-target-arrow-color,omitempty"}},"mid-target-arrow-shape":{"x-go-name":"MidTargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-shape,omitempty",json:"mid-target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{"x-go-name":"MidTargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-fill,omitempty",json:"mid-target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",format:"float",description:"Scaling for the arrow size.","x-go-name":"ArrowScale","x-oapi-codegen-extra-tags":{yaml:"arrow-scale,omitempty",json:"arrow-scale,omitempty"}},"source-label":{type:"string",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","x-go-name":"SourceLabel","x-oapi-codegen-extra-tags":{yaml:"source-label,omitempty",json:"source-label,omitempty"}},"target-label":{type:"string",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","x-go-name":"TargetLabel","x-oapi-codegen-extra-tags":{yaml:"target-label,omitempty",json:"target-label,omitempty"}}}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"}}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-go-type-skip-optional-pointer":true,"x-order":6,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","x-oapi-codegen-extra-tags":{yaml:"model",json:"model",gorm:"type:bytes;serializer:json"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},modelId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-go-name":"ModelId","x-order":7,"x-oapi-codegen-extra-tags":{json:"-",gorm:"index:idx_relationship_definition_dbs_model_id,column:model_id"}},evaluationQuery:{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.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},selectors:{"x-go-type":"SelectorSet","x-order":9,"x-oapi-codegen-extra-tags":{yaml:"selectors,omitempty",json:"selectors,omitempty",gorm:"type:bytes;serializer:json"},type:"array",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.",items:{"x-go-type":"SelectorSetItem",type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",required:["allow"],properties:{allow:{description:"Selectors used to define relationships which are allowed.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"allow",json:"allow"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
62
58
|
|
|
63
59
|
add: Inserts a value into an array or adds a member to an object.
|
|
64
60
|
replace: Replaces a value.
|
|
65
61
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
66
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
62
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
67
63
|
remove: Removes a value.
|
|
68
64
|
copy: Copies a value from one location to another.
|
|
69
65
|
move: Moves a value from one location to another.
|
|
70
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
71
|
-
|
|
72
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
66
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
67
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
73
68
|
|
|
74
69
|
add: Inserts a value into an array or adds a member to an object.
|
|
75
70
|
replace: Replaces a value.
|
|
76
71
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
77
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
72
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
78
73
|
remove: Removes a value.
|
|
79
74
|
copy: Copies a value from one location to another.
|
|
80
75
|
move: Moves a value from one location to another.
|
|
81
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
82
|
-
|
|
83
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}},allow:{description:"Selectors used to define relationships which are allowed.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match_strategy_matrix:{description:"Strategy criterion for determing how to match the values at mutator/mutated paths",type:"array",items:{type:"array",items:{type:"string"}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
76
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
77
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}},deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"deny,omitempty",json:"deny,omitempty"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
84
78
|
|
|
85
79
|
add: Inserts a value into an array or adds a member to an object.
|
|
86
80
|
replace: Replaces a value.
|
|
87
81
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
88
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
82
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
89
83
|
remove: Removes a value.
|
|
90
84
|
copy: Copies a value from one location to another.
|
|
91
85
|
move: Moves a value from one location to another.
|
|
92
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
93
|
-
|
|
94
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
86
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
87
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
95
88
|
|
|
96
89
|
add: Inserts a value into an array or adds a member to an object.
|
|
97
90
|
replace: Replaces a value.
|
|
98
91
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
99
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
92
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
100
93
|
remove: Removes a value.
|
|
101
94
|
copy: Copies a value from one location to another.
|
|
102
95
|
move: Moves a value from one location to another.
|
|
103
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
104
|
-
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
105
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}},created_at:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}},MesheryPatternPage:{type:"object",properties:{page:{type:"integer"},page_size:{type:"integer"},patterns:{type:"array",items:{"x-go-type":"MesheryPattern",type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
96
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
97
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}}}}}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}},MesheryPatternPage:{type:"object",properties:{page:{type:"integer"},page_size:{type:"integer"},patterns:{type:"array",items:{"x-go-type":"MesheryPattern",type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
106
98
|
- 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.
|
|
107
99
|
- maintenance: model is unavailable for a period of time.
|
|
108
100
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
@@ -110,51 +102,47 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
110
102
|
- 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.
|
|
111
103
|
- maintenance: model is unavailable for a period of time.
|
|
112
104
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
113
|
-
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},$id:"https://schemas.meshery.io/relationship.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",required:["schemaVersion","version","model","kind","type","subType"],additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"relationships.meshery.io/v1alpha3"},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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",type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",enum:["hierarchical","edge","sibling"],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.","x-go-name":"RelationshipType",gorm:"column:type",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",default:"enabled",enum:["pending","approved","ignored","enabled","deleted"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},evaluationQuery:{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.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.",items:{$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["schemaVersion","version","displayName","kind","type","entityState","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"}},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"}},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"key",json:"key"}},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed.","x-oapi-codegen-extra-tags":{yaml:"entityState",json:"entityState"}}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata"}}}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},metadata:{type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,"x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id"},properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"},default:false},styles:{anyOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}}},{properties:{"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc ."},"curve-style":{type:"string",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.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge\u2019s line. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"line-style":{type:"string",description:"The style of the edge\u2019s line.",enum:["solid","dotted","dashed"]},"line-cap":{type:"string",description:"The cap style of the edge\u2019s 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.",enum:["butt","round","square"],default:"butt"},"line-opacity":{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge\u2019s 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."},"target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"mid-target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",description:"Scaling for the arrow size.",minimum:0},"source-label":{type:"string",description:"The text to display for an edge\u2019s source label. Can give a path, e.g. data(id) will label with the elements id"},"target-label":{type:"string",description:"The text to display for an edge\u2019s target label. Can give a path, e.g. data(id) will label with the elements id"}}}]},{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}},$comment:"Extension point for additional styles"}],"x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"}}}},selectors:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},type:"array",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.",$comment:"Sets of selectors are interpreted as a logical UNION. Properties within a selector `allow` and `deny` are interpreted as logical AND, while 'from' and 'to' represents a UNION of set of combinatorial pairs.",items:{type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",additionalProperties:false,required:["allow"],properties:{deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
105
|
+
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",type:"object",required:["schemaVersion","version","model","kind","type","subType","id"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.","x-order":8,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-order":13,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",type:"string",enum:["hierarchical","edge","sibling"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.",type:"string","x-go-name":"RelationshipType","x-go-type-skip-optional-pointer":true,"x-order":12,"x-oapi-codegen-extra-tags":{yaml:"type",json:"type",gorm:"column:type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string","x-go-type-skip-optional-pointer":true,"x-order":10,"x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",enum:["enabled","ignored","deleted","approved","pending"],"x-order":11,"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.","x-order":2,items:{"x-go-type":"capability.Capability","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/capability"},$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["description","schemaVersion","version","displayName","kind","type","subType","entityState","key","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability."},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"]},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true}},default:[{description:"Configure the visual styles for the component",displayName:"Styling",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"",type:"style",version:"0.7.0"},{description:"Change the shape of the component",displayName:"Change Shape",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"shape",type:"style",version:"0.7.0"},{description:"Drag and Drop a component into a parent component in graph view",displayName:"Compound Drag And Drop",entityState:["declaration"],key:"",kind:"interaction",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"compoundDnd",type:"graph",version:"0.7.0"},{description:"Add text to nodes body",displayName:"Body Text",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"body-text",type:"style",version:"0.7.0"}]},"x-oapi-codegen-extra-tags":{yaml:"capabilities",json:"capabilities,omitempty",gorm:"type:bytes;serializer:json"}},metadata:{"x-go-type":"Relationship_Metadata","x-order":5,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},styles:{"x-go-type":"RelationshipDefinitionMetadataStyles","x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"},type:"object",description:"Visualization styles for a relationship",required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"primaryColor",json:"primaryColor"}},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"secondaryColor,omitempty",json:"secondaryColor,omitempty"}},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.","x-oapi-codegen-extra-tags":{yaml:"svgWhite",json:"svgWhite"}},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.","x-oapi-codegen-extra-tags":{yaml:"svgColor",json:"svgColor"}},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.","x-oapi-codegen-extra-tags":{yaml:"svgComplete,omitempty",json:"svgComplete,omitempty"}},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.","x-oapi-codegen-extra-tags":{yaml:"color,omitempty",json:"color,omitempty"}},"text-opacity":{type:"number",format:"float",description:"The opacity of the label text, including its outline.","x-go-name":"TextOpacity","x-oapi-codegen-extra-tags":{yaml:"text-opacity,omitempty",json:"text-opacity,omitempty"}},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text.","x-go-name":"FontFamily","x-oapi-codegen-extra-tags":{yaml:"font-family,omitempty",json:"font-family,omitempty"}},"font-size":{type:"string",description:"The size of the label text.","x-go-name":"FontSize","x-oapi-codegen-extra-tags":{yaml:"font-size,omitempty",json:"font-size,omitempty"}},"font-style":{type:"string",description:"A CSS font style to be applied to the label text.","x-go-name":"FontStyle","x-oapi-codegen-extra-tags":{yaml:"font-style,omitempty",json:"font-style,omitempty"}},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text.","x-go-name":"FontWeight","x-oapi-codegen-extra-tags":{yaml:"font-weight,omitempty",json:"font-weight,omitempty"}},"text-transform":{description:"A transformation to apply to the label text","x-go-name":"TextTransform","x-oapi-codegen-extra-tags":{yaml:"text-transform,omitempty",json:"text-transform,omitempty"},type:"string",enum:["none","uppercase","lowercase"]},opacity:{type:"number",format:"float",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","x-go-name":"Opacity","x-oapi-codegen-extra-tags":{yaml:"opacity,omitempty",json:"opacity,omitempty"}},"z-index":{type:"integer",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.","x-go-name":"ZIndex","x-oapi-codegen-extra-tags":{yaml:"z-index,omitempty",json:"z-index,omitempty"}},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id","x-go-name":"Label","x-oapi-codegen-extra-tags":{yaml:"label,omitempty",json:"label,omitempty"}},"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .","x-go-name":"EdgeAnimation","x-oapi-codegen-extra-tags":{yaml:"edge-animation,omitempty",json:"edge-animation,omitempty"}},"curve-style":{"x-go-name":"CurveStyle","x-oapi-codegen-extra-tags":{yaml:"curve-style,omitempty",json:"curve-style,omitempty"},type:"string",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.",enum:["haystack","straight","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"LineColor","x-oapi-codegen-extra-tags":{yaml:"line-color,omitempty",json:"line-color,omitempty"}},"line-style":{"x-go-name":"LineStyle","x-oapi-codegen-extra-tags":{yaml:"line-style,omitempty",json:"line-style,omitempty"},type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},"line-cap":{"x-go-name":"LineCap","x-oapi-codegen-extra-tags":{yaml:"line-cap,omitempty",json:"line-cap,omitempty"},type:"string",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.",enum:["butt","round","square"]},"line-opacity":{type:"number",format:"float",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.","x-go-name":"LineOpacity","x-oapi-codegen-extra-tags":{yaml:"line-opacity,omitempty",json:"line-opacity,omitempty"}},"target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"TargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"target-arrow-color,omitempty",json:"target-arrow-color,omitempty"}},"target-arrow-shape":{"x-go-name":"TargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"target-arrow-shape,omitempty",json:"target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{"x-go-name":"TargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"target-arrow-fill,omitempty",json:"target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"MidTargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-color,omitempty",json:"mid-target-arrow-color,omitempty"}},"mid-target-arrow-shape":{"x-go-name":"MidTargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-shape,omitempty",json:"mid-target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{"x-go-name":"MidTargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-fill,omitempty",json:"mid-target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",format:"float",description:"Scaling for the arrow size.","x-go-name":"ArrowScale","x-oapi-codegen-extra-tags":{yaml:"arrow-scale,omitempty",json:"arrow-scale,omitempty"}},"source-label":{type:"string",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","x-go-name":"SourceLabel","x-oapi-codegen-extra-tags":{yaml:"source-label,omitempty",json:"source-label,omitempty"}},"target-label":{type:"string",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","x-go-name":"TargetLabel","x-oapi-codegen-extra-tags":{yaml:"target-label,omitempty",json:"target-label,omitempty"}}}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"}}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-go-type-skip-optional-pointer":true,"x-order":6,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","x-oapi-codegen-extra-tags":{yaml:"model",json:"model",gorm:"type:bytes;serializer:json"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},modelId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-go-name":"ModelId","x-order":7,"x-oapi-codegen-extra-tags":{json:"-",gorm:"index:idx_relationship_definition_dbs_model_id,column:model_id"}},evaluationQuery:{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.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},selectors:{"x-go-type":"SelectorSet","x-order":9,"x-oapi-codegen-extra-tags":{yaml:"selectors,omitempty",json:"selectors,omitempty",gorm:"type:bytes;serializer:json"},type:"array",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.",items:{"x-go-type":"SelectorSetItem",type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",required:["allow"],properties:{allow:{description:"Selectors used to define relationships which are allowed.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"allow",json:"allow"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
114
106
|
|
|
115
107
|
add: Inserts a value into an array or adds a member to an object.
|
|
116
108
|
replace: Replaces a value.
|
|
117
109
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
118
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
110
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
119
111
|
remove: Removes a value.
|
|
120
112
|
copy: Copies a value from one location to another.
|
|
121
113
|
move: Moves a value from one location to another.
|
|
122
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
123
|
-
|
|
124
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
114
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
115
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
125
116
|
|
|
126
117
|
add: Inserts a value into an array or adds a member to an object.
|
|
127
118
|
replace: Replaces a value.
|
|
128
119
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
129
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
120
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
130
121
|
remove: Removes a value.
|
|
131
122
|
copy: Copies a value from one location to another.
|
|
132
123
|
move: Moves a value from one location to another.
|
|
133
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
134
|
-
|
|
135
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}},allow:{description:"Selectors used to define relationships which are allowed.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match_strategy_matrix:{description:"Strategy criterion for determing how to match the values at mutator/mutated paths",type:"array",items:{type:"array",items:{type:"string"}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
124
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
125
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}},deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"deny,omitempty",json:"deny,omitempty"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
136
126
|
|
|
137
127
|
add: Inserts a value into an array or adds a member to an object.
|
|
138
128
|
replace: Replaces a value.
|
|
139
129
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
140
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
130
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
141
131
|
remove: Removes a value.
|
|
142
132
|
copy: Copies a value from one location to another.
|
|
143
133
|
move: Moves a value from one location to another.
|
|
144
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
145
|
-
|
|
146
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
134
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
135
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
147
136
|
|
|
148
137
|
add: Inserts a value into an array or adds a member to an object.
|
|
149
138
|
replace: Replaces a value.
|
|
150
139
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
151
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
140
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
152
141
|
remove: Removes a value.
|
|
153
142
|
copy: Copies a value from one location to another.
|
|
154
143
|
move: Moves a value from one location to another.
|
|
155
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
156
|
-
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
157
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}},created_at:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}}},resultType:{type:"string"},total_count:{type:"integer"}}},MesheryPatternDeleteRequestBody:{type:"object",properties:{patterns:{type:"array",items:{"x-go-type":"DeletePatternModel",type:"object",properties:{id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true}}}}}},MesheryPatternRequestBody:{type:"object",properties:{path:{type:"string","x-go-type-skip-optional-pointer":true},pattern_data:{"x-go-type":"MesheryPattern",type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
144
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
145
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}}}}}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}}},resultType:{type:"string"},total_count:{type:"integer"}}},MesheryPatternDeleteRequestBody:{type:"object",properties:{patterns:{type:"array",items:{"x-go-type":"DeletePatternModel",type:"object",properties:{id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true}}}}}},MesheryPatternRequestBody:{type:"object",properties:{path:{type:"string","x-go-type-skip-optional-pointer":true},pattern_data:{"x-go-type":"MesheryPattern",type:"object",properties:{catalog_data:{"x-go-type":"catalog.CatalogData","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha2/catalog"},type:"object",properties:{publishedVersion:{description:"Tracks the specific content version that has been made available in the Catalog.",type:"string"},class:{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.",type:"string",oneOf:[{const:"official",description:"Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable."},{const:"verified",description:"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."},{const:"reference architecture",description:"Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Reference architecture content may have varying levels of support and reliability."}]},compatibility:{type:"array",title:"Model",items:{enum:["kubernetes"],type:"string"},uniqueItems:true,minItems:1,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."},pattern_caveats:{type:"string",title:"Caveats and Considerations",description:"Specific stipulations to consider and known behaviors to be aware of when using this design."},pattern_info:{type:"string",title:"Description",minLength:1,description:"Purpose of the design along with its intended and unintended uses."},type:{type:"string",title:"Type",enum:["Deployment","Observability","Resiliency","Scaling","Security","Traffic-management","Troubleshooting","Workloads"],default:"Deployment",description:"Categorization of the type of design or operational flow depicted in this design."},snapshotURL:{type:"array",items:{type:"string",format:"uri",pattern:"^(https?|http?|oci)://"},description:"Contains reference to the dark and light mode snapshots of the design."}},required:["compatibility","pattern_caveats","pattern_info","type"]},created_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},user_id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},location:{type:"object",additionalProperties:{type:"string"},"x-go-type-skip-optional-pointer":true},name:{type:"string","x-go-type-skip-optional-pointer":true},pattern_file:{"x-go-type":"PatternFile",$schema:"http://json-schema.org/draft-07/schema#",title:"Design Schema",description:"Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.",type:"object",properties:{id:{"x-order":1,type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"Name of the design; a descriptive, but concise title for the design document.","x-order":2},schemaVersion:{description:"Specifies the version of the schema to which the design conforms.","x-order":3,type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{default:"v0.0.1","x-order":4,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.",minLength:1,maxLength:50,type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},metadata:{type:"object","x-order":5,additionalProperties:true,properties:{resolvedAliases:{description:"Map of resolved aliases present in the design",type:"object","x-go-type":"map[string]corev1alpha1.ResolvedAlias","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/core",name:"corev1alpha1"},additionalProperties:{description:"An resolved alias is an component that acts as an ref/pointer to a field in another component, resolvedAlias are aware of there immediate parents and completely resolved parents also",allOf:[{description:"An alias is an component that acts as an ref/pointer to a field in another component, nonResolvedAlias are not aware of there immediate parents",type:"object",properties:{relationship_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},alias_component_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},immediate_ref_field_path:{type:"array",items:{type:"string"}}},required:["relationship_id","alias_component_id","immediate_parent_id","immediate_ref_field_path"]},{type:"object",properties:{resolved_parent_id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},resolved_ref_field_path:{type:"array",items:{type:"string"}}},required:["resolved_parent_id","resolved_ref_field_path"]}]}}}},components:{description:"A list of one or more component declarations.",minItems:0,"x-order":6,type:"array",items:{"x-go-type":"*component.ComponentDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/component"},$id:"https://schemas.meshery.io/component.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{"x-order":2,description:"Specifies the version of the schema to which the component definition conforms.","x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"components.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{"x-order":3,description:"Version of the component definition.",minLength:1,maxLength:50,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},type:"string",pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{"x-order":4,description:"Name of the component in human-readible format.","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{"x-order":5,type:"string",description:"A written representation of the purpose and characteristics of the component.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},format:{"x-order":6,type:"string",enum:["JSON","CUE"],default:"JSON",description:"Format specifies the format used in the `component.schema` field. JSON is the default.","x-oapi-codegen-extra-tags":{yaml:"format",json:"format"}},model:{"x-go-type":"model.ModelDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":7,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","x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id",json:"model,omitempty",yaml:"model,omitempty"},$id:"https://schemas.meshery.io/model.yaml",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the definition.","x-order":2,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"models.meshery.io/v1beta1",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},description:{type:"string",default:"A new Meshery model.",description:"Description of the model.",minLength:1,maxLength:1e3,"x-order":6,"x-oapi-codegen-extra-tags":{yaml:"description,omitempty",json:"description,omitempty"}},status:{type:"string",description:`Status of model, including:
|
|
158
146
|
- 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.
|
|
159
147
|
- maintenance: model is unavailable for a period of time.
|
|
160
148
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
@@ -162,49 +150,45 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
162
150
|
- 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.
|
|
163
151
|
- maintenance: model is unavailable for a period of time.
|
|
164
152
|
- enabled: model is available for use for all users of this Meshery Server.
|
|
165
|
-
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},$id:"https://schemas.meshery.io/relationship.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",required:["schemaVersion","version","model","kind","type","subType"],additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},default:"relationships.meshery.io/v1alpha3"},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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",type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",enum:["hierarchical","edge","sibling"],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.","x-go-name":"RelationshipType",gorm:"column:type",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",default:"enabled",enum:["pending","approved","ignored","enabled","deleted"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},evaluationQuery:{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.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.",items:{$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["schemaVersion","version","displayName","kind","type","entityState","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"],"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"}},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$","x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"}},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability.","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"type",json:"type"}},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"key",json:"key"}},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed.","x-oapi-codegen-extra-tags":{yaml:"entityState",json:"entityState"}}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata"}}}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},metadata:{type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,"x-oapi-codegen-extra-tags":{gorm:"foreignKey:ModelId;references:Id"},properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"},default:false},styles:{anyOf:[{type:"object",description:"Visualization styles for a relationship",allOf:[{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}}},{properties:{"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc ."},"curve-style":{type:"string",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.",default:"straight",enum:["straight","haystack","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge\u2019s line. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"line-style":{type:"string",description:"The style of the edge\u2019s line.",enum:["solid","dotted","dashed"]},"line-cap":{type:"string",description:"The cap style of the edge\u2019s 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.",enum:["butt","round","square"],default:"butt"},"line-opacity":{type:"number",minimum:0,maximum:1,default:1,description:"The opacity of the edge\u2019s 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."},"target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge\u2019s source arrow. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"mid-target-arrow-shape":{type:"string",description:"The shape of the edge\u2019s source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{type:"string",description:"The fill state of the edge\u2019s source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",description:"Scaling for the arrow size.",minimum:0},"source-label":{type:"string",description:"The text to display for an edge\u2019s source label. Can give a path, e.g. data(id) will label with the elements id"},"target-label":{type:"string",description:"The text to display for an edge\u2019s target label. Can give a path, e.g. data(id) will label with the elements id"}}}]},{type:"object",description:"Common styles for all entities",additionalProperties:false,required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation."},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation."},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background."},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background."},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background."},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. #ff0000 or #f00), RGB (e.g. rgb(255, 0, 0)), or HSL (e.g. hsl(0, 100%, 50%))."},"text-opacity":{type:"number",description:"The opacity of the label text, including its outline.",minimum:0,maximum:1},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text."},"font-size":{type:"string",description:"The size of the label text."},"font-style":{type:"string",description:"A CSS font style to be applied to the label text."},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text."},"text-transform":{type:"string",description:"A transformation to apply to the label text",enum:["none","uppercase","lowercase"]},opacity:{type:"number",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",minimum:0,maximum:1},"z-index":{type:"integer",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."},label:{type:"string",description:"The text to display for an element\u2019s label. Can give a path, e.g. data(id) will label with the elements id"}},$comment:"Extension point for additional styles"}],"x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"}}}},selectors:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},type:"array",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.",$comment:"Sets of selectors are interpreted as a logical UNION. Properties within a selector `allow` and `deny` are interpreted as logical AND, while 'from' and 'to' represents a UNION of set of combinatorial pairs.",items:{type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",additionalProperties:false,required:["allow"],properties:{deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
153
|
+
- ignored: model is unavailable for use for all users of this Meshery Server.`,default:"enabled",enum:["ignored","enabled","duplicate","resolved","open"],"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},metadata:{"x-order":11,type:"object",description:"Metadata contains additional information associated with the component.",required:["genealogy","isAnnotation","isNamespaced","published","instanceDetails","configurationUISchema"],properties:{genealogy:{"x-order":1,type:"string",description:"Genealogy represents the various representational states of the component."},isAnnotation:{"x-order":2,type:"boolean",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.",default:false},isNamespaced:{"x-order":3,type:"boolean",description:"Identifies whether the component is scoped to namespace or clsuter wide."},published:{"x-order":4,type:"boolean",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."},instanceDetails:{"x-order":5,type:"object",description:"InstanceDetails contains information about the instance of the component."},configurationUISchema:{"x-order":6,type:"string",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/ ."}},"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},additionalProperties:true},configuration:{"x-order":12,description:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).",type:"object",$comment:"The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema).","x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"}},component:{"x-order":13,"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-go-type":"Component",description:"data related to the third party capability that Component Defintion wraps , this is herematicaly sealed an",type:"object",properties:{version:{type:"string",description:"Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod.","x-order":1},kind:{type:"string",description:"The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'.","x-order":2},schema:{type:"string",description:"JSON schema of the object as defined by the registrant.","x-order":3}},required:["version","kind","schema"]},created_at:{"x-order":14,description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{"x-order":15,description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{"x-go-type":"DesignPreferences",type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]},relationships:{description:"List of relationships between components",type:"array","x-order":8,items:{"x-go-type":"*relationship.RelationshipDefinition","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha3/relationship"},description:"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships.",type:"object",required:["schemaVersion","version","model","kind","type","subType","id"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},schemaVersion:{description:"Specifies the version of the schema used for the relationship definition.","x-order":8,"x-oapi-codegen-extra-tags":{yaml:"schemaVersion",json:"schemaVersion"},type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1.","x-order":13,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"}},kind:{description:"Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.",type:"string",enum:["hierarchical","edge","sibling"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},type:{description:"Classification of relationships. Used to group relationships similar in nature.",type:"string","x-go-name":"RelationshipType","x-go-type-skip-optional-pointer":true,"x-order":12,"x-oapi-codegen-extra-tags":{yaml:"type",json:"type",gorm:"column:type"}},subType:{description:"Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship.",type:"string","x-go-type-skip-optional-pointer":true,"x-order":10,"x-oapi-codegen-extra-tags":{yaml:"subType",json:"subType"}},status:{type:"string",description:"Status of the relationship.",enum:["enabled","ignored","deleted","approved","pending"],"x-order":11,"x-oapi-codegen-extra-tags":{yaml:"status",json:"status"}},capabilities:{type:"array",description:"Capabilities associated with the relationship.","x-order":2,items:{"x-go-type":"capability.Capability","x-go-type-import":{path:"github.com/meshery/schemas/models/v1alpha1/capability"},$id:"https://schemas.meshery.io/capability.yaml",$schema:"http://json-schema.org/draft-07/schema#",description:"Meshery manages entities 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. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",additionalProperties:false,type:"object",required:["description","schemaVersion","version","displayName","kind","type","subType","entityState","key","status"],"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},properties:{schemaVersion:{description:"Specifies the version of the schema to which the capability definition conforms.",type:"string",minLength:2,maxLength:100,pattern:"([a-z.])*(?!^/)v(alpha|beta|[0-9]+)([.-]*[a-z0-9]+)*$",example:["v1","v1alpha1","v2beta3","v1.custom-suffix"]},version:{description:"Version of the capability definition.",type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Name of the capability in human-readible format.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},description:{type:"string",description:"A written representation of the purpose and characteristics of the capability."},kind:{description:"Top-level categorization of the capability",additionalProperties:false,anyOf:[{const:"action",description:"For capabilities related to executing actions on entities. Example: initiate log streaming on a Pod. Example: initiate deployment of a component."},{const:"mutate",description:"For capabilities related to mutating an entity. Example: the ability to change the configuration of a component."},{const:"view",description:"For capabilities related to viewing an entity. Example: the ability to view a components configuration."},{const:"interaction",description:"Catch all for capabilities related to interaction with entities. Example: the ability for a component to be dragged and dropped. Example: supports event bubbling to parent components. "}],type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},type:{description:"Classification of capabilities. Used to group capabilities similar in nature.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},subType:{description:"Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},key:{description:"Key that backs the capability.",type:"string",pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$"},entityState:{description:"State of the entity in which the capability is applicable.",type:"array",items:{type:"string",enum:["declaration","instance"],pattern:"^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",description:"A string starting with an alphanumeric character. Spaces and hyphens allowed."}},status:{type:"string",description:"Status of the capability",default:"enabled",enum:["enabled","disabled"]},metadata:{type:"object",description:"Metadata contains additional information associated with the capability. Extension point.",additionalProperties:true}},default:[{description:"Configure the visual styles for the component",displayName:"Styling",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"",type:"style",version:"0.7.0"},{description:"Change the shape of the component",displayName:"Change Shape",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"shape",type:"style",version:"0.7.0"},{description:"Drag and Drop a component into a parent component in graph view",displayName:"Compound Drag And Drop",entityState:["declaration"],key:"",kind:"interaction",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"compoundDnd",type:"graph",version:"0.7.0"},{description:"Add text to nodes body",displayName:"Body Text",entityState:["declaration"],key:"",kind:"mutate",schemaVersion:"capability.meshery.io/v1alpha1",status:"enabled",subType:"body-text",type:"style",version:"0.7.0"}]},"x-oapi-codegen-extra-tags":{yaml:"capabilities",json:"capabilities,omitempty",gorm:"type:bytes;serializer:json"}},metadata:{"x-go-type":"Relationship_Metadata","x-order":5,"x-oapi-codegen-extra-tags":{yaml:"metadata",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},type:"object",description:"Metadata contains additional information associated with the Relationship.",additionalProperties:true,properties:{description:{description:"Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management.",type:"string","x-oapi-codegen-extra-tags":{yaml:"description",json:"description"}},styles:{"x-go-type":"RelationshipDefinitionMetadataStyles","x-oapi-codegen-extra-tags":{yaml:"styles",json:"styles"},type:"object",description:"Visualization styles for a relationship",required:["primaryColor","svgColor","svgWhite"],properties:{primaryColor:{type:"string",description:"Primary color of the component used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"primaryColor",json:"primaryColor"}},secondaryColor:{type:"string",description:"Secondary color of the entity used for UI representation.","x-oapi-codegen-extra-tags":{yaml:"secondaryColor,omitempty",json:"secondaryColor,omitempty"}},svgWhite:{type:"string",description:"White SVG of the entity used for UI representation on dark background.","x-oapi-codegen-extra-tags":{yaml:"svgWhite",json:"svgWhite"}},svgColor:{type:"string",description:"Colored SVG of the entity used for UI representation on light background.","x-oapi-codegen-extra-tags":{yaml:"svgColor",json:"svgColor"}},svgComplete:{type:"string",description:"Complete SVG of the entity used for UI representation, often inclusive of background.","x-oapi-codegen-extra-tags":{yaml:"svgComplete,omitempty",json:"svgComplete,omitempty"}},color:{type:"string",description:"The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g.","x-oapi-codegen-extra-tags":{yaml:"color,omitempty",json:"color,omitempty"}},"text-opacity":{type:"number",format:"float",description:"The opacity of the label text, including its outline.","x-go-name":"TextOpacity","x-oapi-codegen-extra-tags":{yaml:"text-opacity,omitempty",json:"text-opacity,omitempty"}},"font-family":{type:"string",description:"A comma-separated list of font names to use on the label text.","x-go-name":"FontFamily","x-oapi-codegen-extra-tags":{yaml:"font-family,omitempty",json:"font-family,omitempty"}},"font-size":{type:"string",description:"The size of the label text.","x-go-name":"FontSize","x-oapi-codegen-extra-tags":{yaml:"font-size,omitempty",json:"font-size,omitempty"}},"font-style":{type:"string",description:"A CSS font style to be applied to the label text.","x-go-name":"FontStyle","x-oapi-codegen-extra-tags":{yaml:"font-style,omitempty",json:"font-style,omitempty"}},"font-weight":{type:"string",description:"A CSS font weight to be applied to the label text.","x-go-name":"FontWeight","x-oapi-codegen-extra-tags":{yaml:"font-weight,omitempty",json:"font-weight,omitempty"}},"text-transform":{description:"A transformation to apply to the label text","x-go-name":"TextTransform","x-oapi-codegen-extra-tags":{yaml:"text-transform,omitempty",json:"text-transform,omitempty"},type:"string",enum:["none","uppercase","lowercase"]},opacity:{type:"number",format:"float",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","x-go-name":"Opacity","x-oapi-codegen-extra-tags":{yaml:"opacity,omitempty",json:"opacity,omitempty"}},"z-index":{type:"integer",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.","x-go-name":"ZIndex","x-oapi-codegen-extra-tags":{yaml:"z-index,omitempty",json:"z-index,omitempty"}},label:{type:"string",description:"The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id","x-go-name":"Label","x-oapi-codegen-extra-tags":{yaml:"label,omitempty",json:"label,omitempty"}},"edge-animation":{type:"string",description:"The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc .","x-go-name":"EdgeAnimation","x-oapi-codegen-extra-tags":{yaml:"edge-animation,omitempty",json:"edge-animation,omitempty"}},"curve-style":{"x-go-name":"CurveStyle","x-oapi-codegen-extra-tags":{yaml:"curve-style,omitempty",json:"curve-style,omitempty"},type:"string",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.",enum:["haystack","straight","bezier","unbundled-bezier","segments","taxi"]},"line-color":{type:"string",description:"The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"LineColor","x-oapi-codegen-extra-tags":{yaml:"line-color,omitempty",json:"line-color,omitempty"}},"line-style":{"x-go-name":"LineStyle","x-oapi-codegen-extra-tags":{yaml:"line-style,omitempty",json:"line-style,omitempty"},type:"string",description:"The style of the edge's line.",enum:["solid","dotted","dashed"]},"line-cap":{"x-go-name":"LineCap","x-oapi-codegen-extra-tags":{yaml:"line-cap,omitempty",json:"line-cap,omitempty"},type:"string",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.",enum:["butt","round","square"]},"line-opacity":{type:"number",format:"float",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.","x-go-name":"LineOpacity","x-oapi-codegen-extra-tags":{yaml:"line-opacity,omitempty",json:"line-opacity,omitempty"}},"target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"TargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"target-arrow-color,omitempty",json:"target-arrow-color,omitempty"}},"target-arrow-shape":{"x-go-name":"TargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"target-arrow-shape,omitempty",json:"target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"target-arrow-fill":{"x-go-name":"TargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"target-arrow-fill,omitempty",json:"target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"mid-target-arrow-color":{type:"string",description:"The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g.","x-go-name":"MidTargetArrowColor","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-color,omitempty",json:"mid-target-arrow-color,omitempty"}},"mid-target-arrow-shape":{"x-go-name":"MidTargetArrowShape","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-shape,omitempty",json:"mid-target-arrow-shape,omitempty"},type:"string",description:"The shape of the edge's source arrow",enum:["triangle","triangle-tee","circle-triangle","triangle-cross","triangle-backcurve","vee","tee","square","circle","diamond","chevron","none"]},"mid-target-arrow-fill":{"x-go-name":"MidTargetArrowFill","x-oapi-codegen-extra-tags":{yaml:"mid-target-arrow-fill,omitempty",json:"mid-target-arrow-fill,omitempty"},type:"string",description:"The fill state of the edge's source arrow",enum:["filled","hollow"]},"arrow-scale":{type:"number",format:"float",description:"Scaling for the arrow size.","x-go-name":"ArrowScale","x-oapi-codegen-extra-tags":{yaml:"arrow-scale,omitempty",json:"arrow-scale,omitempty"}},"source-label":{type:"string",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","x-go-name":"SourceLabel","x-oapi-codegen-extra-tags":{yaml:"source-label,omitempty",json:"source-label,omitempty"}},"target-label":{type:"string",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","x-go-name":"TargetLabel","x-oapi-codegen-extra-tags":{yaml:"target-label,omitempty",json:"target-label,omitempty"}}}},isAnnotation:{type:"boolean",description:"Indicates whether the relationship should be treated as a logical representation only","x-oapi-codegen-extra-tags":{yaml:"isAnnotation",json:"isAnnotation"}}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-go-type-skip-optional-pointer":true,"x-order":6,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","x-oapi-codegen-extra-tags":{yaml:"model",json:"model",gorm:"type:bytes;serializer:json"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},modelId:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true,"x-go-name":"ModelId","x-order":7,"x-oapi-codegen-extra-tags":{json:"-",gorm:"index:idx_relationship_definition_dbs_model_id,column:model_id"}},evaluationQuery:{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.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"evaluationQuery",json:"evaluationQuery"}},selectors:{"x-go-type":"SelectorSet","x-order":9,"x-oapi-codegen-extra-tags":{yaml:"selectors,omitempty",json:"selectors,omitempty",gorm:"type:bytes;serializer:json"},type:"array",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.",items:{"x-go-type":"SelectorSetItem",type:"object",description:"Optional selectors used to match Components. Absence of a selector means that it is applied to all Components.",required:["allow"],properties:{allow:{description:"Selectors used to define relationships which are allowed.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"allow",json:"allow"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
166
154
|
|
|
167
155
|
add: Inserts a value into an array or adds a member to an object.
|
|
168
156
|
replace: Replaces a value.
|
|
169
157
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
170
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
158
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
171
159
|
remove: Removes a value.
|
|
172
160
|
copy: Copies a value from one location to another.
|
|
173
161
|
move: Moves a value from one location to another.
|
|
174
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
175
|
-
|
|
176
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
162
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
163
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
177
164
|
|
|
178
165
|
add: Inserts a value into an array or adds a member to an object.
|
|
179
166
|
replace: Replaces a value.
|
|
180
167
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
181
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
168
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
182
169
|
remove: Removes a value.
|
|
183
170
|
copy: Copies a value from one location to another.
|
|
184
171
|
move: Moves a value from one location to another.
|
|
185
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
186
|
-
|
|
187
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}},allow:{description:"Selectors used to define relationships which are allowed.",type:"object",required:["to","from"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match_strategy_matrix:{description:"Strategy criterion for determing how to match the values at mutator/mutated paths",type:"array",items:{type:"array",items:{type:"string"}}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
172
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
173
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}},deny:{description:"Optional selectors used to define relationships which should not be created / is restricted.","x-go-type":"Selector","x-oapi-codegen-extra-tags":{yaml:"deny,omitempty",json:"deny,omitempty"},type:"object",required:["from","to"],properties:{from:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
188
174
|
|
|
189
175
|
add: Inserts a value into an array or adds a member to an object.
|
|
190
176
|
replace: Replaces a value.
|
|
191
177
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
192
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
178
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
193
179
|
remove: Removes a value.
|
|
194
180
|
copy: Copies a value from one location to another.
|
|
195
181
|
move: Moves a value from one location to another.
|
|
196
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
197
|
-
|
|
198
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{type:"object",additionalProperties:false,properties:{kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},"x-order":8,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","x-oapi-codegen-extra-tags":{gorm:"-"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},match:{type:"object",additionalProperties:false,oneOf:[{type:"array",items:{type:"array",items:{type:"string"}}},{properties:{from:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}},to:{$comment:"Type is array so that mutliple bindings can be supported between 2 nodes",type:"array",items:{type:"object",allOf:[{properties:{kind:{type:"string"},id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}]}}}}],"x-oapi-codegen-extra-tags":{yaml:"match",json:"match"}},patch:{allOf:[{properties:{patchStrategy:{description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
182
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
183
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"from",json:"from"}},to:{description:"Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match.",type:"array",items:{"x-go-type":"SelectorItem",type:"object",description:"Optional fields that are a part of the selector. Absence of a field has an implied * meaning.",properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},match:{"x-go-type":"MatchSelector","x-oapi-codegen-extra-tags":{yaml:"match,omitempty",json:"match,omitempty"},type:"object",description:"Match configuration for selector",properties:{refs:{type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"refs,omitempty",json:"refs,omitempty"}},from:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"from,omitempty",json:"from,omitempty"}},to:{type:"array",items:{"x-go-type":"MatchSelectorItem",type:"object",description:"Match selector item for binding between nodes",required:["kind"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"}},kind:{type:"string","x-oapi-codegen-extra-tags":{yaml:"kind",json:"kind"}},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}},"x-oapi-codegen-extra-tags":{yaml:"to,omitempty",json:"to,omitempty"}}}},match_strategy_matrix:{description:"Match strategy matrix for the selector",type:"array",items:{type:"array",items:{type:"string"}},"x-oapi-codegen-extra-tags":{yaml:"match_strategy_matrix",json:"match_strategy_matrix"}},model:{"x-go-type":"model.ModelReference","x-go-type-import":{path:"github.com/meshery/schemas/models/v1beta1/model"},description:"Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models","x-oapi-codegen-extra-tags":{yaml:"model",json:"model,omitempty"},type:"object",required:["id","name","version","displayName","model","registrant"],properties:{id:{type:"string",format:"uuid",description:"A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},name:{type:"string",description:"The unique name for the model within the scope of a registrant.",helperText:"Model name should be in lowercase with hyphens, not whitespaces.",pattern:"^[a-z0-9-]+$",examples:["cert-manager"],"x-order":4,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name"},default:"untitled-model"},version:{description:"Version of the model definition.",type:"string","x-order":3,"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"},displayName:{description:"Human-readable name for the model.",helperText:"Model display name may include letters, numbers, and spaces. Special characters are not allowed.",minLength:1,maxLength:100,type:"string",pattern:"^[a-zA-Z0-9 ]+$",examples:["Cert Manager"],"x-order":5,"x-oapi-codegen-extra-tags":{yaml:"displayName",json:"displayName"},default:"Untitled Model"},model:{"x-oapi-codegen-extra-tags":{gorm:"type:bytes;serializer:json"},"x-order":12,type:"object",description:"Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31).",required:["version"],properties:{version:{description:"Version of the model as defined by the registrant.",allOf:[{type:"string",minLength:5,maxLength:100,pattern:"^[a-z0-9]+.[0-9]+.[0-9]+(-[0-9A-Za-z-]+(.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$",description:"A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1."}],"x-oapi-codegen-extra-tags":{yaml:"version",json:"version"},"x-order":1}}},registrant:{"x-go-type":"RegistrantReference","x-oapi-codegen-extra-tags":{yaml:"registrant",json:"registrant"},type:"object",required:["kind"],properties:{kind:{type:"string"}}}}},patch:{"x-go-type":"RelationshipDefinition_Selectors_Patch","x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"},type:"object",description:"Patch configuration for the selector",properties:{patchStrategy:{"x-oapi-codegen-extra-tags":{yaml:"patchStrategy,omitempty",json:"patchStrategy,omitempty"},type:"string",description:`patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
|
|
199
184
|
|
|
200
185
|
add: Inserts a value into an array or adds a member to an object.
|
|
201
186
|
replace: Replaces a value.
|
|
202
187
|
merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
|
|
203
|
-
strategic:specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
188
|
+
strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
|
|
204
189
|
remove: Removes a value.
|
|
205
190
|
copy: Copies a value from one location to another.
|
|
206
191
|
move: Moves a value from one location to another.
|
|
207
|
-
test: Tests that a value at the target location is equal to a specified value
|
|
208
|
-
|
|
209
|
-
Strategic Merge Patch: For some Kubernetes resources, you can also use the strategic type for a strategic merge patch, which understands the structure of Kubernetes objects and can handle complex operations.`,type:"string",enum:["merge","strategic","add","remove","copy","move","test"],default:"copy"}}},{oneOf:[{properties:{mutatorRef:{type:"array",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."},description:"JSON ref to value from where patch should be applied."}}},{properties:{mutatedRef:{type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}]}],"x-oapi-codegen-extra-tags":{yaml:"patch",json:"patch"}}},description:"Optional fields that are a part of the `from` selector. Absence of a field has an implied * meaning."}}}}}}},created_at:{description:"Timestamp when the resource was created.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updated_at:{description:"Timestamp when the resource was updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}},save:{type:"boolean"},url:{description:"endpoint",'format"':"uri",pattern:"^https?://","x-go-type-skip-optional-pointer":true,type:"string"},name:{type:"string"}}},MesheryPatternImportRequestBody:{type:"object",description:"Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on your local system, or 'URL Import' if you have the file hosted online.",enum:["file","url"],properties:{file:{type:"string",format:"file",description:"Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details"},file_name:{type:"string",description:"The name of the pattern file being imported."},name:{type:"string",default:"Untitled Design",description:"Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it."},url:{type:"string",format:"uri",description:"Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details"}}},DesignPreferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]}}}},t=e;
|
|
192
|
+
test: Tests that a value at the target location is equal to a specified value.
|
|
193
|
+
`,enum:["merge","strategic","add","remove","copy","move","test"]},mutatorRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatorRef,omitempty",json:"mutatorRef,omitempty"},type:"array",description:"JSON ref to value from where patch should be applied.",items:{type:"array",items:{type:"string"},description:"The sequence of mutatorRef and mutatedRef must match. eg: mutatorRef: [[config, url], [config, name]], mutatedRef: [[configPatch, value], [name]]. The value [config, url] will be patched at [configPatch, value]. Similarly [config,name] will be patched at [name]."}},mutatedRef:{"x-oapi-codegen-extra-tags":{yaml:"mutatedRef,omitempty",json:"mutatedRef,omitempty"},type:"array",items:{type:"array",items:{type:"string"},description:"JSONPath (https://en.wikipedia.org/wiki/JSONPath) to property to be patched."}}}}}},"x-oapi-codegen-extra-tags":{yaml:"to",json:"to"}}}}}}}}}}},required:["id","name","schemaVersion","version","components","relationships"]},updated_at:{type:"string",format:"date-time","x-go-type-skip-optional-pointer":true},id:{type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},"x-go-type-skip-optional-pointer":true},visibility:{type:"string","x-go-type-skip-optional-pointer":true}}},save:{type:"boolean"},url:{description:"endpoint",'format"':"uri",pattern:"^https?://","x-go-type-skip-optional-pointer":true,type:"string"},name:{type:"string"}}},MesheryPatternImportRequestBody:{type:"object",description:"Choose the method you prefer to upload your design file. Select 'File Upload' if you have the file on your local system, or 'URL Import' if you have the file hosted online.",enum:["file","url"],properties:{file:{type:"string",format:"file",description:"Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details"},file_name:{type:"string",description:"The name of the pattern file being imported."},name:{type:"string",default:"Untitled Design",description:"Provide a name for your design file. This name will help you identify the file more easily. You can also change the name of your design after importing it."},url:{type:"string",format:"uri",description:"Provide the URL of the file you want to import. This should be a direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Also, ensure that design is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details"}}},DesignPreferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"Map of available layers, where keys are layer names."}},required:["layers"]}}}},t=e;
|
|
210
194
|
module.exports=t;
|