docs: README file-map for v2.0-only layout (apis/ + components/)
Browse files
README.md
CHANGED
|
@@ -11,14 +11,16 @@ tags:
|
|
| 11 |
|
| 12 |
# TM Forum source mirror
|
| 13 |
|
| 14 |
-
This dataset
|
| 15 |
|
| 16 |
```text
|
| 17 |
tmforum/
|
| 18 |
-
original/
|
| 19 |
-
|
| 20 |
-
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
|
|
|
|
|
|
| 24 |
```
|
|
|
|
| 11 |
|
| 12 |
# TM Forum source mirror
|
| 13 |
|
| 14 |
+
This dataset holds TM Forum's Open API specifications and ODA component definitions, the set TM Forum publishes for open digital architecture. Every source is kept twice: `original/` is the file as TM Forum released it (`apis/` holds the OpenAPI and Swagger specs, `components/` holds the ODA component YAML), and `marked/` is that same file converted to Markdown for search and retrieval, one `raw.md` per file at the matching path. `manifest.jsonl` carries one row per file (path, SHA-256, parse status) and `STATUS.md` reports how much of the corpus has been parsed.
|
| 15 |
|
| 16 |
```text
|
| 17 |
tmforum/
|
| 18 |
+
original/
|
| 19 |
+
apis/ # OpenAPI / Swagger specs (TMF6xx, TMF9xx)
|
| 20 |
+
components/ # ODA component definitions (TMFC0xx)
|
| 21 |
+
marked/ # Markdown mirror of original/, same paths
|
| 22 |
+
apis/<spec>/raw.md
|
| 23 |
+
components/<component>/raw.md
|
| 24 |
+
manifest.jsonl # one row per file: path, sha256, parse status
|
| 25 |
+
STATUS.md # parse-coverage summary
|
| 26 |
```
|