@meshery/schemas 0.0.2-0 → 0.0.3-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +18 -19
- package/dist/cloudApi.d.mts +429 -25
- package/dist/cloudApi.d.ts +429 -25
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/index.d.mts +5347 -122
- package/dist/index.d.ts +5347 -122
- package/dist/index.js +85 -21
- package/dist/index.mjs +85 -21
- package/dist/mesheryApi.d.mts +415 -313
- package/dist/mesheryApi.d.ts +415 -313
- package/package.json +2 -2
package/LICENSE
CHANGED
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
same "printed page" as the copyright notice for easier
|
|
187
187
|
identification within third-party archives.
|
|
188
188
|
|
|
189
|
-
Copyright
|
|
189
|
+
Copyright Meshery Authors
|
|
190
190
|
|
|
191
191
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
192
|
you may not use this file except in compliance with the License.
|
package/README.md
CHANGED
|
@@ -5,10 +5,10 @@
|
|
|
5
5
|
<img src="https://raw.githubusercontent.com/meshery/meshery/master/.github/assets/images/readme/meshery-logo-dark-text-side.svg"
|
|
6
6
|
alt="Meshery Logo" width="70%" /></picture></a><br /><br /></p>
|
|
7
7
|
<p align="center">
|
|
8
|
-
<a href="https://hub.docker.com/r/
|
|
9
|
-
<img src="https://img.shields.io/docker/pulls/
|
|
10
|
-
<a href="https://github.com/issues?q=is%3Aopen
|
|
11
|
-
<img src="https://img.shields.io/github/issues/
|
|
8
|
+
<a href="https://hub.docker.com/r/meshery/meshery" alt="Docker pulls">
|
|
9
|
+
<img src="https://img.shields.io/docker/pulls/meshery/meshery.svg" /></a>
|
|
10
|
+
<a href="https://github.com/issues?q=is%3Aopen%20is%3Aissue%20archived%3Afalse%20(org%3Ameshery%20OR%20org%3Aservice-mesh-performance%20OR%20org%3Aservice-mesh-patterns%20OR%20org%3Ameshery-extensions)%20label%3A%22help%20wanted%22" alt="GitHub issues by-label">
|
|
11
|
+
<img src="https://img.shields.io/github/issues/meshery/meshery/help%20wanted.svg?color=informational" /></a>
|
|
12
12
|
<a href="https://github.com/meshery/meshery/blob/master/LICENSE" alt="LICENSE">
|
|
13
13
|
<img src="https://img.shields.io/github/license/meshery/meshery?color=brightgreen" /></a>
|
|
14
14
|
<a href="https://artifacthub.io/packages/helm/meshery/meshery" alt="Artifact Hub Meshery">
|
|
@@ -20,9 +20,9 @@ alt="Meshery Logo" width="70%" /></picture></a><br /><br /></p>
|
|
|
20
20
|
<a href="https://bestpractices.coreinfrastructure.org/projects/3564" alt="CLI Best Practices">
|
|
21
21
|
<img src="https://bestpractices.coreinfrastructure.org/projects/3564/badge" /></a>
|
|
22
22
|
<a href="http://discuss.meshery.io" alt="Discuss Users">
|
|
23
|
-
<img src="https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.
|
|
23
|
+
<img src="https://img.shields.io/discourse/users?label=discuss&logo=discourse&server=https%3A%2F%2Fdiscuss.meshery.io" /></a>
|
|
24
24
|
<a href="https://slack.meshery.io" alt="Join Slack">
|
|
25
|
-
<img src="https://img.shields.io/badge/Slack-@
|
|
25
|
+
<img src="https://img.shields.io/badge/Slack-@meshery.svg?logo=slack" /></a>
|
|
26
26
|
<a href="https://twitter.com/intent/follow?screen_name=mesheryio" alt="Twitter Follow">
|
|
27
27
|
<img src="https://img.shields.io/twitter/follow/mesheryio.svg?label=Follow+Meshery&style=social" /></a>
|
|
28
28
|
<a href="https://github.com/meshery/meshery/releases" alt="Meshery Downloads">
|
|
@@ -57,10 +57,9 @@ For an explanation of Meshery's terminology regarding schemas, definitions, decl
|
|
|
57
57
|
## Join the Meshery community!
|
|
58
58
|
|
|
59
59
|
<a name="contributing"></a><a name="community"></a>
|
|
60
|
-
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
|
|
60
|
+
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. 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.
|
|
61
61
|
|
|
62
62
|
<p style="clear:both;">
|
|
63
|
-
<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>
|
|
64
63
|
<h3>Find your MeshMate</h3>
|
|
65
64
|
|
|
66
65
|
<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>
|
|
@@ -77,13 +76,13 @@ Find out more on the <a href="https://meshery.io/community#meshmates">Meshery co
|
|
|
77
76
|
<p>
|
|
78
77
|
✔️ <em><strong>Join</strong></em> any or all of the weekly meetings on <a href="https://meshery.io/calendar">community calendar</a>.<br />
|
|
79
78
|
✔️ <em><strong>Watch</strong></em> community <a href="https://www.youtube.com/@mesheryio?sub_confirmation=1">meeting recordings</a>.<br />
|
|
80
|
-
✔️ <em><strong>Fill-in</strong></em> a <a href="https://
|
|
79
|
+
✔️ <em><strong>Fill-in</strong></em> a <a href="https://meshery.io/newcomers">community member form</a> to gain access to community resources.
|
|
81
80
|
<br />
|
|
82
81
|
✔️ <em><strong>Discuss</strong></em> in the <a href="https://meshery.io/community#discussion-forums">Community Forum</a>.<br />
|
|
83
82
|
✔️ <em><strong>Explore more</strong></em> in the <a href="https://meshery.io/community#handbook">Community Handbook</a>.<br />
|
|
84
83
|
</p>
|
|
85
84
|
<p align="center">
|
|
86
|
-
<i>Not sure where to start?</i> Grab an open issue with the <a href="https://github.com/issues?q=is%3Aopen
|
|
85
|
+
<i>Not sure where to start?</i> Grab an open issue with the <a href="https://github.com/issues?q=is%3Aopen%20is%3Aissue%20archived%3Afalse%20(org%3Ameshery%20OR%20org%3Aservice-mesh-performance%20OR%20org%3Aservice-mesh-patterns%20OR%20org%3Ameshery-extensions)%20label%3A%22help%20wanted%22">help-wanted label</a>.
|
|
87
86
|
</p>
|
|
88
87
|
</div>
|
|
89
88
|
<div> </div>
|
|
@@ -168,7 +167,7 @@ make build
|
|
|
168
167
|
1. **Bundles OpenAPI schemas** for:
|
|
169
168
|
|
|
170
169
|
* Meshery
|
|
171
|
-
* Remote Providers (e.g.
|
|
170
|
+
* Remote Providers (e.g. Meshery Cloud)
|
|
172
171
|
* Combined (all constructs)
|
|
173
172
|
|
|
174
173
|
2. **Generates:**
|
|
@@ -189,7 +188,7 @@ After running `make build`, three bundled schema files are created:
|
|
|
189
188
|
| File | Purpose |
|
|
190
189
|
| -------------------- | ---------------------------------------------- |
|
|
191
190
|
| `merged_schema.yml` | All schemas combined (used by Meshery clients) |
|
|
192
|
-
| `cloud_schema.yml` | Cloud-specific APIs for Remote Providers (e.g.
|
|
191
|
+
| `cloud_schema.yml` | Cloud-specific APIs for Remote Providers (e.g. Meshery Cloud) |
|
|
193
192
|
| `meshery_schema.yml` | Meshery-specific APIs |
|
|
194
193
|
|
|
195
194
|
---
|
|
@@ -272,7 +271,7 @@ Before using the generated RTK clients, ensure you have:
|
|
|
272
271
|
|
|
273
272
|
1. Installed the required dependencies:
|
|
274
273
|
- `@reduxjs/toolkit`
|
|
275
|
-
- `@
|
|
274
|
+
- `@meshery/schemas`
|
|
276
275
|
|
|
277
276
|
2. Set up environment variables:
|
|
278
277
|
- `RTK_CLOUD_ENDPOINT_PREFIX`: Base URL for Cloud API endpoints
|
|
@@ -286,11 +285,11 @@ To avoid cyclical imports that can break your application, import API slices fro
|
|
|
286
285
|
|
|
287
286
|
```javascript
|
|
288
287
|
// ✅ Correct: Import from specific API exports
|
|
289
|
-
import { cloudApi as cloudBaseApi } from "@
|
|
290
|
-
import { mesheryApi } from "@
|
|
288
|
+
import { cloudApi as cloudBaseApi } from "@meshery/schemas/dist/cloudApi";
|
|
289
|
+
import { mesheryApi } from "@meshery/schemas/dist/mesheryApi";
|
|
291
290
|
|
|
292
291
|
// ❌ Incorrect: Do not import directly from generic API file
|
|
293
|
-
// import { api } from "@
|
|
292
|
+
// import { api } from "@meshery/schemas/dist/api"; // Can cause cyclical imports
|
|
294
293
|
```
|
|
295
294
|
|
|
296
295
|
### Configure Redux Store
|
|
@@ -299,7 +298,7 @@ Add the API reducers and middleware to your Redux store configuration:
|
|
|
299
298
|
|
|
300
299
|
```javascript
|
|
301
300
|
import { combineReducers, configureStore } from "@reduxjs/toolkit";
|
|
302
|
-
import { cloudApi as cloudBaseApi } from "@
|
|
301
|
+
import { cloudApi as cloudBaseApi } from "@meshery/schemas/dist/cloudApi";
|
|
303
302
|
import catalogReducer from "./slices/catalog";
|
|
304
303
|
import connectionReducer from "./slices/connection";
|
|
305
304
|
import organizationReducer from "./slices/organization";
|
|
@@ -350,7 +349,7 @@ import {
|
|
|
350
349
|
useCreateDesignMutation,
|
|
351
350
|
useGetDesignsQuery,
|
|
352
351
|
// Other cloud API hooks...
|
|
353
|
-
} from "@
|
|
352
|
+
} from "@meshery/schemas/dist/cloudApi";
|
|
354
353
|
|
|
355
354
|
function MyComponent() {
|
|
356
355
|
// Use hooks directly in your components
|
|
@@ -380,7 +379,7 @@ import {
|
|
|
380
379
|
useGetMeshModelsQuery,
|
|
381
380
|
useSubmitMeshConfigMutation,
|
|
382
381
|
// Other Meshery API hooks...
|
|
383
|
-
} from "@
|
|
382
|
+
} from "@meshery/schemas/dist/mesheryApi";
|
|
384
383
|
|
|
385
384
|
function MesheryComponent() {
|
|
386
385
|
const { data: meshModels } = useGetMeshModelsQuery();
|