Guide
Everything you need to contribute to or consume Meshery’s central schema repository.
Getting Started
Schema-Driven Development
Understand how YAML schemas propagate into Go structs, TypeScript types, and API docs across the Meshery ecosystem.
Add a Construct
Step-by-step tutorial: create an entity schema, define a payload, wire up endpoints, and pass validation.
Reference
Naming Rules
The definitive casing cheat sheet — camelCase, snake_case, PascalCase, kebab-case, and when each one applies.
Versioning
When to introduce a new API version, the deprecation process, and the construct version matrix.
Build Pipeline
How make build transforms schemas into generated code — every target, prerequisite, and failure mode.
Quick Links
- Constructs browser — browse all constructs with version filter
- Interactive validator — validate YAML/JSON against a schema
- API reference — bundled OpenAPI specs for Meshery and Cloud APIs
- Go structs — generated struct reference
- TypeScript package —
@meshery/schemasimport guide - GitHub repository — source code