From 8bc8083dfff0e69d6fc0eb8923680cf9c25f8aa9 Mon Sep 17 00:00:00 2001 From: hunteryavitz Date: Tue, 7 Nov 2023 20:23:56 -0700 Subject: [PATCH] feat: cleaned up changelog and readme --- CHANGELOG.md | 2 +- README.md | 53 ++++++++++++++++++++++++++++++++-------------------- SCRATCH.md | 11 ----------- 3 files changed, 34 insertions(+), 32 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d528faa..ea6f5fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ Unreleased *v0.0.17* -**11/3/23** +**11/7/23** - [ADD Nodes Health Check Service and Endpoint](#54) diff --git a/README.md b/README.md index 91623a3..b5b1b4a 100644 --- a/README.md +++ b/README.md @@ -29,47 +29,60 @@ mvn javadoc:javadoc ## Endpoints The current serviceable endpoints are as follows: -### Verify Blockchain +### GET http://localhost:8080/api/v1/blockchain/verifyBlockchain -### Get Blockchain +### GET http://localhost:8080/api/v1/blockchain/getBlockchain -### Get Block By Id +### GET http://localhost:8080/api/v1/blockchain/getBlockById -### Add Block to Blockchain +### POST http://localhost:8080/api/v1/block/addBlockToBlockchain +Content-Type: application/x-www-form-urlencoded -### Update Production -GET http://localhost:8080/api/v1/healthMetric/updateProduction +### +GET http://localhost:8080/api/v1/healthMetric/updateProductionHealth -### Get Production +### GET http://localhost:8080/api/v1/healthMetric/getProductionHealth -### Get Node Network Status -GET http://localhost:8080/api/v1/healthMetric/getNodeNetworkStatus +### +GET http://localhost:8080/api/v1/healthMetric/getExceptionHealth -### Get Health -GET http://localhost:8080/api/v1/healthMetric/health - -### Get Readiness +### GET http://localhost:8080/api/v1/readiness -### Get Liveness +### GET http://localhost:8080/api/v1/liveness -### Get Version +### GET http://localhost:8080/api/v1/version -### Verify Blockchain -GET http://localhost:8080/api/v1/verifyBlockchain +### +GET http://localhost:8080/api/v1/node/getNodeStatus + +### +POST http://localhost:8080/api/v1/nodeManager/registerNode +Content-Type: application/json + +{} -### Submit Transaction +### +GET http://localhost:8080/api/v1/nodeManager/getNodeNetworkStatus + +### +GET http://localhost:8080/api/v1/nodeManager/nodeNetworkRollCall + +### POST http://localhost:8080/api/v1/transaction/submitTransaction +Content-Type: application/json + +{} -### Get Transaction Pool -GET /api/v1/transaction/getTransactionPool +### +GET http://localhost:8080/api/v1/transaction/getTransactionPool --- diff --git a/SCRATCH.md b/SCRATCH.md index ec02cba..e69de29 100644 --- a/SCRATCH.md +++ b/SCRATCH.md @@ -1,11 +0,0 @@ -### Get Production Payload - -```json - -{ - "data": { - "dataset1": [5, 13, 23, 24, 12, 8, 5, 0, 0, 0, 0, 0], - "dataset2": [1, 1, 3, 2, 1, 1, 1, 0, 0, 0, 0, 0 ] - } -} -``` \ No newline at end of file