chore(release): cut 1.1.0 (docs updated, changelog aligned)
Some checks failed
CI - 4NK Node / Code Quality (push) Failing after 38s
CI - 4NK Node / Unit Tests (push) Failing after 36s
CI - 4NK Node / Integration Tests (push) Successful in 33s
CI - 4NK Node / Security Tests (push) Failing after 33s
CI - 4NK Node / Docker Build & Test (push) Failing after 16s
CI - 4NK Node / Documentation Tests (push) Successful in 11s
CI - 4NK Node / Performance Tests (push) Successful in 33s
CI - 4NK Node / Notify (push) Failing after 1s
Some checks failed
CI - 4NK Node / Code Quality (push) Failing after 38s
CI - 4NK Node / Unit Tests (push) Failing after 36s
CI - 4NK Node / Integration Tests (push) Successful in 33s
CI - 4NK Node / Security Tests (push) Failing after 33s
CI - 4NK Node / Docker Build & Test (push) Failing after 16s
CI - 4NK Node / Documentation Tests (push) Successful in 11s
CI - 4NK Node / Performance Tests (push) Successful in 33s
CI - 4NK Node / Notify (push) Failing after 1s
This commit is contained in:
parent
dcfb1fcde3
commit
a85c7a2147
@ -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/),
|
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).
|
et ce projet adhère au [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
## [Unreleased]
|
## [1.1.0] - 2025-08-26
|
||||||
|
|
||||||
### Added
|
### 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
|
- Script d’amorçage `scripts/bootstrap.sh` pour installer git, Docker, Docker Compose, Node.js/npm (nvm) et ajouter l’utilisateur au groupe docker
|
||||||
|
38
docs/API.md
38
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
|
- **Blindbit HTTP** : API REST pour les paiements silencieux
|
||||||
- **SDK Relay WebSocket** : Interface temps réel pour les clients
|
- **SDK Relay WebSocket** : Interface temps réel pour les clients
|
||||||
- **SDK Relay HTTP** : API REST pour les opérations de gestion
|
- **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
|
## 1. API Bitcoin Core RPC
|
||||||
|
|
||||||
@ -179,7 +180,7 @@ curl -X GET http://localhost:8000/health
|
|||||||
{
|
{
|
||||||
"status": "healthy",
|
"status": "healthy",
|
||||||
"timestamp": "2024-12-19T14:30:00Z",
|
"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": {
|
"data": {
|
||||||
"relay_id": "relay-1",
|
"relay_id": "relay-1",
|
||||||
"state": "running",
|
"state": "running",
|
||||||
"version": "1.0.0",
|
"version": "1.1.0",
|
||||||
"uptime": 3600
|
"uptime": 3600
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -471,7 +472,7 @@ curl -X GET http://localhost:8091/health
|
|||||||
"status": "healthy",
|
"status": "healthy",
|
||||||
"relay_id": "relay-1",
|
"relay_id": "relay-1",
|
||||||
"uptime": 3600,
|
"uptime": 3600,
|
||||||
"version": "1.0.0",
|
"version": "1.1.0",
|
||||||
"connected_relays": 3
|
"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://<hôte>/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
|
### Erreurs WebSocket
|
||||||
|
|
||||||
|
@ -294,7 +294,7 @@ Questions fréquemment posées.
|
|||||||
|
|
||||||
### Dernière Mise à Jour
|
### Dernière Mise à Jour
|
||||||
- **Date** : $(date)
|
- **Date** : $(date)
|
||||||
- **Version** : 1.0.0
|
- **Version** : 1.1.0
|
||||||
- **Auteur** : Équipe 4NK
|
- **Auteur** : Équipe 4NK
|
||||||
|
|
||||||
### Historique des Versions
|
### Historique des Versions
|
||||||
|
Loading…
x
Reference in New Issue
Block a user