docs: short README (structure overview + file-map)
Browse files
README.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: other
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
tags:
|
| 6 |
+
- camara
|
| 7 |
+
- telecom
|
| 8 |
+
- api
|
| 9 |
+
---
|
| 10 |
+
|
| 11 |
+
# CAMARA source mirror
|
| 12 |
+
|
| 13 |
+
This dataset mirrors the CAMARA project's network APIs. Every source is kept twice: `original/` is the API definition as CAMARA published it (OpenAPI YAML and supporting docs), and `marked/` is that same file converted to Markdown for search and retrieval, one `raw.md` per document. The two trees share identical paths, so a file in `original/` has a parsed twin at the matching path under `marked/`; both are grouped by CAMARA API family, one folder per API (such as ConsentManagement and CarrierBillingCheckOut). `manifest.jsonl` carries one row per file (path, SHA-256, parse status), and `STATUS.md` reports how much of the corpus has been parsed.
|
| 14 |
+
|
| 15 |
+
```text
|
| 16 |
+
camara/
|
| 17 |
+
original/ # API definitions as published, by API
|
| 18 |
+
ConsentManagement/ ConnectivityInsights/ ...
|
| 19 |
+
marked/ # Markdown mirror of original/, same paths
|
| 20 |
+
ConsentManagement/.../raw.md
|
| 21 |
+
manifest.jsonl # one row per file: path, sha256, parse status
|
| 22 |
+
STATUS.md # parse-coverage summary
|
| 23 |
+
```
|