Skip to content

Commit 7c92ccb

Browse files
committed
Autogenerate API
1 parent 4ec633f commit 7c92ccb

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

api/openapi.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -240,6 +240,65 @@ paths:
240240
description: Node Not Found
241241
security:
242242
- api_key: []
243+
/api/v1/vdisks/list:
244+
get:
245+
tags:
246+
- services::api
247+
summary: Returns simple list of all known vdisks
248+
description: |-
249+
Returns simple list of all known vdisks
250+
251+
# Errors
252+
253+
This function will return an error if a call to the primary node will fail
254+
operationId: get_vdisks_list
255+
responses:
256+
'200':
257+
description: Simple Node List
258+
content:
259+
application/json:
260+
schema:
261+
type: array
262+
items:
263+
$ref: '#/components/schemas/dto.VDisk'
264+
'401':
265+
description: Unauthorized
266+
security:
267+
- api_key: []
268+
/api/v1/vdisks/{vdisk_id}:
269+
get:
270+
tags:
271+
- services::api
272+
summary: Returns vdisk inforamtion by their id
273+
description: |-
274+
Returns vdisk inforamtion by their id
275+
276+
# Errors
277+
278+
This function will return an error if a call to the main node will fail or vdisk with
279+
specified id not found
280+
operationId: get_vdisk_info
281+
parameters:
282+
- name: vdisk_id
283+
in: path
284+
required: true
285+
schema:
286+
type: integer
287+
format: int64
288+
minimum: 0
289+
responses:
290+
'200':
291+
description: VDisk Inforamtion
292+
content:
293+
application/json:
294+
schema:
295+
$ref: '#/components/schemas/VDisk'
296+
'401':
297+
description: Unauthorized
298+
'404':
299+
description: VDisk not found
300+
security:
301+
- api_key: []
243302
components:
244303
schemas:
245304
BobConnectionData:

0 commit comments

Comments
 (0)