| --- |
| license: other |
| license_name: camara |
| license_link: https://camaraproject.org/ |
| language: |
| - en |
| pretty_name: CAMARA Network APIs |
| tags: |
| - telecommunications |
| - camara |
| - api |
| - open-telco |
| --- |
| |
| # CAMARA source mirror |
|
|
| > Part of the **[Open-Telco Telecom Standards Corpus](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf)**. |
| > Sibling mirrors: [3GPP](https://huggingface.co/datasets/GSMA/3GPP) · [ETSI](https://huggingface.co/datasets/GSMA/etsi) · [ITU-T](https://huggingface.co/datasets/GSMA/itu) · [O-RAN](https://huggingface.co/datasets/GSMA/oran) · [GSMA](https://huggingface.co/datasets/GSMA/gsma) · [TM Forum](https://huggingface.co/datasets/GSMA/tmforum) · **CAMARA** |
|
|
| 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. |
|
|
| ```text |
| camara/ |
| original/ # API definitions as published, by API |
| ConsentManagement/ ConnectivityInsights/ ... |
| marked/ # Markdown mirror of original/, same paths |
| ConsentManagement/.../raw.md |
| manifest.jsonl # one row per file: path, sha256, parse status |
| STATUS.md # parse-coverage summary |
| ``` |
|
|
| ## How it is organized |
|
|
| - `original/` holds the API definitions as CAMARA published them (OpenAPI YAML and supporting docs), grouped by API family (one folder per API, such as ConsentManagement and ConnectivityInsights). |
| - `marked/` is the Markdown twin of `original/` at identical paths, one `raw.md` per document. |
| - `manifest.jsonl` carries one row per file (path, SHA-256, parse status); `STATUS.md` reports parse coverage. |
|
|
| ## How to use |
|
|
| Pull only the Markdown twins (skip the heavy `original/` tree) and read them straight: |
|
|
| ```python |
| from huggingface_hub import snapshot_download |
| |
| path = snapshot_download("GSMA/camara", repo_type="dataset", allow_patterns="marked/**") |
| # every parsed document is a marked/**/raw.md |
| ``` |
|
|
| ## The corpus |
|
|
| This dataset is part of the **Open-Telco Telecom Standards Corpus**, an effort to make telecommunications open by mirroring every major standards body into clean, machine-readable Markdown. The full set: 3GPP, ETSI, ITU-T, O-RAN, GSMA, TM Forum, and CAMARA. Browse them all in the [collection](https://huggingface.co/collections/GSMA/telecom-standards-corpus-6a432dc598fc32729754fecf). |
|
|
| ## License and attribution |
|
|
| The mirrored documents remain the property of the CAMARA Project and stay subject to its terms; see [camaraproject.org](https://camaraproject.org/). This dataset reproduces them in original and Markdown form for research, search, and retrieval. Cite the underlying API definition by its CAMARA name when you use it. |
|
|
