-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
134 lines (124 loc) · 3.54 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
openapi: 3.0.2
################################################################################
# API Information #
################################################################################
info:
title: jrc-node server api spec
description: "OpenAPI specification for the blockchain server backend for jrc-node"
license:
name: MIT
url: https://opensource.org/licenses/mit-license.php
version: 0.0.1-SNAPSHOT
externalDocs:
description: Full Documentation
url: https://github.com/jounaidr/jrc-node
################################################################################
# API Endpoint Definitions #
################################################################################
paths:
### Blockchain ###
/blockchain:
get:
summary: Get the full blockchain
operationId: getBlockchain
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Blockchain'
/blockchain/lastblock:
get:
summary: Get the last block in the blockchain
operationId: getLastBlock
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BlockModel'
/blockchain/addblock:
post:
summary: Attempt to add a new block to the blockchain
operationId: addBlock
responses:
200:
description: successful operation
content:
application/json:
schema:
type: object
400:
description: block is not valid
content:
application/json:
schema:
type: object
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BlockModel'
description: Block to be added
required: true
/blockchain/size:
get:
summary: Get the blockchain length
operationId: getBlockchainSize
responses:
200:
description: successful operation
content:
application/json:
schema:
type: integer
/peers:
get:
summary: Get the nodes socket list
operationId: getSocketsList
responses:
200:
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/Peers'
################################################################################
# Model Definitions #
################################################################################
components:
schemas:
Blockchain:
type: array
items:
$ref: '#/components/schemas/BlockModel'
BlockModel:
type: object
properties:
hash:
type: string
previousHash:
type: string
data:
type: string
timeStamp:
type: string
nonce:
type: string
difficulty:
type: string
proofOfWork:
type: string
Peers:
type: array
items:
$ref: '#/components/schemas/PeerModel'
PeerModel:
type: object
properties:
peerSocket:
type: string
peerStatus:
type: string