@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.
Files changed (36) hide show
  1. package/README.md +7 -15
  2. package/dist/cloudApi.d.mts +4047 -3586
  3. package/dist/cloudApi.d.ts +4047 -3586
  4. package/dist/cloudApi.js +1 -1
  5. package/dist/cloudApi.mjs +1 -1
  6. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +1 -1
  7. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
  9. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
  10. package/dist/constructs/v1beta1/pattern/Pattern.d.mts +0 -160
  11. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +0 -160
  12. package/dist/constructs/v1beta1/pattern/PatternSchema.js +13 -13
  13. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +13 -13
  14. package/dist/constructs/v1beta1/view/View.d.mts +674 -0
  15. package/dist/constructs/v1beta1/view/View.d.ts +674 -0
  16. package/dist/constructs/v1beta1/view/View.js +1 -0
  17. package/dist/constructs/v1beta1/view/View.mjs +0 -0
  18. package/dist/constructs/v1beta1/view/ViewSchema.d.mts +7 -0
  19. package/dist/constructs/v1beta1/view/ViewSchema.d.ts +7 -0
  20. package/dist/constructs/v1beta1/view/ViewSchema.js +2 -0
  21. package/dist/constructs/v1beta1/view/ViewSchema.mjs +2 -0
  22. package/dist/constructs/v1beta1/workspace/Workspace.d.mts +357 -148
  23. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +357 -148
  24. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +5 -5
  25. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +5 -5
  26. package/dist/constructs/v1beta2/design/Design.d.mts +0 -168
  27. package/dist/constructs/v1beta2/design/Design.d.ts +0 -168
  28. package/dist/constructs/v1beta2/design/DesignSchema.js +13 -13
  29. package/dist/constructs/v1beta2/design/DesignSchema.mjs +13 -13
  30. package/dist/constructs/v1beta2/relationship/RelationshipSchema.js +1 -1
  31. package/dist/constructs/v1beta2/relationship/RelationshipSchema.mjs +1 -1
  32. package/dist/index.js +33 -33
  33. package/dist/index.mjs +33 -33
  34. package/dist/mesheryApi.d.mts +382 -382
  35. package/dist/mesheryApi.d.ts +382 -382
  36. 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 control this in `generate.sh` like:
692
+ You can build the OpenAPI bundles with:
693
693
 
694
694
  ```bash
695
- # Merge relevant constructs for RTK generation
696
- npx @redocly/cli join schemas/base_cloud.yml \
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
- Or validate a single file:
880
+ For repository validation checks:
888
881
 
889
882
  ```bash
890
- npx @redocly/cli lint schemas/constructs/v1beta1/pattern/api.yml
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: swagger-cli bundle --dereference
930
- | Merge all: @redocly/cli join → merged_openapi.yml
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` |