You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Mention that ER references are to-one cardinality only
Signed-off-by: Simon Heimler <simon.heimler@sap.com>
* Define CSN Interop media type
Signed-off-by: Simon Heimler <simon.heimler@sap.com>
---------
Signed-off-by: Simon Heimler <simon.heimler@sap.com>
Copy file name to clipboardExpand all lines: docs/index.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,8 @@ title: "Overview"
10
10
11
11
## Summary
12
12
13
-
Core Schema Notation Interoperability (short: CSN Interop) is a powerful and flexible format used to describe entity and service models in the wider SAP and BTP ecosystem. CSN files are JSON-based and provide comprehensive metadata about entities and their structure, relationships, and other aspects of the model.
13
+
Core Schema Notation Interoperability (short: CSN Interop) is a modeling format to describe entity and service models in the wider SAP and BTP ecosystem.
14
+
CSN files serialized as JSON and provide comprehensive metadata about entities and their structure, relationships, and other aspects of the model.
14
15
15
16
A CSN Interop file can look like this (extracted from [./examples/airline.json](./spec-v1/examples/airline.md)):
16
17
@@ -49,8 +50,6 @@ The actual specification is described mostly in the [formal interface documentat
49
50
50
51
## What is CSN Interop Effective?
51
52
52
-
For now, we describe the [CSN](#csn)[Interoperability](#interoperability)[Effective](#effective) exchange format.
53
-
54
53
### CSN
55
54
56
55
Core Schema Notation (CSN, pronounced as "Season") is a JSON based serialization format for Core Data Services (CDS) models that can be used to describe domain, data and service models (and more) on a _conceptual_ level, with rich semantics and annotations.
@@ -79,10 +78,16 @@ This includes:
79
78
80
79
Right now, this spec describes only the [effective](./spec-v1/csn-interop-effective) feature dimension.
81
80
82
-
Effective means that the format is "[denormalized](https://en.wikipedia.org/wiki/Denormalization)", and optimized towards easy consumption by machines, with the tradeoff of more verbosity and duplicated information.
81
+
Effective means that the format is [denormalized](https://en.wikipedia.org/wiki/Denormalization), and optimized towards easy consumption by machines, with the tradeoff of more verbosity and duplicated information.
83
82
84
83
Information reuse concepts like aspects have already been resolved, applied and cleaned up. What the consumer gets, is a document that does not require further post-processing / logic to be interpreted correctly. This is a tradeoff, prioritizing easy consumption over convenient creation.
85
84
85
+
### Serialization
86
+
87
+
A CSN Interop file is serialized as [JSON](https://www.json.org/json-en.html).
88
+
89
+
The correct media type for CSN Interop files is either `application/json` (because it is a valid JSON file) or `application/csn-interop+json` if you want to be more specific about the content type.
90
+
86
91
## Intended Audience
87
92
88
93
- Developers and Architects that either need to export or import CSN across different technology stacks.
0 commit comments