@meshery/schemas 1.0.3 → 1.0.5
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/README.md +7 -15
- package/dist/cloudApi.d.mts +4047 -3586
- package/dist/cloudApi.d.ts +4047 -3586
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +1 -1
- package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +1 -1
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
- package/dist/constructs/v1beta1/pattern/Pattern.d.mts +0 -160
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +0 -160
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +13 -13
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +13 -13
- package/dist/constructs/v1beta1/view/View.d.mts +674 -0
- package/dist/constructs/v1beta1/view/View.d.ts +674 -0
- package/dist/constructs/v1beta1/view/View.js +1 -0
- package/dist/constructs/v1beta1/view/View.mjs +0 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.mts +7 -0
- package/dist/constructs/v1beta1/view/ViewSchema.d.ts +7 -0
- package/dist/constructs/v1beta1/view/ViewSchema.js +2 -0
- package/dist/constructs/v1beta1/view/ViewSchema.mjs +2 -0
- package/dist/constructs/v1beta1/workspace/Workspace.d.mts +357 -148
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +357 -148
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +5 -5
- package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +5 -5
- package/dist/constructs/v1beta2/design/Design.d.mts +0 -168
- package/dist/constructs/v1beta2/design/Design.d.ts +0 -168
- package/dist/constructs/v1beta2/design/DesignSchema.js +13 -13
- package/dist/constructs/v1beta2/design/DesignSchema.mjs +13 -13
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.js +1 -1
- package/dist/constructs/v1beta2/relationship/RelationshipSchema.mjs +1 -1
- package/dist/index.js +33 -33
- package/dist/index.mjs +33 -33
- package/dist/mesheryApi.d.mts +382 -382
- package/dist/mesheryApi.d.ts +382 -382
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -689,18 +689,11 @@ models/v1alpha1/capability/capability.go
|
|
|
689
689
|
|
|
690
690
|
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.
|
|
691
691
|
|
|
692
|
-
You can
|
|
692
|
+
You can build the OpenAPI bundles with:
|
|
693
693
|
|
|
694
694
|
```bash
|
|
695
|
-
#
|
|
696
|
-
|
|
697
|
-
"${v1beta1}/pattern/${merged_construct}" \
|
|
698
|
-
"${v1beta1}/component/${merged_construct}" \
|
|
699
|
-
"${v1beta1}/model/${merged_construct}" \
|
|
700
|
-
... \
|
|
701
|
-
-o _openapi_build/merged_openapi.yml \
|
|
702
|
-
--prefix-tags-with-info-prop title \
|
|
703
|
-
--prefix-components-with-info-prop title
|
|
695
|
+
# Build per-construct bundles, merge them, and emit cloud/meshery OpenAPI specs
|
|
696
|
+
make bundle-openapi
|
|
704
697
|
```
|
|
705
698
|
|
|
706
699
|
# Using Generated RTK Query Clients
|
|
@@ -884,10 +877,10 @@ Validate your schema updates before committing by running:
|
|
|
884
877
|
make build
|
|
885
878
|
```
|
|
886
879
|
|
|
887
|
-
|
|
880
|
+
For repository validation checks:
|
|
888
881
|
|
|
889
882
|
```bash
|
|
890
|
-
|
|
883
|
+
make validate-schemas
|
|
891
884
|
```
|
|
892
885
|
|
|
893
886
|
### Schema Validation Modes
|
|
@@ -926,8 +919,8 @@ schemas/constructs/ (OpenAPI YAML source files)
|
|
|
926
919
|
| 34 rules: casing, dual-schema, templates, pagination
|
|
927
920
|
v
|
|
928
921
|
[2] bundle-openapi node build/bundle-openapi.js
|
|
929
|
-
| Per-construct:
|
|
930
|
-
| Merge all:
|
|
922
|
+
| Per-construct: in-repo dereference to merged-openapi.json
|
|
923
|
+
| Merge all: in-repo prefixing merge → merged_openapi.yml
|
|
931
924
|
| Filter: cloud_openapi.yml, meshery_openapi.yml
|
|
932
925
|
v
|
|
933
926
|
[3] generate-golang node build/generate-golang.js
|
|
@@ -977,7 +970,6 @@ The **property name is the single source of truth** for the json wire format. oa
|
|
|
977
970
|
| Build TypeScript dist | `npm run build` |
|
|
978
971
|
| Generate Go code only | `make golang-generate` |
|
|
979
972
|
| Generate TS types + schemas | `make generate-ts` |
|
|
980
|
-
| Lint OpenAPI | `npx @redocly/cli lint` |
|
|
981
973
|
| Schema validation (blocking) | `make validate-schemas` |
|
|
982
974
|
| Schema audit (advisory) | `make audit-schemas` |
|
|
983
975
|
| Full schema debt report | `make audit-schemas-debt-full` |
|