# telco-vision/ocs-api architecture

> Architecture diagram of the GitHub repository telco-vision/ocs-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/telco-vision/ocs-api
- Repository: https://github.com/telco-vision/ocs-api

## Overview

This is a documentation-only repository for the Telco-vision OCS public API, not an implementation of the API. Its visible structure separates versioned API references and includes v1 object and customer-notification references plus PICS documentation. The tree and README do not reveal endpoint behavior, request flows, or links between these documents, so the graph shows only the documented surface and reader access.

Main entry points: [`doc/v1/API.md`](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/API.md) (API reference), [`doc/v1/OcsObjects.md`](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/OcsObjects.md) (OCS objects), [`doc/v1/customer_notification.md`](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/customer_notification.md) (Customer notifications), [`doc/v1/pics`](https://github.com/telco-vision/ocs-api/tree/main/doc/v1/pics) (PICS)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_v1_docs["Version 1 docs"]
  node_v1_api["API reference<br/>[API.md]"]
  node_ocs_objects["OCS objects<br/>[OcsObjects.md]"]
  node_customer_notification["Customer notifications"]
  node_pics["PICS"]
end

subgraph group_v2_docs["Version 2 docs"]
  node_v2_api["API reference<br/>[API.md]"]
end

node_api_reader(("API reader"))

node_api_reader -->|"consults"| node_v1_api
node_api_reader -->|"consults"| node_ocs_objects
node_api_reader -->|"consults"| node_customer_notification
node_api_reader -->|"consults"| node_pics
node_api_reader -->|"consults"| node_v2_api

click node_v1_api "https://github.com/telco-vision/ocs-api/blob/main/doc/v1/API.md"
click node_ocs_objects "https://github.com/telco-vision/ocs-api/blob/main/doc/v1/OcsObjects.md"
click node_customer_notification "https://github.com/telco-vision/ocs-api/blob/main/doc/v1/customer_notification.md"
click node_pics "https://github.com/telco-vision/ocs-api/tree/main/doc/v1/pics"
click node_v2_api "https://github.com/telco-vision/ocs-api/blob/main/doc/v2/API.md"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_v1_api,node_ocs_objects,node_customer_notification,node_pics toneBlue
class node_v2_api toneAmber
class node_api_reader toneMint
```

## Components

### Version 1 docs

- [API reference](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/API.md): `doc/v1/API.md`
- [OCS objects](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/OcsObjects.md): `doc/v1/OcsObjects.md`
- [Customer notifications](https://github.com/telco-vision/ocs-api/blob/main/doc/v1/customer_notification.md): `doc/v1/customer_notification.md`
- [PICS](https://github.com/telco-vision/ocs-api/tree/main/doc/v1/pics): `doc/v1/pics`

### Version 2 docs

- [API reference](https://github.com/telco-vision/ocs-api/blob/main/doc/v2/API.md): `doc/v2/API.md`

### Other components

- **API reader**

## Connections

- API reader → API reference: consults
- API reader → OCS objects: consults
- API reader → Customer notifications: consults
- API reader → PICS: consults
- API reader → API reference: consults