Skip to content
Snippets Groups Projects
Verified Commit 01009a6b authored by Martin Weise's avatar Martin Weise
Browse files

Updated swagger API

parent 482b89bc
No related branches found
No related tags found
2 merge requests!322Master,!321Dev
...@@ -1021,7 +1021,7 @@ paths: ...@@ -1021,7 +1021,7 @@ paths:
summary: Create subset summary: Create subset
description: >- description: >-
Creates a subset in the query store of the data database. Requires role Creates a subset in the query store of the data database. Requires role
`execute-query` `execute-query` for private databases.
operationId: create operationId: create
parameters: parameters:
- name: databaseId - name: databaseId
...@@ -1223,7 +1223,7 @@ paths: ...@@ -1223,7 +1223,7 @@ paths:
Gets data from table with id as downloadable file. For tables in private Gets data from table with id as downloadable file. For tables in private
databases, the user needs to have at least *READ* access to the databases, the user needs to have at least *READ* access to the
associated database. associated database.
operationId: exportData operationId: exportDataset
parameters: parameters:
- name: databaseId - name: databaseId
in: path in: path
...@@ -1431,6 +1431,12 @@ paths: ...@@ -1431,6 +1431,12 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
'423':
description: Database quota exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
'502': '502':
description: Connection to search service failed description: Connection to search service failed
content: content:
...@@ -3030,6 +3036,12 @@ paths: ...@@ -3030,6 +3036,12 @@ paths:
summary: List users summary: List users
description: Lists users known to the metadata database. description: Lists users known to the metadata database.
operationId: findAll operationId: findAll
parameters:
- name: username
in: query
required: false
schema:
type: string
responses: responses:
'200': '200':
description: List users description: List users
...@@ -4431,6 +4443,29 @@ components: ...@@ -4431,6 +4443,29 @@ components:
required: required:
- keys - keys
type: object type: object
QueryResultDto:
required:
- headers
- id
- result
type: object
properties:
result:
type: array
items:
type: object
additionalProperties:
type: object
headers:
type: array
items:
type: object
additionalProperties:
type: integer
format: int32
id:
type: integer
format: int64
ApiErrorDto: ApiErrorDto:
required: required:
- code - code
...@@ -4517,29 +4552,6 @@ components: ...@@ -4517,29 +4552,6 @@ components:
code: code:
type: string type: string
example: error.service.code example: error.service.code
QueryResultDto:
required:
- headers
- id
- result
type: object
properties:
result:
type: array
items:
type: object
additionalProperties:
type: object
headers:
type: array
items:
type: object
additionalProperties:
type: integer
format: int32
id:
type: integer
format: int64
TupleUpdateDto: TupleUpdateDto:
required: required:
- data - data
...@@ -5952,12 +5964,14 @@ components: ...@@ -5952,12 +5964,14 @@ components:
$ref: '#/components/schemas/PrimaryKeyDto' $ref: '#/components/schemas/PrimaryKeyDto'
ContainerDto: ContainerDto:
required: required:
- count
- created - created
- host - host
- id - id
- image - image
- internal_name - internal_name
- name - name
- quota
- sidecar_host - sidecar_host
- sidecar_port - sidecar_port
type: object type: object
...@@ -5975,6 +5989,14 @@ components: ...@@ -5975,6 +5989,14 @@ components:
format: int32 format: int32
image: image:
$ref: '#/components/schemas/ImageDto' $ref: '#/components/schemas/ImageDto'
quota:
type: integer
format: int64
example: 50
count:
type: integer
format: int64
example: 10
created: created:
type: string type: string
format: date-time format: date-time
...@@ -6169,6 +6191,7 @@ components: ...@@ -6169,6 +6191,7 @@ components:
example: '2021-03-12T15:26:21.000Z' example: '2021-03-12T15:26:21.000Z'
ImageDto: ImageDto:
required: required:
- default
- default_port - default_port
- dialect - dialect
- driver_class - driver_class
...@@ -6204,6 +6227,9 @@ components: ...@@ -6204,6 +6227,9 @@ components:
jdbc_method: jdbc_method:
type: string type: string
example: mariadb example: mariadb
default:
type: boolean
example: false
default_port: default_port:
type: integer type: integer
format: int32 format: int32
...@@ -7742,6 +7768,7 @@ components: ...@@ -7742,6 +7768,7 @@ components:
- default_port - default_port
- dialect - dialect
- driver_class - driver_class
- is_default
- jdbc_method - jdbc_method
- name - name
- registry - registry
...@@ -7758,6 +7785,9 @@ components: ...@@ -7758,6 +7785,9 @@ components:
type: string type: string
dialect: dialect:
type: string type: string
is_default:
type: boolean
example: false
driver_class: driver_class:
type: string type: string
jdbc_method: jdbc_method:
...@@ -8284,6 +8314,7 @@ components: ...@@ -8284,6 +8314,7 @@ components:
- name - name
- privileged_password - privileged_password
- privileged_username - privileged_username
- quota
- sidecar_host - sidecar_host
- sidecar_port - sidecar_port
type: object type: object
...@@ -8298,6 +8329,10 @@ components: ...@@ -8298,6 +8329,10 @@ components:
type: integer type: integer
description: Port of container description: Port of container
format: int32 format: int32
quota:
type: integer
format: int64
example: 50
image_id: image_id:
type: integer type: integer
description: Image ID description: Image ID
...@@ -8374,10 +8409,10 @@ components: ...@@ -8374,10 +8409,10 @@ components:
type: string type: string
resumptionToken: resumptionToken:
type: string type: string
untilDate: fromDate:
type: string type: string
format: date-time format: date-time
fromDate: untilDate:
type: string type: string
format: date-time format: date-time
parametersString: parametersString:
...@@ -8417,6 +8452,7 @@ components: ...@@ -8417,6 +8452,7 @@ components:
example: '2021-03-12T15:26:21.000Z' example: '2021-03-12T15:26:21.000Z'
ImageBriefDto: ImageBriefDto:
required: required:
- default
- id - id
- jdbc_method - jdbc_method
- name - name
...@@ -8435,6 +8471,9 @@ components: ...@@ -8435,6 +8471,9 @@ components:
jdbc_method: jdbc_method:
type: string type: string
example: mariadb example: mariadb
default:
type: boolean
example: false
LdCreatorDto: LdCreatorDto:
required: required:
- '@type' - '@type'
...@@ -8528,13 +8567,14 @@ components: ...@@ -8528,13 +8567,14 @@ components:
example: 1 example: 1
ContainerBriefDto: ContainerBriefDto:
required: required:
- count
- created - created
- hash - hash
- id - id
- image - image
- internal_name - internal_name
- name - name
- running - quota
type: object type: object
properties: properties:
id: id:
...@@ -8548,9 +8588,14 @@ components: ...@@ -8548,9 +8588,14 @@ components:
example: Air Quality example: Air Quality
image: image:
$ref: '#/components/schemas/ImageBriefDto' $ref: '#/components/schemas/ImageBriefDto'
running: quota:
type: boolean type: integer
example: true format: int32
example: 50
count:
type: integer
format: int32
example: 10
created: created:
type: string type: string
format: date-time format: date-time
...@@ -8603,6 +8648,9 @@ components: ...@@ -8603,6 +8648,9 @@ components:
uiPort: uiPort:
type: integer type: integer
format: int32 format: int32
quota:
type: integer
format: int32
uiAdditionalFlags: uiAdditionalFlags:
type: string type: string
databases: databases:
...@@ -8642,6 +8690,8 @@ components: ...@@ -8642,6 +8690,8 @@ components:
defaultPort: defaultPort:
type: integer type: integer
format: int32 format: int32
isDefault:
type: boolean
dateFormats: dateFormats:
type: array type: array
items: items:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment