Skip to content

Commit d215a3e

Browse files
authored
Define media type for CSN Interop (#102)
* 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>
1 parent a19636b commit d215a3e

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ title: "Overview"
1010

1111
## Summary
1212

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.
1415

1516
A CSN Interop file can look like this (extracted from [./examples/airline.json](./spec-v1/examples/airline.md)):
1617

@@ -49,8 +50,6 @@ The actual specification is described mostly in the [formal interface documentat
4950

5051
## What is CSN Interop Effective?
5152

52-
For now, we describe the [CSN](#csn) [Interoperability](#interoperability) [Effective](#effective) exchange format.
53-
5453
### CSN
5554

5655
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:
7978

8079
Right now, this spec describes only the [effective](./spec-v1/csn-interop-effective) feature dimension.
8180

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.
8382

8483
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.
8584

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+
8691
## Intended Audience
8792

8893
- Developers and Architects that either need to export or import CSN across different technology stacks.

0 commit comments

Comments
 (0)