4d3028da0c
**Motivations:** - Aligner la doc API du dashboard avec les évolutions (pagination serveur, base SQLite, frais, mining, hash, UTXO, etc.) - Documenter le paramètre skipIfExists de l'API d'ancrage - Corriger les références /health pour le dashboard (utiliser /api/blockchain/info) **Root causes:** - N/A (évolution documentation) **Correctifs:** - N/A **Evolutions:** - Section API Dashboard dans api-docs.html ; endpoints utxo/count, utxo/list (pagination, category), utxo/fees, fees/update, hash/list, hash/generate, mining, transactions, anchor/example - Paramètre skipIfExists et réponses old: true/false pour POST /api/anchor/document - DASHBOARD.md : liste endpoints à jour, tests sans /health - DOMAINS_AND_PORTS.md : tests dashboard via /api/blockchain/info - features/dashboard-api-docs-update.md **Pages affectées:** - signet-dashboard/public/api-docs.html - docs/DASHBOARD.md - docs/DOMAINS_AND_PORTS.md - features/dashboard-api-docs-update.md - api-anchorage/src/bitcoin-rpc.js, bitcoin-rpc.js.backup - data/sync-utxos.log - fixKnowledge/api-anchorage-null-includes-error.md, api-anchorage-rbf-replacement-error.md
63 lines
3.2 KiB
Markdown
63 lines
3.2 KiB
Markdown
# Mise à jour documentation API Dashboard
|
||
|
||
**Auteur :** Équipe 4NK
|
||
**Date :** 2026-01-28
|
||
**Version :** 1.0
|
||
|
||
## Objectif
|
||
|
||
Aligner la documentation API du Dashboard avec les évolutions récentes : pagination serveur, base SQLite, compteurs UTXO, frais, mining, transactions, hash, ancrage. Inclure le paramètre `skipIfExists` de l’API d’ancrage.
|
||
|
||
## Impacts
|
||
|
||
- **api-docs.html** : Section « API Dashboard », nouveaux endpoints, paramètres et réponses corrigés.
|
||
- **DASHBOARD.md** : Liste des endpoints internes/externes à jour, vérification du service sans `/health`, description des pages Hash/UTXO.
|
||
- **DOMAINS_AND_PORTS.md** : Tests de connectivité Dashboard utilisent `/api/blockchain/info` au lieu de `/health`.
|
||
|
||
## Modifications
|
||
|
||
### `signet-dashboard/public/api-docs.html`
|
||
|
||
- Nouvelle section **API Dashboard** (intro, base URL, pas d’auth).
|
||
- **GET /api/utxo/count** : documenté.
|
||
- **GET /api/utxo/list** : pagination (`page`, `limit`), `category` (all | bloc_rewards | ancrages | changes | fees), réponses `category=all` vs données paginées, `pagination`, `counts`.
|
||
- **GET /api/utxo/fees**, **POST /api/utxo/fees/update** : documentés.
|
||
- **GET /api/hash/list** : pagination, format réponse.
|
||
- **POST /api/hash/generate** : `text` | `fileContent`, `isBase64`.
|
||
- **GET /api/mining/difficulty**, **GET /api/mining/avg-block-time** : documentés.
|
||
- **GET /api/transactions/avg-fee**, **GET /api/transactions/avg-amount** : documentés.
|
||
- **GET /api/anchor/example** : documenté.
|
||
- **Base URLs** : Dashboard ajouté, précision que `/health` n’est pas sur le Dashboard.
|
||
- **POST /api/anchor/document** : paramètre `skipIfExists` (boolean, défaut false), réponses avec `old: true/false`, exemple « hash déjà ancré », encadré « skipIfExists ».
|
||
|
||
### `docs/DASHBOARD.md`
|
||
|
||
- **API Endpoints Utilisés** : liste complète des endpoints internes (blockchain, wallet, network, utxo, hash, mining, transactions, anchor).
|
||
- Précision : Dashboard n’expose pas `/health` ; utiliser `GET /api/blockchain/info` pour vérifier.
|
||
- **Maintenance** : `curl` de test remplacé par `GET /api/blockchain/info`.
|
||
- **Page Documentation API** : mention des endpoints Dashboard documentés.
|
||
- **Page Liste des Hash** : source `GET /api/hash/list`, pagination.
|
||
- **Page Liste des UTXO** : pagination par catégorie, bouton « Récupérer les frais » + `POST /api/utxo/fees/update`.
|
||
- Version 1.1, date 2026-01-28.
|
||
|
||
### `docs/DOMAINS_AND_PORTS.md`
|
||
|
||
- Tests de connectivité Dashboard : `curl` vers `/api/blockchain/info` au lieu de `/health`, avec note.
|
||
|
||
## Modalités de déploiement
|
||
|
||
Aucun déploiement applicatif. Les fichiers modifiés sont statiques (HTML) ou documentation (Markdown). Redéploiement du front Dashboard si nécessaire pour servir `api-docs.html` à jour.
|
||
|
||
## Modalités d’analyse
|
||
|
||
- Vérifier que `api-docs.html` décrit correctement les endpoints et paramètres en les comparant à `signet-dashboard/src/server.js`.
|
||
- Vérifier que les exemples curl et réponses JSON sont cohérents avec l’implémentation.
|
||
- Confirmer que les tests `curl` du Dashboard (DASHBOARD.md, DOMAINS_AND_PORTS.md) fonctionnent.
|
||
|
||
## Pages affectées
|
||
|
||
- `signet-dashboard/public/api-docs.html`
|
||
- `docs/DASHBOARD.md`
|
||
- `docs/DOMAINS_AND_PORTS.md`
|
||
- `features/dashboard-api-docs-update.md` (ce fichier)
|