@carrot-foundation/schemas 0.1.15 → 0.1.20
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 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,18 +2,19 @@
|
|
|
2
2
|
|
|
3
3
|
This repository contains all JSON Schemas used across the Carrot ecosystem.
|
|
4
4
|
|
|
5
|
-
These schemas define the structure of IPFS metadata for tokenized assets.
|
|
5
|
+
These schemas define the structure of IPFS metadata for tokenized assets and other schemas.
|
|
6
|
+
|
|
6
7
|
They are versioned, publicly referenceable, and used for validation, traceability, and frontend/backend integration.
|
|
7
8
|
|
|
8
9
|
## 📦 Structure
|
|
9
10
|
|
|
10
11
|
- Schemas are organized by type (e.g., `mass-id`, `gas-id`, `shared`) and follow [Semantic Versioning](https://semver.org/), but folder names are not versioned.
|
|
11
12
|
- Each schema lives in its own folder and includes an `example.json` for testing and documentation.
|
|
12
|
-
- Shared components
|
|
13
|
+
- Shared components are located in `src/shared/**`.
|
|
13
14
|
|
|
14
15
|
## 🔖 Versioning
|
|
15
16
|
|
|
16
|
-
- Schemas are versioned using
|
|
17
|
+
- Schemas are versioned using isolated versioning; each schema can evolve independently.
|
|
17
18
|
- For released versions, each schema’s `$id` must point to the tagged raw URL to remain immutable.
|
|
18
19
|
- During development on `main`, `$id` may reference `refs/heads/main`, but consumers should pin to tags in production.
|
|
19
20
|
- Keep `$ref` paths relative; they resolve against the `$id` base (the tag) at validation time.
|