generated from meshery/meshery
-
Notifications
You must be signed in to change notification settings - Fork 95
Open
Labels
kind/enhancementImprovement in current featureImprovement in current feature
Description
Description
The current OpenAPI specifications for workspace and environment constructs under schemas/constructs/v1beta1 lack comprehensive documentation and have inconsistent error handling. While the basic CRUD endpoints exist, the schema definitions need enhancement to match production-quality standards.
Missing Functionality:
- Workspace: Missing detailed descriptions for relationship management endpoints (environments, designs), inconsistent error responses, and lacks professional API documentation structure.
- Environment: Missing comprehensive endpoint documentation, standardized error responses, and proper schema definitions for connection management operations.
Goal
Enhance the OpenAPI schemas to include professional-grade documentation, standardized error responses, consistent parameter usage, and detailed schema definitions that enable proper client code generation and API validation.
Contributor Guides and Handbook
- 🛠 Meshery Build & Release Strategy
- 📚 Instructions for contributing to documentation
- 🎨 Wireframes and designs for Meshery UI in Figma
- 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack
Metadata
Metadata
Assignees
Labels
kind/enhancementImprovement in current featureImprovement in current feature