Skip to content

Commit

Permalink
feat: cleaned up changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hunteryavitz committed Nov 8, 2023
1 parent f4c0244 commit 8bc8083
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 32 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Unreleased

*v0.0.17*

**11/3/23**
**11/7/23**

- [ADD Nodes Health Check Service and Endpoint](#54)

Expand Down
53 changes: 33 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

---

Expand Down
11 changes: 0 additions & 11 deletions SCRATCH.md
Original file line number Diff line number Diff line change
@@ -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 ]
}
}
```

0 comments on commit 8bc8083

Please sign in to comment.