Meshery Schemas
The central schema repository for the Meshery platform. Browse constructs, validate documents, explore the REST API, and learn schema-driven development.
What Can You Do Here?
Everything you need to work with Meshery's schema-driven architecture.
Validate
Paste a YAML or JSON document and validate it against any published construct schema — no repo clone needed.
Explore Constructs
Browse every construct across all API versions — property tables, required fields, and example values.
API Reference
Browsable OpenAPI specifications for Meshery Server and Layer5 Cloud.
Add a Construct
Step-by-step guide to adding a new entity schema following the dual-schema pattern.
Naming Rules
Single-page cheat sheet for every casing rule — camelCase, snake_case, PascalCase, and when each applies.
Build Pipeline
Understand how YAML schemas flow through code generators into Go structs, TypeScript types, and RTK hooks.
Go Structs
Browse auto-generated Go structs for every construct, with JSON tags and schema property mappings.
TypeScript Package
Import guide for @meshery/schemas — types, RTK Query hooks, and runtime schema constants.
Quick Install
Go
go get github.com/meshery/schemas@latestTypeScript / npm
npm install @meshery/schemasConstruct Versions at a Glance
Current API versions available in the repository.
| Version | Status | Constructs |
|---|---|---|
v1beta2 |
current | academy, catalog, component, connection, design, event, invitation, plan, relationship, selector, subscription, token |
v1beta1 |
migrating | 31 constructs — academy, badge, capability, catalog, category, component, connection, credential, design, environment, evaluation, event, feature, invitation, key, keychain, model, organization, plan, relationship, role, schedule, selector, subcategory, subscription, team, token, user, view, workspace, and more |
v1alpha3 |
deprecated | relationship |
v1alpha2 |
deprecated | relationship |
v1alpha1 |
deprecated | capability, catalog_data, component, core, model, relationship, selector |