-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathopenapi.yaml
411 lines (410 loc) · 12.9 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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
# Generated with protoc-gen-openapi
# https://github.com/google/gnostic/tree/master/cmd/protoc-gen-openapi
openapi: 3.0.3
info:
title: ""
version: 0.0.1
paths:
/v1/collections:
get:
tags:
- Collection
operationId: Collection_ListCollections
parameters:
- name: tick
in: query
schema:
type: string
- name: p
in: query
schema:
type: string
- name: order_by
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: uint64
- name: offset
in: query
schema:
type: integer
format: uint64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.collection.v1.ListCollectionReply'
/v1/collections/{tick}:
get:
tags:
- Collection
operationId: Collection_GetCollection
parameters:
- name: tick
in: path
required: true
schema:
type: string
- name: p
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.collection.v1.GetCollectionReply'
/v1/inscriptions:
get:
tags:
- Inscription
operationId: Inscription_ListInscription
parameters:
- name: inscription_id
in: query
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.inscription.v1.ListInscriptionReply'
/v1/inscriptions/collection/{inscription_id}:
get:
tags:
- Collection
operationId: Collection_GetInscriptionCollection
parameters:
- name: inscription_id
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.collection.v1.GetCollectionReply'
/v1/inscriptions/token/{inscription_id}:
get:
tags:
- Token
operationId: Token_GetInscriptionToken
parameters:
- name: inscription_id
in: path
required: true
schema:
type: integer
format: int64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/token.v1.TokenReply'
/v1/inscriptions/{inscription_uid}:
get:
tags:
- Inscription
operationId: Inscription_GetInscription
parameters:
- name: inscription_uid
in: path
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/api.inscription.v1.GetInscriptionReply'
/v1/tokens:
get:
tags:
- Token
operationId: Token_ListTokens
parameters:
- name: p
in: query
schema:
type: string
- name: tick
in: query
schema:
type: string
- name: order_by
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: uint64
- name: offset
in: query
schema:
type: integer
format: uint64
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/token.v1.ListTokenReply'
/v1/tokens/{tick}/{token_id}:
get:
tags:
- Token
operationId: Token_GetToken
parameters:
- name: tick
in: path
required: true
schema:
type: string
- name: token_id
in: path
required: true
schema:
type: integer
format: uint64
- name: p
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/token.v1.TokenReply'
components:
schemas:
api.collection.v1.CollectionMessage:
type: object
properties:
tick:
type: string
p:
type: string
max:
type: integer
format: uint64
supply:
type: integer
format: uint64
base_uri:
type: string
name:
type: string
description:
type: string
image:
type: string
attributes:
type: array
items:
type: object
tx_hash:
type: string
block_height:
type: integer
format: uint64
block_time:
type: string
format: date-time
address:
type: string
inscription_id:
type: integer
format: int64
inscription_uid:
type: string
sig:
$ref: '#/components/schemas/api.collection.v1.DeploySig'
api.collection.v1.DeploySig:
type: object
properties:
pk:
type: string
fields:
type: array
items:
type: string
api.collection.v1.GetCollectionReply:
type: object
properties:
data:
$ref: '#/components/schemas/api.collection.v1.CollectionMessage'
api.collection.v1.ListCollectionReply:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/api.collection.v1.CollectionMessage'
paging:
$ref: '#/components/schemas/api.collection.v1.Paging'
api.collection.v1.Paging:
type: object
properties:
total_count:
type: integer
format: uint64
count:
type: integer
format: uint64
api.inscription.v1.GetInscriptionReply:
type: object
properties:
data:
$ref: '#/components/schemas/api.inscription.v1.InscriptionMessage'
api.inscription.v1.InscriptionMessage:
type: object
properties:
id:
type: integer
format: int64
inscription_id:
type: integer
format: int64
uid:
type: string
address:
type: string
output_value:
type: integer
format: uint64
content_length:
type: integer
format: uint64
content_type:
type: string
timestamp:
type: string
format: date-time
genesis_height:
type: integer
format: uint64
genesis_fee:
type: integer
format: uint64
genesis_tx:
type: string
location:
type: string
output:
type: string
offset:
type: integer
format: uint64
api.inscription.v1.ListInscriptionReply:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/api.inscription.v1.InscriptionMessage'
paging:
$ref: '#/components/schemas/api.inscription.v1.Paging'
api.inscription.v1.Paging:
type: object
properties:
next_id:
type: integer
format: int64
prev_id:
type: integer
format: int64
token.v1.ListTokenReply:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/token.v1.TokenMessage'
paging:
$ref: '#/components/schemas/token.v1.Paging'
token.v1.MintSig:
type: object
properties:
s:
type: string
uid:
type: string
expt:
type: integer
format: uint64
exph:
type: integer
format: uint64
rec:
type: string
token.v1.Paging:
type: object
properties:
total_count:
type: integer
format: uint64
count:
type: integer
format: uint64
token.v1.TokenMessage:
type: object
properties:
p:
type: string
tick:
type: string
token_id:
type: integer
format: uint64
tx_hash:
type: string
block_height:
type: integer
format: uint64
block_time:
type: string
format: date-time
address:
type: string
inscription_id:
type: integer
format: int64
inscription_uid:
type: string
sig:
$ref: '#/components/schemas/token.v1.MintSig'
description: The response message containing the token
token.v1.TokenReply:
type: object
properties:
data:
$ref: '#/components/schemas/token.v1.TokenMessage'
tags:
- name: Collection
- name: Inscription
- name: Token
description: The token service definition.