API Schema Documentation

MeshX Foundation provides comprehensive schema documentation for all API objects and operations. This documentation is invaluable when constructing API requests or understanding API responses.

Accessing Schema Documentation

The schema documentation is available within the Swagger UI at https://api.meshx.dev/api/docs#/. Each schema can be expanded to view its structure, required fields, and data types.

Types of Schemas

The schema documentation includes:

1. Entity Schemas: Definitions for core entities such as:

   • Account, User, Role

   • DataSystem, DataSource, DataObject, Product

   • Mesh, Application

   • Tag, Policy

2. Request/Response Schemas:

   • CreateProductRequest, ProductResponse

   • TokenDataResponse, EntityResponse

   • ValidationResults, ErrorCodes

3. Transformation Schemas: Details for all available transformations:

   • RenameColumnTransformation

   • CastTransformation

   • JoinTransformation

   • SelectColumnsTransformation

   • FilterWithConditionTransformation

   • GroupByTransformation

   • UnionTransformation

   • PivotTransformation, UnpivotTransformation

   • And many more specialized transformations

4. Configuration Schemas:

   • ConnectionSecret

   • SchemaField

   • BuilderPipeline

   • ComputeConfig

   • ExpectationRules

Using Schemas For Reference

When constructing API requests:

1. Check the schema documentation for required fields and data types

2. Reference the example request bodies in the Swagger UI

3. Use the schema structure to validate your request format

4. When receiving errors, check against the schema to identify missing or invalid fields

This comprehensive schema documentation helps ensure you're constructing valid API requests and properly interpreting API responses.