@meshery/schemas 0.8.91 → 0.8.93
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/index.d.mts +29 -12
- package/dist/index.d.ts +29 -12
- package/dist/index.js +5 -5
- package/dist/index.mjs +5 -5
- package/dist/mesheryApi.d.mts +142 -156
- package/dist/mesheryApi.d.ts +142 -156
- package/package.json +1 -1
package/dist/index.mjs
CHANGED
|
@@ -6,7 +6,7 @@ var e={openapi:"3.0.0",info:{title:"design",version:"1.0.0"},paths:{"/api/patter
|
|
|
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"]}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"List of available layers"}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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"]}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
10
10
|
|
|
11
11
|
add: Inserts a value into an array or adds a member to an object.
|
|
12
12
|
replace: Replaces a value.
|
|
@@ -58,7 +58,7 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
58
58
|
- 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
59
|
- maintenance: model is unavailable for a period of time.
|
|
60
60
|
- 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"]}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"List of available layers"}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
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"]}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
62
62
|
|
|
63
63
|
add: Inserts a value into an array or adds a member to an object.
|
|
64
64
|
replace: Replaces a value.
|
|
@@ -110,7 +110,7 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
110
110
|
- 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
111
|
- maintenance: model is unavailable for a period of time.
|
|
112
112
|
- 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"]}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"List of available layers"}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
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"]}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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
114
|
|
|
115
115
|
add: Inserts a value into an array or adds a member to an object.
|
|
116
116
|
replace: Replaces a value.
|
|
@@ -162,7 +162,7 @@ Strategic Merge Patch: For some Kubernetes resources, you can also use the strat
|
|
|
162
162
|
- 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
163
|
- maintenance: model is unavailable for a period of time.
|
|
164
164
|
- 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"]}},required:["id","displayName","description","schemaVersion","format","version","configuration","metadata","modelId","modelReference","component"]}},preferences:{type:"object",description:"Design-level preferences","x-order":7,properties:{layers:{type:"object",description:"List of available layers"}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
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"]}},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.json",$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.",default:"v0.0.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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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.json",$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 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"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.",default:"v0.0.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).
|
|
166
166
|
|
|
167
167
|
add: Inserts a value into an array or adds a member to an object.
|
|
168
168
|
replace: Replaces a value.
|
|
@@ -206,7 +206,7 @@ copy: Copies a value from one location to another.
|
|
|
206
206
|
move: Moves a value from one location to another.
|
|
207
207
|
test: Tests that a value at the target location is equal to a specified value.`,$comment:`Array Indexing: When working with arrays, be aware that Kubernetes uses zero-based indexing in JSON patch paths.
|
|
208
208
|
Merge Patch vs. JSON Patch: Merge patches are less flexible than JSON patches and do not support all the same operations.
|
|
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."}}}}}}}}}}},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"}}}}},$schema:"http://json-schema.org/draft-04/schema#"},t=e;var i={openapi:"3.0.0",info:{title:"category",version:"1.0.0"},paths:{},components:{schemas:{CategoryDefinition:{$id:"https://schemas.meshery.io/category.json",$schema:"http://json-schema.org/draft-07/schema#",type:"object",description:"Category of the model.",required:["id","name","metadata"],properties:{id:{"x-order":1,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"},default:"00000000-0000-0000-0000-000000000000"},name:{type:"string",minLength:1,maxLength:100,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name",gorm:"name"},default:"Uncategorized",description:"The category of the model that determines the main grouping.",enum:["Analytics","App Definition and Development","Cloud Native Network","Cloud Native Storage","Database","Machine Learning","Observability and Analysis","Orchestration & Management","Platform","Provisioning","Runtime","Security & Compliance","Serverless","Tools","Uncategorized"],"x-order":2},metadata:{type:"object","x-oapi-codegen-extra-tags":{yaml:"metadata,omitempty",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},"x-order":3}}}}},$schema:"http://json-schema.org/draft-04/schema#"},a=i;var o={openapi:"3.0.0",info:{title:"SubCategory API",version:"1.0.0"},paths:{},components:{schemas:{SubCategoryDefinition:{$id:"https://schemas.meshery.io/category.json",$schema:"http://json-schema.org/draft-07/schema#",type:"string",title:"SubCategory",description:"Sub category of the model determines the secondary grouping.",default:"Uncategorized",enum:["API Gateway","API Integration","Application Definition & Image Build","Automation & Configuration","Certified Kubernetes - Distribution","Chaos Engineering","Cloud Native Storage","Cloud Provider","CNI","Compute","Container Registry","Container Runtime","Container Security","Container","Content Delivery Network","Continuous Integration & Delivery","Coordination & Service Discovery","Database","Flowchart","Framework","Installable Platform","Key Management","Key Management Service","Kubernetes","Logging","Machine Learning","Management Governance","Metrics","Monitoring","Networking Content Delivery","Operating System","Query","Remote Procedure Call","Scheduling & Orchestration","Secrets Management","Security Identity & Compliance","Service Mesh","Service Proxy","Source Version Control","Storage","Specifications","Streaming & Messaging","Tools","Tracing","Uncategorized","Video Conferencing"],minLength:1,maxLength:100,"x-oapi-codegen-extra-tags":{yaml:"subCategory",json:"subCategory"}}}},$schema:"http://json-schema.org/draft-04/schema#"},n=o;var r={openapi:"3.0.0",info:{title:"component",version:"1.0.0"},paths:{},components:{schemas:{ComponentDefinition:{$id:"https://schemas.meshery.io/component.json",$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:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).","x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.json",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).","x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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:
|
|
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."}}}}}}}}}}},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"]}}},$schema:"http://json-schema.org/draft-04/schema#"},t=e;var i={openapi:"3.0.0",info:{title:"category",version:"1.0.0"},paths:{},components:{schemas:{CategoryDefinition:{$id:"https://schemas.meshery.io/category.json",$schema:"http://json-schema.org/draft-07/schema#",type:"object",description:"Category of the model.",required:["id","name","metadata"],properties:{id:{"x-order":1,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"},default:"00000000-0000-0000-0000-000000000000"},name:{type:"string",minLength:1,maxLength:100,"x-oapi-codegen-extra-tags":{yaml:"name",json:"name",gorm:"name"},default:"Uncategorized",description:"The category of the model that determines the main grouping.",enum:["Analytics","App Definition and Development","Cloud Native Network","Cloud Native Storage","Database","Machine Learning","Observability and Analysis","Orchestration & Management","Platform","Provisioning","Runtime","Security & Compliance","Serverless","Tools","Uncategorized"],"x-order":2},metadata:{type:"object","x-oapi-codegen-extra-tags":{yaml:"metadata,omitempty",json:"metadata,omitempty",gorm:"type:bytes;serializer:json"},"x-order":3}}}}},$schema:"http://json-schema.org/draft-04/schema#"},a=i;var o={openapi:"3.0.0",info:{title:"SubCategory API",version:"1.0.0"},paths:{},components:{schemas:{SubCategoryDefinition:{$id:"https://schemas.meshery.io/category.json",$schema:"http://json-schema.org/draft-07/schema#",type:"string",title:"SubCategory",description:"Sub category of the model determines the secondary grouping.",default:"Uncategorized",enum:["API Gateway","API Integration","Application Definition & Image Build","Automation & Configuration","Certified Kubernetes - Distribution","Chaos Engineering","Cloud Native Storage","Cloud Provider","CNI","Compute","Container Registry","Container Runtime","Container Security","Container","Content Delivery Network","Continuous Integration & Delivery","Coordination & Service Discovery","Database","Flowchart","Framework","Installable Platform","Key Management","Key Management Service","Kubernetes","Logging","Machine Learning","Management Governance","Metrics","Monitoring","Networking Content Delivery","Operating System","Query","Remote Procedure Call","Scheduling & Orchestration","Secrets Management","Security Identity & Compliance","Service Mesh","Service Proxy","Source Version Control","Storage","Specifications","Streaming & Messaging","Tools","Tracing","Uncategorized","Video Conferencing"],minLength:1,maxLength:100,"x-oapi-codegen-extra-tags":{yaml:"subCategory",json:"subCategory"}}}},$schema:"http://json-schema.org/draft-04/schema#"},n=o;var r={openapi:"3.0.0",info:{title:"component",version:"1.0.0"},paths:{},components:{schemas:{ComponentDefinition:{$id:"https://schemas.meshery.io/component.json",$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:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).","x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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.json",$schema:"http://json-schema.org/draft-07/schema#",additionalProperties:false,type:"object",properties:{id:{description:"Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).","x-order":1,"x-oapi-codegen-extra-tags":{yaml:"id",json:"id"},type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"},default:"00000000-0000-0000-0000-000000000000"},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-]+)*)?$",default:"v0.0.1"},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:
|
|
210
210
|
- 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.
|
|
211
211
|
- maintenance: model is unavailable for a period of time.
|
|
212
212
|
- enabled: model is available for use for all users of this Meshery Server.
|