@meshery/schemas 1.2.0 → 1.2.1
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 +4 -0
- package/dist/cloudApi.d.mts +1436 -1436
- package/dist/cloudApi.d.ts +1436 -1436
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/mesheryApi.d.mts +546 -546
- package/dist/mesheryApi.d.ts +546 -546
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -48,6 +48,8 @@ Meshery schemas offer a powerful system designed for:
|
|
|
48
48
|
|
|
49
49
|
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).
|
|
50
50
|
|
|
51
|
+
For identifier-naming rules (wire casing, DB tag separation, URL/path/query-param conventions, operationId form), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md) — the canonical, reader-friendly directory for the camelCase-on-the-wire contract that this repository and every downstream consumer share.
|
|
52
|
+
|
|
51
53
|
## Contributing
|
|
52
54
|
--> **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).**
|
|
53
55
|
|
|
@@ -292,6 +294,8 @@ post:
|
|
|
292
294
|
|
|
293
295
|
## Naming Conventions
|
|
294
296
|
|
|
297
|
+
> This section is the inline authority; for the reader-friendly directory (26-row naming table with before/after and do/don't examples), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md).
|
|
298
|
+
|
|
295
299
|
- Property names
|
|
296
300
|
- Use camelCase for property fields (e.g., `schemaVersion`, `displayName`, `componentsCount`).
|
|
297
301
|
- Identifier fields use lowerCamelCase with "Id" suffix (e.g., `modelId`, `registrantId`, `categoryId`).
|