Skip to content

Commit 65ee479

Browse files
docs: Update schema references to v1.2 and replace example URLs in trading-system architecture JSON
1 parent 308288c commit 65ee479

File tree

4 files changed

+17
-13
lines changed

4 files changed

+17
-13
lines changed

docs/docs/tutorials/build-a-calm-architecture/generate-documentation.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -104,16 +104,16 @@ This should generate output similar to the following and create a file called `t
104104
```text
105105
info [_TemplateProcessor]: Using SelfProvidedTemplateLoader for single template file
106106
[WidgetEngine] ⚠️ Helper 'lookup' is already registered. Skipping registration.
107-
info [_TemplateProcessor]: ✅ Output directory exists: calm-demos/build-calm-architecture
107+
info [_TemplateProcessor]: ✅ Output directory exists: /Users/jim/Desktop/calm-demos/build-calm-architecture
108108
warn [_TemplateProcessor]: ⚠️ Output directory is not empty. Any files not overwritten will remain untouched.
109109
info [_TemplateProcessor]: ℹ️ No transformer specified in index.json. Will use TemplateDefaultTransformer.
110110
info [_TemplateProcessor]: 🔁 No transformer provided. Using TemplateDefaultTransformer.
111-
info [_HttpReferenceResolver]: Fetching reference via HTTP: https://schemas.company.com/security/encryption-in-transit.json
112-
info [_CompositeReferenceResolver]: HTTP resolution failed for https://schemas.company.com/security/encryption-in-transit.json with Error: HTTP request failed for https://schemas.company.com/security/encryption-in-transit.json: getaddrinfo ENOTFOUND schemas.company.com
113-
Failed to dereference Resolvable: https://schemas.company.com/security/encryption-in-transit.json Composite resolver: Unable to resolve reference https://schemas.company.com/security/encryption-in-transit.json
114-
info [_HttpReferenceResolver]: Fetching reference via HTTP: https://schemas.company.com/security/encryption-at-rest.json
115-
info [_CompositeReferenceResolver]: HTTP resolution failed for https://schemas.company.com/security/encryption-at-rest.json with Error: HTTP request failed for https://schemas.company.com/security/encryption-at-rest.json: getaddrinfo ENOTFOUND schemas.company.com
116-
Failed to dereference Resolvable: https://schemas.company.com/security/encryption-at-rest.json Composite resolver: Unable to resolve reference https://schemas.company.com/security/encryption-at-rest.json
111+
info [_HttpReferenceResolver]: Fetching reference via HTTP: https://example.com/security/encryption-in-transit.json
112+
info [_CompositeReferenceResolver]: HTTP resolution failed for https://example.com/security/encryption-in-transit.json with Error: HTTP request failed for https://example.com/security/encryption-in-transit.json: unable to get local issuer certificate
113+
Failed to dereference Resolvable: https://example.com/security/encryption-in-transit.json Composite resolver: Unable to resolve reference https://example.com/security/encryption-in-transit.json
114+
info [_HttpReferenceResolver]: Fetching reference via HTTP: https://example.com/security/encryption-at-rest.json
115+
info [_CompositeReferenceResolver]: HTTP resolution failed for https://example.com/security/encryption-at-rest.json with Error: HTTP request failed for https://example.com/security/encryption-at-rest.json: unable to get local issuer certificate
116+
Failed to dereference Resolvable: https://example.com/security/encryption-at-rest.json Composite resolver: Unable to resolve reference https://example.com/security/encryption-at-rest.json
117117
info [_TemplateEngine]: ✅ Compiled 1 Templates
118118
info [_TemplateEngine]: 🔧 Registering Handlebars Helpers...
119119
info [_TemplateEngine]: ✅ Registered helper: eq
@@ -127,13 +127,15 @@ info [_TemplateEngine]: ✅ Registered helper: isArray
127127
info [_TemplateEngine]: ✅ Registered helper: join
128128
info [_TemplateEngine]:
129129
🔹 Starting Template Generation...
130-
info [_TemplateEngine]: ✅ Generated: calm-demos/build-calm-architecture/trading-system-sad.md
130+
info [_TemplateEngine]: ✅ Generated: /Users/jim/Desktop/calm-demos/build-calm-architecture/trading-system-sad.md
131131
info [_TemplateEngine]:
132132
✅ Template Generation Completed!
133133
info [_TemplateProcessor]:
134134
✅ Template Generation Completed!
135135
```
136136

137+
_Note_: The "HTTP resolution failed ..." messages can be ignored because "example.com" is a reserved, safe-to-use domain name created by the IANA for documentation, testing, and educational purposes. It serves as a placeholder in tutorials and technical guides, allowing users to illustrate web addresses or email configurations without using real, active domains. It is not a real website.
138+
137139
---
138140

139141
These are screenshots of portions of the generated markdown document.
-432 KB
Loading
-2 KB
Loading

docs/static/calm-example/trading-system.architecture.json

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"$schema": "https://calm.finos.org/release/1.1/meta/calm.json",
2+
"$schema": "https://calm.finos.org/release/1.2/meta/calm.json",
33
"unique-id": "trading-system",
44
"name": "Trading System",
55
"description": "An event-driven trading system architecture supporting order submission, account management, position tracking, and real-time trade processing",
@@ -8,7 +8,7 @@
88
"description": "All data transmitted between system components must be encrypted using TLS 1.3 or higher with modern cipher suites, validated certificates, and mutual TLS recommended for service-to-service communication",
99
"requirements": [
1010
{
11-
"requirement-url": "https://schemas.company.com/security/encryption-in-transit.json",
11+
"requirement-url": "https://example.com/security/encryption-in-transit.json",
1212
"config": {
1313
"protocol": "TLS",
1414
"minimumVersion": "1.3",
@@ -27,7 +27,7 @@
2727
"description": "All stored data must be encrypted at rest using AES-256 equivalent encryption with hardware-backed or managed key systems, regular key rotation every 90 days, applying to databases, file systems, object storage, and backups",
2828
"requirements": [
2929
{
30-
"requirement-url": "https://schemas.company.com/security/encryption-at-rest.json",
30+
"requirement-url": "https://example.com/security/encryption-at-rest.json",
3131
"config": {
3232
"encryptionAlgorithm": "AES-256",
3333
"keyManagement": "hardware-backed",
@@ -422,7 +422,9 @@
422422
"relationship-type": {
423423
"interacts": {
424424
"actor": "trader",
425-
"nodes": ["web-gui"]
425+
"nodes": [
426+
"web-gui"
427+
]
426428
}
427429
}
428430
},
@@ -965,4 +967,4 @@
965967
]
966968
}
967969
]
968-
}
970+
}

0 commit comments

Comments
 (0)