Skip to content

[schemas] Remove errant defaults from [capability.json] #380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
+103 −208
Open

[schemas] Remove errant defaults from [capability.json] #380

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59a9f72
[schemas] Remove errant defaults from capability.json schema
saksham-1304 Jul 30, 2025
ce26d5a
[schemas] Remove errant defaults from capability.json schema
saksham-1304 Jul 31, 2025
97b61f8
[schemas] Remove errant defaults from capability.json schema
saksham-1304 Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 101 additions & 90 deletions schemas/constructs/v1alpha1/capability/capability.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
"description": "Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.",
"additionalProperties": false,
"type": "object",

"required": [
"description",
"schemaVersion",
Expand All @@ -22,24 +21,56 @@
},
"properties": {
"schemaVersion": {
"$ref": "../../core.json#/definitions/versionString",
"description": "Specifies the version of the schema to which the capability definition conforms."
"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-order": 1,
"x-oapi-codegen-extra-tags": {
"yaml": "schemaVersion",
"json": "schemaVersion"
}
},
"version": {
"$ref": "../../core.json#/definitions/semverString",
"description": "Version of the capability definition."
"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-]+)*)?$",
"default": "v0.0.1",
"x-order": 2,
"x-oapi-codegen-extra-tags": {
"yaml": "version",
"json": "version"
}
},
"displayName": {
"$ref": "../../core.json#/definitions/inputString",
"description": "Name of the capability in human-readible format."
"description": "Name of the capability in human-readible format.",
"type": "string",
"pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",
"x-order": 3,
"x-oapi-codegen-extra-tags": {
"yaml": "displayName",
"json": "displayName"
}
},
"description": {
"type": "string",
"description": "A written representation of the purpose and characteristics of the capability."
"description": "A written representation of the purpose and characteristics of the capability.",
"x-order": 4,
"x-oapi-codegen-extra-tags": {
"yaml": "description",
"json": "description"
}
},

"kind": {
"$ref": "../../core.json#/definitions/inputString",
"description": "Top-level categorization of the capability",
"additionalProperties": false,
"anyOf": [
Expand All @@ -51,113 +82,93 @@
"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-order": 5,
"x-oapi-codegen-extra-tags": {
"yaml": "kind",
"json": "kind"
}
},

"type": {
"$ref": "../../core.json#/definitions/inputString",
"description": "Classification of capabilities. Used to group capabilities similar in nature."
"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-order": 6,
"x-oapi-codegen-extra-tags": {
"yaml": "type",
"json": "type"
}
},

"subType": {
"$ref": "../../core.json#/definitions/inputString",
"description": "Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability."
"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-order": 7,
"x-oapi-codegen-extra-tags": {
"yaml": "subType",
"json": "subType"
}
},

"key": {
"$ref": "../../core.json#/definitions/inputString",
"description": "Key that backs the capability."
"description": "Key that backs the capability.",
"type": "string",
"pattern": "^[a-zA-Z_][a-zA-Z0-9_-]*[a-zA-Z0-9_]$",
"x-order": 8,
"x-oapi-codegen-extra-tags": {
"yaml": "key",
"json": "key"
}
},

"entityState": {
"description": "State of the entity in which the capability is applicable.",
"type": "array",
"items": {
"$ref": "../../core.json#/definitions/inputString",
"type": "string",
"enum": ["declaration", "instance"]
}
"enum": [
"declaration",
"instance"
],
"description": "The state of the entity, either 'declaration' or 'instance'.",
"x-oapi-codegen-extra-tags": {
"yaml": "entityState",
"json": "entityState"
}
},
"x-order": 9
},

"status": {
"type": "string",
"description": "Status of the capability",
"default": "enabled",
"enum": ["enabled", "disabled"]
"enum": [
"enabled",
"disabled"
],
"x-order": 10,
"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
}
},
"default": [
{
"description": "Configure the visual styles for the component",
"displayName": "Styling",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "",
"type": "style",
"version": "0.7.0"
},
{
"description": "Change the shape of the component",
"displayName": "Change Shape",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "shape",
"type": "style",
"version": "0.7.0"
},
{
"description": "Drag and Drop a component into a parent component in graph view",
"displayName": "Compound Drag And Drop",
"entityState": [
"declaration"
],
"key": "",
"kind": "interaction",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "compoundDnd",
"type": "graph",
"version": "0.7.0"
},
{
"description": "Add text to nodes body",
"displayName": "Body Text",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "body-text",
"type": "style",
"version": "0.7.0"
"additionalProperties": true,
"x-order": 11,
"x-oapi-codegen-extra-tags": {
"yaml": "metadata",
"json": "metadata"
}
}
]
}
}
}
60 changes: 1 addition & 59 deletions typescript/constructs/v1alpha1/capability/CapabilityOpenApiSchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,65 +130,7 @@ const schema = {
"description": "Metadata contains additional information associated with the capability. Extension point.",
"additionalProperties": true
}
},
"default": [
{
"description": "Configure the visual styles for the component",
"displayName": "Styling",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "",
"type": "style",
"version": "0.7.0"
},
{
"description": "Change the shape of the component",
"displayName": "Change Shape",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "shape",
"type": "style",
"version": "0.7.0"
},
{
"description": "Drag and Drop a component into a parent component in graph view",
"displayName": "Compound Drag And Drop",
"entityState": [
"declaration"
],
"key": "",
"kind": "interaction",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "compoundDnd",
"type": "graph",
"version": "0.7.0"
},
{
"description": "Add text to nodes body",
"displayName": "Body Text",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "body-text",
"type": "style",
"version": "0.7.0"
}
]
}
}
}
},
Expand Down
60 changes: 1 addition & 59 deletions typescript/constructs/v1alpha1/capability/CapabilitySchema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,65 +174,7 @@ const schema = {
"json": "metadata"
}
}
},
"default": [
{
"description": "Configure the visual styles for the component",
"displayName": "Styling",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "",
"type": "style",
"version": "0.7.0"
},
{
"description": "Change the shape of the component",
"displayName": "Change Shape",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "shape",
"type": "style",
"version": "0.7.0"
},
{
"description": "Drag and Drop a component into a parent component in graph view",
"displayName": "Compound Drag And Drop",
"entityState": [
"declaration"
],
"key": "",
"kind": "interaction",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "compoundDnd",
"type": "graph",
"version": "0.7.0"
},
{
"description": "Add text to nodes body",
"displayName": "Body Text",
"entityState": [
"declaration"
],
"key": "",
"kind": "mutate",
"schemaVersion": "capability.meshery.io/v1alpha1",
"status": "enabled",
"subType": "body-text",
"type": "style",
"version": "0.7.0"
}
]
}
}

export default schema;