# yannlombard/cyclocity-api-doc architecture

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

- Interactive diagram: https://gitdiagram.com/yannlombard/cyclocity-api-doc
- Repository: https://github.com/yannlombard/cyclocity-api-doc

## Overview

This repository is community-maintained API documentation, not an API client or server. Its main user workflow is to consult the README, then use the OpenAPI description or Postman collection to make Cyclocity requests. The README documents public station and bike queries, plus authenticated account workflows that use Keycloak identity tokens. The graph covers these documented artifacts and external services; no source excerpts were provided, so it does not infer internal implementation or undocumented links.

Main entry points: [`cyclocity.postman_collection.json`](https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.postman_collection.json) (Postman collection), [`README.md`](https://github.com/yannlombard/cyclocity-api-doc/blob/main/README.md) (Usage guide), [`cyclocity.openapi.yaml`](https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.openapi.yaml) (OpenAPI spec)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_documentation["API documentation"]
  node_readme["Usage guide<br/>[README.md]"]
  node_openapi["OpenAPI spec"]
  node_postman["Postman collection"]
end

subgraph group_services["External services"]
  node_cyclocity["Cyclocity API"]
  node_keycloak["Keycloak identity"]
  node_gbfs["GBFS open data"]
end

node_developer(("API developer"))

node_developer -->|"consults"| node_readme
node_developer -->|"imports spec"| node_openapi
node_developer -->|"imports collection"| node_postman
node_postman -->|"sends requests"| node_cyclocity
node_developer -->|"queries public data"| node_cyclocity
node_developer -->|"authenticates account"| node_keycloak
node_developer -->|"uses identity token"| node_cyclocity
node_developer -->|"reads station data"| node_gbfs

click node_readme "https://github.com/yannlombard/cyclocity-api-doc/blob/main/README.md"
click node_openapi "https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.openapi.yaml"
click node_postman "https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.postman_collection.json"

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_readme,node_openapi,node_postman toneBlue
class node_cyclocity,node_keycloak,node_gbfs toneAmber
class node_developer toneMint
```

## Components

### API documentation

- [Usage guide](https://github.com/yannlombard/cyclocity-api-doc/blob/main/README.md): `README.md`
- [OpenAPI spec](https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.openapi.yaml): `cyclocity.openapi.yaml`
- [Postman collection](https://github.com/yannlombard/cyclocity-api-doc/blob/main/cyclocity.postman_collection.json): `cyclocity.postman_collection.json`

### External services

- **Cyclocity API**
- **Keycloak identity**
- **GBFS open data**

### Other components

- **API developer**

## Connections

- API developer → Usage guide: consults (evidence: `README.md`)
- API developer → OpenAPI spec: imports spec (evidence: `README.md`)
- API developer → Postman collection: imports collection (evidence: `README.md`)
- Postman collection → Cyclocity API: sends requests (evidence: `README.md`)
- API developer → Cyclocity API: queries public data (evidence: `README.md`)
- API developer → Keycloak identity: authenticates account (evidence: `README.md`)
- API developer → Cyclocity API: uses identity token (evidence: `README.md`)
- API developer → GBFS open data: reads station data (evidence: `README.md`)
