@meshery/schemas 0.0.2-0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019, 2020 Layer5, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,472 @@
+
+<p style="text-align:center;" align="center"><a href="https://meshery.io"><picture>
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-light-text-side.svg">
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg">
+<img src="https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg"
+alt="Meshery Logo" width="70%" /></picture></a><br /><br /></p>
+<p align="center">
+<a href="https://hub.docker.com/r/layer5/meshery" alt="Docker pulls">
+  <img src="https://img.shields.io/docker/pulls/layer5/meshery.svg" /></a>
+<a href="https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%3Alayer5io+org%3Ameshery+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+org%3A+label%3A%22help+wanted%22+" alt="GitHub issues by-label">
+  <img src="https://img.shields.io/github/issues/layer5io/meshery/help%20wanted.svg?color=informational" /></a>
+<a href="https://github.com/meshery/meshery/blob/master/LICENSE" alt="LICENSE">
+  <img src="https://img.shields.io/github/license/meshery/meshery?color=brightgreen" /></a>
+<a href="https://artifacthub.io/packages/helm/meshery/meshery" alt="Artifact Hub Meshery">
+  <img src="https://img.shields.io/endpoint?color=brightgreen&label=Helm%20Chart&style=plastic&url=https%3A%2F%2Fartifacthub.io%2Fbadge%2Frepository%2Fartifact-hub" /></a>
+<a href="https://goreportcard.com/report/github.com/meshery/meshery" alt="Go Report Card">
+  <img src="https://goreportcard.com/badge/github.com/meshery/meshery" /></a>
+<a href="https://github.com/meshery/meshery/actions" alt="Build Status">
+  <img src="https://img.shields.io/github/actions/workflow/status/meshery/meshery/release-drafter.yml" /></a>
+<a href="https://bestpractices.coreinfrastructure.org/projects/3564" alt="CLI Best Practices">
+  <img src="https://bestpractices.coreinfrastructure.org/projects/3564/badge" /></a>
+<a href="http://discuss.meshery.io" alt="Discuss Users">
+  <img src="https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.layer5.io" /></a>
+<a href="https://slack.meshery.io" alt="Join Slack">
+  <img src="https://img.shields.io/badge/Slack-@layer5.svg?logo=slack" /></a>
+<a href="https://twitter.com/intent/follow?screen_name=mesheryio" alt="Twitter Follow">
+  <img src="https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social" /></a>
+<a href="https://github.com/meshery/meshery/releases" alt="Meshery Downloads">
+  <img src="https://img.shields.io/github/downloads/meshery/meshery/total" /></a>
+<!-- <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery?ref=badge_shield" alt="License Scan Report">
+  <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Fmeshery%2Fmeshery.svg?type=shield"/></a>
+  -->
+</p>
+
+<h5><p align="center"><i>If you’re using Meshery or if you like the project, please <a href="https://github.com/meshery/meshery/stargazers">★</a> this repository to show your support! 🤩</i></p></h5>
+
+# Meshery Schemas
+
+Meshery follows schema-driven development. As a project, Meshery has different types of schemas. Some schemas are external facing, and some internal to Meshery itself. This repository serves as a central location for storing schemas from which all Meshery components can take reference.
+
+Meshery schemas offer a powerful system designed for:
+
+- **Model-Driven Management:** Meshery uses explicit models for describing infrastructure and applications.
+- **Dynamic Discovery:** The ability to process different kinds of relationships and styles, enables a sophisticated system that can adapt to many configurations.
+- **Lifecycle Management:** The schema properties track status and lifecycle of resources.
+- **Extensibility:** Open-ended metadata and modular schema components enable expansion and customization.
+- **Visual Representation:** The properties for styling of edges and nodes is for creating a user friendly visual representation.
+- **Automated Operations:** The schemas can support validation and automated configuration of infrastructure and applications, and patching.
+
+For an explanation of Meshery's terminology regarding schemas, definitions, declarations, and instances, please see [Contributor's Guide to Models](https://docs.meshery.io/project/contributing/contributing-models).
+
+## Contributing
+--> **For an explanation of the directory structure of this repository and how to contribute changes to Meshery's schemas, see [Contributor's Guide to Schema-Driven Development](https://docs.meshery.io/project/contributing/contributing-schemas).**
+
+<p style="clear:both;">&nbsp;</p>
+
+## Join the Meshery community!
+
+<a name="contributing"></a><a name="community"></a>
+Our projects are community-built and welcome collaboration. 👍 Be sure to see the <a href="https://docs.meshery.io/project/contributing#not-sure-where-to-start">Contributor Welcome Guide</a> and <a href="https://meshery.io/community#handbook">Community Handbook</a> for a tour of resources available to you and the <a href="https://layer5.io/community/handbook/repository-overview">Repository Overview</a> for a cursory description of repository by technology and programming language. Jump into community <a href="https://slack.meshery.io">Slack</a> or <a href="https://meshery.io/community#discussion-forums">discussion forum</a> to participate.
+
+<p style="clear:both;">
+<a href ="https://meshery.io/community"><img alt="MeshMates" src=".github/assets/images/readme/layer5-community-sign.png" style="margin-right:36px; margin-bottom:7px;" width="140px" align="left" /></a>
+<h3>Find your MeshMate</h3>
+
+<p>MeshMates are experienced community members, who will help you learn your way around, discover live projects, and expand your community network. Connect with a Meshmate today!</p>
+
+Find out more on the <a href="https://meshery.io/community#meshmates">Meshery community</a>. <br />
+
+</p>
+<br /><br />
+<div style="display: flex; justify-content: center; align-items:center;">
+<div>
+<a href="https://meshery.io/community"><img alt="Meshery Cloud Native Community" src="https://docs.meshery.io/assets/img/readme/community.png" width="140px" style="margin-right:36px; margin-bottom:7px;" width="140px" align="left"/></a>
+</div>
+<div style="width:60%; padding-left: 16px; padding-right: 16px">
+<p>
+✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://meshery.io/calendar">community calendar</a>.<br />
+✔️ <em><strong>Watch</strong></em> community <a href="https://www.youtube.com/@mesheryio?sub_confirmation=1">meeting recordings</a>.<br />
+✔️ <em><strong>Fill-in</strong></em> a <a href="https://layer5.io/newcomers">community member form</a> to gain access to community resources.
+<br />
+✔️ <em><strong>Discuss</strong></em> in the <a href="https://meshery.io/community#discussion-forums">Community Forum</a>.<br />
+✔️ <em><strong>Explore more</strong></em> in the <a href="https://meshery.io/community#handbook">Community Handbook</a>.<br />
+</p>
+<p align="center">
+<i>Not sure where to start?</i> Grab an open issue with the <a href="https://github.com/issues?q=is%3Aopen+is%3Aissue+archived%3Afalse+org%3Alayer5io+org%3Ameshery+org%3Ameshery-extensions+org%3Aservice-mesh-performance+org%3Aservice-mesh-patterns+label%3A%22help+wanted%22">help-wanted label</a>.
+</p>
+</div>
+<div>&nbsp;</div>
+
+## Contributing
+
+Please do! We're a warm and welcoming community of open source contributors. All types of contributions are welcome. Please read:
+
+- [General Contributor Guide](https://docs.meshery.io/project/contributing) - Overview of contribution processes
+- [Schema Contributor Guide](./CONTRIBUTING.md) - Schema-specific development workflows and guidelines
+
+<div>&nbsp;</div>
+
+
+# 🧬 Schema-Driven Development Guide
+
+Meshery follows a **Schema-Driven Development (SDD)** approach. This means that the **structure of data** used throughout the system is centrally defined using **schemas**. These schemas power consistency, validation, and code generation across the Meshery platform.
+
+---
+
+## 🧾 Schema Definition in Meshery
+
+Meshery uses the **OpenAPI v3** specification to define and manage schemas. Given the complexity of the platform, Meshery adopts a **modular, versioned, and extensible** schema strategy:
+
+* ✅ **Versioned schemas** for backward compatibility.
+* 🧩 **Modular constructs** for maintainability and reuse.
+* 🧪 **Schemas are used** for validation, API documentation, and automatic code generation.
+
+> 💡 **TIP**: When referencing models or other constructs in the schema, **always add `x-go-type` and `x-go-import-path`** to avoid generating redundant Go structs. Refer to existing patterns in the codebase.
+
+---
+
+## 📁 Schema Directory Structure
+
+All schemas are located in the `schemas/` directory at the root of the Meshery repository:
+
+```
+schemas/
+  constructs/
+    <schema-version>/               # e.g., v1beta1
+      <construct>/                  # e.g., model, component
+        <construct>.json            # Schema definition for the construct (noun)
+        subschemas/                 # Reusable modular pieces
+        openapi.yml                 # API operations (verbs: create, update, delete)
+        <construct>_template.json   # Generated JSON template from schema
+        <construct>_template.yaml   # Generated YAML template from schema
+```
+
+### 🧠 Explanation
+
+* **`constructs/`** – Holds schemas for various versions.
+* **`<schema-version>/`** – Represents a version (e.g., `v1alpha2`, `v1beta1`).
+* **`<construct>/`** – A specific construct like `pattern`, `component`, etc.
+* **`<construct>.json`** – Defines the **data model (noun)** for the construct.
+* **`subschemas/`** – Contains shared schema components for reuse.
+* **`openapi.yml`** – Defines **API operations** (verbs).
+* **Templates** – `*_template.json` and `*_template.yaml` are auto-generated examples with resolved references and defaults.
+
+---
+
+## ⚙️ Code Generation
+
+Meshery supports **automated code generation** from schemas for:
+
+* **Go**: Strongly-typed models for backend.
+* **TypeScript**: Interfaces and types for frontend use.
+* **RTK Query**: Clients generated from OpenAPI for use with Redux.
+* **JSON/YAML**: Templates with defaults and resolved references.
+
+---
+
+## 🚀 Unified Build: One Command for Everything
+
+Use the following command to perform the **entire schema-driven generation workflow**:
+
+```bash
+make build
+```
+
+### 🔧 What `make build` does:
+
+1. **Bundles OpenAPI schemas** for:
+
+   * Meshery
+   * Remote Providers (e.g. Layer5 Cloud)
+   * Combined (all constructs)
+   
+2. **Generates:**
+
+   * Golang structs
+   * TypeScript types
+   * JSON & YAML templates
+   * RTK Query clients
+
+> ⚠️ This is the recommended way to stay in sync with schema changes.
+
+---
+
+## 🧱 Bundled Schema Outputs
+
+After running `make build`, three bundled schema files are created:
+
+| File                 | Purpose                                        |
+| -------------------- | ---------------------------------------------- |
+| `merged_schema.yml`  | All schemas combined (used by Meshery clients) |
+| `cloud_schema.yml`   | Cloud-specific APIs for Remote Providers (e.g. Layer5 Cloud) |
+| `meshery_schema.yml` | Meshery-specific APIs                          |
+
+---
+
+## ✍️ Annotating OpenAPI Paths
+
+To control which schema paths are included in each bundled output, use the `x-internal` annotation inside the OpenAPI operations (`get`, `post`, etc.).
+
+### Example:
+
+```yaml
+paths:
+  /api/entitlement/plans:
+    get:
+      x-internal: ["cloud"]
+      operationId: getPlans
+      tags:
+        - Plans
+      summary: Get all plans supported by the system
+      responses:
+        "200":
+          description: Plans fetched successfully
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Plan"
+```
+
+* **With `x-internal`**: Included only in the respective client (e.g., `cloud`).
+* **Without `x-internal`**: Included in **all** clients.
+
+---
+
+## 🛠️ Advanced Usage (Optional)
+
+### 📌 Custom Generation in `generate.sh`
+
+Meshery uses a helper script (`generate.sh`) to map schema constructs to generated output:
+
+```bash
+generate_schema_models <construct> <schema-version> [<openapi-file>]
+
+generate_schema_models "capability" "v1alpha1"
+generate_schema_models "category" "v1beta1"
+generate_schema_models "pattern" "v1beta1" "schemas/constructs/v1beta1/design/openapi.yml"
+```
+
+This maps to Go packages like:
+
+```
+models/v1alpha1/capability/capability.go
+```
+
+### 🧩 RTK Query Client Generation
+
+The OpenAPI bundle is passed to a codegen tool to generate RTK Query clients. Include relevant paths using `x-internal` annotations and define request/response schemas appropriately.
+
+You can control this in `generate.sh` like:
+
+```bash
+# Merge relevant constructs for RTK generation
+npx @redocly/cli join schemas/base_cloud.yml \
+     "${v1beta1}/pattern/${merged_construct}" \
+     "${v1beta1}/component/${merged_construct}" \
+     "${v1beta1}/model/${merged_construct}" \
+     ... \
+     -o schemas/merged_openapi.yml \
+     --prefix-tags-with-info-prop title \
+     --prefix-components-with-info-prop title
+```
+
+# Using Generated RTK Query Clients
+
+
+## Prerequisites
+
+Before using the generated RTK clients, ensure you have:
+
+1. Installed the required dependencies:
+   - `@reduxjs/toolkit`
+   - `@layer5/schemas`
+
+2. Set up environment variables:
+   - `RTK_CLOUD_ENDPOINT_PREFIX`: Base URL for Cloud API endpoints
+   - `RTK_MESHERY_ENDPOINT_PREFIX`: Base URL for Meshery API endpoints
+
+## Store Configuration
+
+### Import API Slices Correctly
+
+To avoid cyclical imports that can break your application, import API slices from their specific exports:
+
+```javascript
+// ✅ Correct: Import from specific API exports
+import { cloudApi as cloudBaseApi } from "@layer5/schemas/dist/cloudApi";
+import { mesheryApi } from "@layer5/schemas/dist/mesheryApi";
+
+// ❌ Incorrect: Do not import directly from generic API file
+// import { api } from "@layer5/schemas/dist/api"; // Can cause cyclical imports
+```
+
+### Configure Redux Store
+
+Add the API reducers and middleware to your Redux store configuration:
+
+```javascript
+import { combineReducers, configureStore } from "@reduxjs/toolkit";
+import { cloudApi as cloudBaseApi } from "@layer5/schemas/dist/cloudApi";
+import catalogReducer from "./slices/catalog";
+import connectionReducer from "./slices/connection";
+import organizationReducer from "./slices/organization";
+import chartReducer from "./slices/charts";
+import themeReducer from "./slices/theme";
+// Optional: If you have locally defined APIs
+import { cloudApi } from "../api";
+
+// Combine reducers
+const rootReducer = combineReducers({
+  catalog: catalogReducer,
+  charts: chartReducer,
+  organization: organizationReducer,
+  connection: connectionReducer,
+  theme: themeReducer,
+  // Add generated API reducers
+  [cloudBaseApi.reducerPath]: cloudBaseApi.reducer,
+  // Optional: Add locally defined API reducers
+  [cloudApi.reducerPath]: cloudApi.reducer
+});
+
+// Configure store with middleware
+export const store = configureStore({
+  reducer: reduxPersist.createPersistEnhancedReducer(rootReducer),
+  middleware: getDefaultMiddleware =>
+    getDefaultMiddleware()
+      // Add generated API middleware
+      .concat(cloudBaseApi.middleware)
+      // Optional: Add locally defined API middleware
+      .concat(cloudApi.middleware)
+      // Add persistence middleware if needed
+      .concat(reduxPersist.persistMiddleware)
+});
+
+// Set up listeners for RTK Query cache behaviors like refetchOnFocus/refetchOnReconnect
+setupListeners(store.dispatch);
+```
+
+## Using API Hooks
+
+After configuring your store, you can import and use the generated hooks:
+
+### Cloud API Hooks
+
+```javascript
+import {
+  useGetPlansQuery,
+  useCreateDesignMutation,
+  useGetDesignsQuery,
+  // Other cloud API hooks...
+} from "@layer5/schemas/dist/cloudApi";
+
+function MyComponent() {
+  // Use hooks directly in your components
+  const { data: plans, isLoading, error } = useGetPlansQuery();
+
+  // Handle loading states
+  if (isLoading) return <div>Loading plans...</div>;
+
+  // Handle errors
+  if (error) return <div>Error loading plans</div>;
+
+  // Use data
+  return (
+    <div>
+      {plans.map(plan => (
+        <div key={plan.id}>{plan.name}</div>
+      ))}
+    </div>
+  );
+}
+```
+
+### Meshery API Hooks
+
+```javascript
+import {
+  useGetMeshModelsQuery,
+  useSubmitMeshConfigMutation,
+  // Other Meshery API hooks...
+} from "@layer5/schemas/dist/mesheryApi";
+
+function MesheryComponent() {
+  const { data: meshModels } = useGetMeshModelsQuery();
+  // ...
+}
+```
+
+## Troubleshooting
+
+### Common Issues
+
+1. **Stuck Loading States**:
+   - Verify environment variables are correctly set
+   - Check for CORS issues
+   - Ensure proper authentication headers are included
+
+2. **Cyclical Imports**:
+   - Always import from specific API files (`cloudApi.ts`, `mesheryApi.ts`)
+   - Avoid importing from generic `api.ts` files
+
+3. **Multiple RTK Instances**:
+   - Ensure proper reducer and middleware registration
+   - Check for naming conflicts in reducerPaths
+
+### Redux DevTools
+
+For better debugging, use Redux DevTools to monitor:
+- API request lifecycles
+- State changes
+- Caching behavior
+
+## Best Practices
+
+1. **Handle Loading States**:
+   ```javascript
+   const { data, isLoading, isFetching, error } = useGetDataQuery();
+   ```
+
+2. **Leverage Cache Options**:
+   ```javascript
+   const { data } = useGetDataQuery(null, {
+     pollingInterval: 30000, // Re-fetch every 30 seconds
+     refetchOnMountOrArgChange: true,
+     skip: !isReady // Skip query when not ready
+   });
+   ```
+
+3. **Use Transformations When Needed**:
+   ```javascript
+   const transformedData = data?.map(item => ({
+     ...item,
+     formattedValue: formatValue(item.value)
+   }));
+   ```
+
+## 🧪 Testing & Validating Schemas
+
+Validate your schema updates before committing by running:
+
+```bash
+make build
+```
+
+Or validate a single file:
+
+```bash
+npx @redocly/cli lint schemas/constructs/v1beta1/pattern/openapi.yml
+```
+
+---
+
+## ✅ Summary
+
+| Task                    | Command                 |
+| ----------------------- | ----------------------- |
+| Generate everything     | `make build`            |
+| Generate Go code only   | `make golang-generate`  |
+| Generate TS + templates | `make generate-types`   |
+| Lint OpenAPI            | `npx @redocly/cli lint` |
+
+---
+
+### License
+
+This repository and site are available as open-source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).
+
+<p align="center" >
+MESHERY IS A CLOUD NATIVE COMPUTING FOUNDATION PROJECT
+</p>