@meshery/schemas 1.0.4 → 1.0.6

package/README.md

@@ -689,18 +689,11 @@ models/v1alpha1/capability/capability.go
 
 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:
+You can build the OpenAPI bundles with:
 
 ```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 _openapi_build/merged_openapi.yml \
-     --prefix-tags-with-info-prop title \
-     --prefix-components-with-info-prop title
+# Build per-construct bundles, merge them, and emit cloud/meshery OpenAPI specs
+make bundle-openapi
 ```
 
 # Using Generated RTK Query Clients
@@ -884,15 +877,15 @@ Validate your schema updates before committing by running:
 make build
 ```
 
-Or validate a single file:
+For repository validation checks:
 
 ```bash
-npx @redocly/cli lint schemas/constructs/v1beta1/pattern/api.yml
+make validate-schemas
 ```
 
 ### Schema Validation Modes
 
-`build/validate-schemas.js` enforces 33 rules organized into four issue tiers. Different `make` targets control which tiers are visible and whether violations block the build.
+The `validation/` Go package (invoked via `go run ./cmd/validate-schemas`) enforces 41 rules organized into four issue tiers. Different `make` targets control which tiers are visible and whether violations block the build.
 
 | Mode | Command | Blocking | Style | Design | Contract |
 | --- | --- | --- | --- | --- | --- |
@@ -904,14 +897,14 @@ npx @redocly/cli lint schemas/constructs/v1beta1/pattern/api.yml
 | Strict CI gate | `make validate-schemas-strict` | Exit 1 | Error | Error | Error |
 
 - **Blocking** (Rules 1-2, 5, 11-22, 27, 32-33): Always enforced. Break code generation or violate structural contracts.
-- **Style** (Rules 3-4, 6-10, 19): Naming conventions. Silent by default; visible with `--style-debt`; blocking in v1beta2-draft files and `--strict-consistency`.
+- **Style** (Rules 3-4, 6-10, 19): Naming conventions. Silent by default; visible with `--style-debt`; blocking with `--strict-consistency`.
 - **Design** (Rules 23-26, 30-31): API design patterns. Visible as advisories in `--warn` mode.
 - **Contract** (Rules 28-29): Published API contract checks (response codes, duplicate schemas). Visible as advisories in `--warn` mode.
 
 Run unit tests for the validation logic:
 
 ```bash
-npm run test:validate-schemas
+go test ./validation/...
 ```
 
 ### Build Pipeline
@@ -922,12 +915,12 @@ npm run test:validate-schemas
 schemas/constructs/          (OpenAPI YAML source files)
         |
         v
-[1] validate-schemas         node build/validate-schemas.js
-        |                    34 rules: casing, dual-schema, templates, pagination
+[1] validate-schemas         go run ./cmd/validate-schemas
+        |                    41 rules: casing, dual-schema, templates, pagination
         v
 [2] bundle-openapi           node build/bundle-openapi.js
-        |                    Per-construct: swagger-cli bundle --dereference
-        |                    Merge all: @redocly/cli join → merged_openapi.yml
+        |                    Per-construct: in-repo dereference to merged-openapi.json
+        |                    Merge all: in-repo prefixing merge → merged_openapi.yml
         |                    Filter: cloud_openapi.yml, meshery_openapi.yml
         v
 [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
 | Build TypeScript dist        | `npm run build`                  |
 | Generate Go code only        | `make golang-generate`           |
 | Generate TS types + schemas  | `make generate-ts`               |
-| Lint OpenAPI                 | `npx @redocly/cli lint`          |
 | Schema validation (blocking) | `make validate-schemas`          |
 | Schema audit (advisory)      | `make audit-schemas`             |
 | Full schema debt report      | `make audit-schemas-debt-full`   |