Migrate APIs to be schema-driven

[Yashsharma1911]

Description: Enhance Meshery’s APIs capability by migrating to a schema-driven approach, which will ensure consistency, validation, and easier integration. It involves versioning and defining API schemas using OpenAPI/Swagger at https://github.com/meshery/schemas and auto generating structs. You will be ensuring all Meshery APIs aligns with defined schemas and are consistent.

• Expected Outcome: Identifying APIs and updating them to conform these schemas. Enhance API documentation to reflect the schema-driven approach. Updating APIs to ensure they are consistent and doing validation against defined schemas.

• Recommended Skills: Golang, Kubernetes, Swagger, JSON schemas, familiarity with React, Nextjs would be helpful

• Mentor(s): Lee Calcote (@leecalcote, [email protected]), Yash Sharma (@Yashsharma1911, [email protected])

---

Contributor Guides and Handbook

• 🛠 Meshery Build & Release Strategy
• 📚 Instructions for contributing to documentation
  • Meshery documentation site and source
• 🎨 Wireframes and designs for Meshery UI in Figma
• 🙋🏾🙋🏼 Questions: Discussion Forum and Community Slack

[upsaurav12]

Hi @Yashsharma1911,

I am interested in working on this project for LFX Mentorship. I have a question regarding the project agenda:- Are all the APIs in the meshery repository going to be built from scratch using a schema-driven approach/Swagger.

Thank You.

[rahulbansal3005]

Hi @Yashsharma1911, I am very interested to take up this task in LFX term 3.

[Omarabdul3ziz]

Hello, I am interested in contributing to this issue as part of the LFX mentorship program

[Ash-2k3]

Hey @Yashsharma1911, just wanted to know by when will the mentee be selected for this project ? Because I think the deadline was 27 Aug 5.00 AM PDT.

[leecalcote]

@Omarabdul3ziz @rahulbansal3005, great. Start participating.

@Ash-2k3 selection is based on supporting existing contributors. I encourage you to start participating today. The weekly Meshery Dev meeting starts in a few minutes...

@upsaurav12, good job on getting engaged and involved in the projects here.

[Ash-2k3]

Sure, thankks!!!

[prachinandi]

Meshery’s APIs

From where can I find Meshery’s APIs documentations?

[leecalcote]

@prachinandi here - https://docs.meshery.io/extensibility/api

[leecalcote]

@prachinandi, in fact, that page needs a small update to include ``` or <pre> around the two API path references at the bottom of the page (e.g. /api/perf). Open a PR, if you'd like to fix it...

[prachinandi]

@prachinandi, in fact, that page needs a small update to include ``` or \<pre\> around the two API path references at the bottom of the page (e.g. /api/perf). Open a PR, if you'd like to fix it...

Done! https://github.com/meshery/meshery/pull/12215