Meshery Schemas

Constructs

Every Meshery resource type is defined as a construct — an OpenAPI schema with entity definition, payload schema, and API endpoints. Use the version filter to browse constructs by API version.

academy

v1beta2 v1beta1 API

AcademyCurricula entity schema.

badge

v1beta1 API

Badge schema construct.

capability

v1beta1 v1alpha1 API

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, ...

catalog

v1beta2 v1beta1 v1alpha2 API

Catalog schema construct.

catalog_data

v1alpha1

Catalog_data schema construct.

category

v1beta1 API

Category of the model.

component

v1beta2 v1beta1 API

Components are reusable building blocks for depicting capabilities defined within models. Learn more at https://docs.meshery.io/concepts/components

connection

v1beta2 v1beta1 API

Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections

credential

v1beta1 API

Credential schema construct.

design

v1beta2 v1beta1 API

Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.

environment

v1beta1 API

Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments

evaluation

v1beta1 API

Evaluation schema construct.

event

v1beta2 v1beta1 API

EventResult entity schema.

feature

v1beta1 API

Feature schema construct.

invitation

v1beta2 v1beta1 API

Invitation entity schema.

key

v1beta1 API

Represents an authorization key used for access control.

keychain

v1beta1 API

Represents a collection of keys.

model

v1beta1 API

Meshery Models serve as a portable unit of packaging to define managed entities, their relationships, and capabilities.

organization

v1beta1 API

Organization schema construct.

plan

v1beta2 v1beta1 API

Plan entity schema.

relationship

v1beta2 v1beta1 v1alpha3 API

"Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical re...

role

v1beta1 API

Role schema construct.

schedule

v1beta1 API

Schedule schema construct.

selector

v1beta2 v1beta1 v1alpha3

Reusable relationships selectors schema elements

subcategory

v1beta1 API

Sub category of the model determines the secondary grouping.

subscription

v1beta2 v1beta1 API

Subscription entity schema.

team

v1beta1 API

A Team is a group of one or more users. Teams are often used as a grouping mechanism for assigning permissions, whether in the context of an organization, a workspace, or some other domain within M...

token

v1beta2 v1beta1 API

Represents a user-owned API token or OAuth session.

user

v1beta1 API

User schema construct.

view

v1beta1 API

A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views

workspace

v1beta1 API

A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/l...

31 constructs across 5 API versions. Data auto-generated from schemas/constructs/ at build time.