From a85c7a2147641b07d6242866e05739f0b3788744 Mon Sep 17 00:00:00 2001 From: Debian Date: Tue, 26 Aug 2025 12:03:40 +0000 Subject: [PATCH] chore(release): cut 1.1.0 (docs updated, changelog aligned) --- CHANGELOG.md | 2 +- docs/API.md | 38 ++++++++++++++++++++++++++++++++++---- docs/INDEX.md | 2 +- 3 files changed, 36 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 272192a2..fb9dbc87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ Tous les changements notables de ce projet seront documentés dans ce fichier. Le format est basé sur [Keep a Changelog](https://keepachangelog.com/fr/1.0.0/), et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] +## [1.1.0] - 2025-08-26 ### Added - Script d’amorçage `scripts/bootstrap.sh` pour installer git, Docker, Docker Compose, Node.js/npm (nvm) et ajouter l’utilisateur au groupe docker diff --git a/docs/API.md b/docs/API.md index 39cf1143..8fa8e76d 100644 --- a/docs/API.md +++ b/docs/API.md @@ -10,6 +10,7 @@ L'infrastructure 4NK Node expose plusieurs interfaces pour différents types d'i - **Blindbit HTTP** : API REST pour les paiements silencieux - **SDK Relay WebSocket** : Interface temps réel pour les clients - **SDK Relay HTTP** : API REST pour les opérations de gestion + - **SDK Storage HTTP** : API REST de stockage clé/valeur TTL ## 1. API Bitcoin Core RPC @@ -179,7 +180,7 @@ curl -X GET http://localhost:8000/health { "status": "healthy", "timestamp": "2024-12-19T14:30:00Z", - "version": "1.0.0" + "version": "1.1.0" } ``` @@ -325,7 +326,7 @@ Tous les messages suivent le format JSON suivant : "data": { "relay_id": "relay-1", "state": "running", - "version": "1.0.0", + "version": "1.1.0", "uptime": 3600 } } @@ -471,7 +472,7 @@ curl -X GET http://localhost:8091/health "status": "healthy", "relay_id": "relay-1", "uptime": 3600, - "version": "1.0.0", + "version": "1.1.0", "connected_relays": 3 } ``` @@ -571,7 +572,36 @@ Force une synchronisation manuelle. } ``` -## 5. Gestion des Erreurs +## 5. API SDK Storage HTTP + +### Informations générales + +- **Protocole :** HTTP REST +- **Port interne :** 8081 (proxifié) +- **Base URL via proxy :** `https:///storage/` +- **Content-Type :** `application/json` + +### Endpoints + +#### POST /storage/store +Corps JSON : `{ key: string(hex64), value: string(hex), ttl?: number(seconds) }` + +Réponses : +- 200 OK : `{ "message": "Data stored successfully." }` +- 400/409 : message d’erreur explicite + +#### GET /storage/retrieve/{key} +Paramètre `key` : hex 64 caractères. + +Réponses : +- 200 OK : `{ key, value }` avec `value` en hex +- 400/404 : message d’erreur + +Notes : +- Sans `ttl`, si l’application est lancée avec `--permanent`, la donnée est permanente; sinon TTL par défaut 86400s. +- Les données sont stockées sur volume persistant `sdk_storage_data`. + +## 6. Gestion des Erreurs ### Erreurs WebSocket diff --git a/docs/INDEX.md b/docs/INDEX.md index 6b2ea466..5e8203cb 100644 --- a/docs/INDEX.md +++ b/docs/INDEX.md @@ -294,7 +294,7 @@ Questions fréquemment posées. ### Dernière Mise à Jour - **Date** : $(date) -- **Version** : 1.0.0 +- **Version** : 1.1.0 - **Auteur** : Équipe 4NK ### Historique des Versions