Skip to content

Commit

Permalink
Autogenerate API
Browse files Browse the repository at this point in the history
  • Loading branch information
archeoss committed Dec 1, 2023
1 parent 5f499f9 commit 197db21
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,65 @@ paths:
description: Node Not Found
security:
- api_key: []
/api/v1/vdisks/list:
get:
tags:
- services::api
summary: Returns simple list of all known vdisks
description: |-
Returns simple list of all known vdisks
# Errors
This function will return an error if a call to the primary node will fail
operationId: get_vdisks_list
responses:
'200':
description: Simple Node List
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/dto.VDisk'
'401':
description: Unauthorized
security:
- api_key: []
/api/v1/vdisks/{vdisk_id}:
get:
tags:
- services::api
summary: Returns vdisk inforamtion by their id
description: |-
Returns vdisk inforamtion by their id
# Errors
This function will return an error if a call to the main node will fail or vdisk with
specified id not found
operationId: get_vdisk_info
parameters:
- name: vdisk_id
in: path
required: true
schema:
type: integer
format: int64
minimum: 0
responses:
'200':
description: VDisk Inforamtion
content:
application/json:
schema:
$ref: '#/components/schemas/VDisk'
'401':
description: Unauthorized
'404':
description: VDisk not found
security:
- api_key: []
components:
schemas:
BobConnectionData:
Expand Down

0 comments on commit 197db21

Please sign in to comment.