diff --git a/.docs/.openapi/api-data.yaml b/.docs/.openapi/api-data.yaml
index 6d3e8693c52c8817f2d0243c22870005da54b556..6b1855a99e5e183c98270ce961899322beaa569e 100644
--- a/.docs/.openapi/api-data.yaml
+++ b/.docs/.openapi/api-data.yaml
@@ -11,7 +11,7 @@ info:
version: 1.7.1
externalDocs:
description: Sourcecode Documentation
- url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.7/system-services-metadata/
+ url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.7.1/system-services-metadata/
servers:
- url: http://localhost
description: Development instance
@@ -57,48 +57,60 @@ paths:
schema:
type: string
format: date-time
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
- "200":
- description: Retrieved view data
- headers:
- Access-Control-Expose-Headers:
- description: Expose `X-Count` custom header
- required: true
- style: simple
- X-Count:
- description: Number of rows
- required: true
- style: simple
+ "403":
+ description: Not allowed to retrieve view data
content:
application/json:
schema:
- type: string
- "409":
- description: View schema could not be mapped
+ $ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Failed to find view in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to establish connection with the metadata service
+ "400":
+ description: Request pagination is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find view in metadata database
+ "406":
+ description: Failed to format data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination is malformed
+ "409":
+ description: View schema could not be mapped
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to retrieve view data
+ "200":
+ description: Retrieved view data
+ headers:
+ Access-Control-Expose-Headers:
+ description: Expose `X-Count` custom header
+ required: true
+ style: simple
+ X-Count:
+ description: Number of rows
+ required: true
+ style: simple
+ content:
+ application/json:
+ schema:
+ type: string
+ text/csv: {}
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
@@ -144,48 +156,60 @@ paths:
schema:
type: string
format: date-time
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
- "200":
- description: Retrieved view data
- headers:
- Access-Control-Expose-Headers:
- description: Expose `X-Count` custom header
- required: true
- style: simple
- X-Count:
- description: Number of rows
- required: true
- style: simple
+ "403":
+ description: Not allowed to retrieve view data
content:
application/json:
schema:
- type: string
- "409":
- description: View schema could not be mapped
+ $ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Failed to find view in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to establish connection with the metadata service
+ "400":
+ description: Request pagination is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find view in metadata database
+ "406":
+ description: Failed to format data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination is malformed
+ "409":
+ description: View schema could not be mapped
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to retrieve view data
+ "200":
+ description: Retrieved view data
+ headers:
+ Access-Control-Expose-Headers:
+ description: Expose `X-Count` custom header
+ required: true
+ style: simple
+ X-Count:
+ description: Number of rows
+ required: true
+ style: simple
+ content:
+ application/json:
+ schema:
+ type: string
+ text/csv: {}
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
@@ -234,7 +258,24 @@ paths:
schema:
type: integer
format: int64
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
+ "404":
+ description: Failed to find table in metadata database
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: Request pagination or table data select query is malformed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Get table data
headers:
@@ -250,26 +291,21 @@ paths:
application/json:
schema:
type: string
- "503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to get table data
+ text/csv: {}
+ "406":
+ description: Failed to format data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find table in metadata database
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination or table data select query is malformed
+ "403":
+ description: Not allowed to get table data
content:
application/json:
schema:
@@ -310,28 +346,28 @@ paths:
$ref: "#/components/schemas/TupleUpdateDto"
required: true
responses:
- "403":
- description: Update table data not allowed
+ "404":
+ description: Failed to find table in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to establish connection with the metadata service
+ "400":
+ description: Request pagination or table data select query is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find table in metadata database
+ "202":
+ description: Updated table data
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Updated table data
- "400":
- description: Request pagination or table data select query is malformed
+ "403":
+ description: Update table data not allowed
content:
application/json:
schema:
@@ -372,30 +408,30 @@ paths:
$ref: "#/components/schemas/TupleDto"
required: true
responses:
- "404":
- description: Failed to find table in metadata database or blob in storage
- service
+ "400":
+ description: Request pagination or table data select query is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "201":
- description: Created table data
- "503":
- description: Failed to establish connection with the metadata service or
- storage service
+ "403":
+ description: Create table data not allowed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Create table data not allowed
+ "503":
+ description: Failed to establish connection with the metadata service or
+ storage service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination or table data select query is malformed
+ "201":
+ description: Created table data
+ "404":
+ description: Failed to find table in metadata database or blob in storage
+ service
content:
application/json:
schema:
@@ -436,14 +472,6 @@ paths:
$ref: "#/components/schemas/TupleDeleteDto"
required: true
responses:
- "503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Deleted table data
"404":
description: Failed to find table in metadata database
content:
@@ -462,6 +490,14 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "202":
+ description: Deleted table data
+ "503":
+ description: Failed to establish connection with the metadata service
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- basicAuth: []
- bearerAuth: []
@@ -505,7 +541,24 @@ paths:
schema:
type: integer
format: int64
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
+ "404":
+ description: Failed to find table in metadata database
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: Request pagination or table data select query is malformed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Get table data
headers:
@@ -521,26 +574,21 @@ paths:
application/json:
schema:
type: string
- "503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to get table data
+ text/csv: {}
+ "406":
+ description: Failed to format data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find table in metadata database
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination or table data select query is malformed
+ "403":
+ description: Not allowed to get table data
content:
application/json:
schema:
@@ -571,6 +619,11 @@ paths:
schema:
type: string
format: uuid
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
- name: timestamp
in: query
required: false
@@ -590,14 +643,27 @@ paths:
type: integer
format: int64
responses:
- "400":
- description: Invalid pagination
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to communicate with database
+ "403":
+ description: Not allowed to retrieve subset data
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "406":
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: Invalid pagination
content:
application/json:
schema:
@@ -623,15 +689,9 @@ paths:
application/json:
schema:
type: string
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to retrieve subset data
+ text/csv: {}
+ "503":
+ description: Failed to communicate with database
content:
application/json:
schema:
@@ -661,6 +721,11 @@ paths:
schema:
type: string
format: uuid
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
- name: timestamp
in: query
required: false
@@ -680,14 +745,27 @@ paths:
type: integer
format: int64
responses:
- "400":
- description: Invalid pagination
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to communicate with database
+ "403":
+ description: Not allowed to retrieve subset data
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "406":
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: Invalid pagination
content:
application/json:
schema:
@@ -710,18 +788,12 @@ paths:
description: The list of headers separated by comma
style: simple
content:
- application/json:
- schema:
- type: string
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to retrieve subset data
+ application/json:
+ schema:
+ type: string
+ text/csv: {}
+ "503":
+ description: Failed to communicate with database
content:
application/json:
schema:
@@ -756,39 +828,39 @@ paths:
$ref: "#/components/schemas/QueryPersistDto"
required: true
responses:
- "202":
- description: Persisted subset
+ "403":
+ description: Not allowed to persist subset
content:
application/json:
schema:
- $ref: "#/components/schemas/QueryDto"
- "503":
- description: Failed to communicate with database
+ $ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "417":
- description: Failed to persist subset
+ "202":
+ description: Persisted subset
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
+ $ref: "#/components/schemas/QueryDto"
+ "400":
+ description: Malformed select query
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to persist subset
+ "503":
+ description: Failed to communicate with database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Malformed select query
+ "417":
+ description: Failed to persist subset
content:
application/json:
schema:
@@ -867,28 +939,28 @@ paths:
$ref: "#/components/schemas/ImportDto"
required: true
responses:
- "202":
- description: Imported dataset successfully
- "403":
- description: Import table dataset not allowed
+ "404":
+ description: Failed to find table in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to establish connection with the metadata service
+ "202":
+ description: Imported dataset successfully
+ "400":
+ description: Dataset and/or query are malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find table in metadata database
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Dataset and/or query are malformed
+ "403":
+ description: Import table dataset not allowed
content:
application/json:
schema:
@@ -920,12 +992,6 @@ paths:
schema:
type: boolean
responses:
- "503":
- description: Failed to communicate with database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Found subsets
content:
@@ -934,15 +1000,21 @@ paths:
type: array
items:
$ref: "#/components/schemas/QueryDto"
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Not allowed to find subsets
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
+ "503":
+ description: Failed to communicate with database
content:
application/json:
schema:
@@ -991,8 +1063,8 @@ paths:
$ref: "#/components/schemas/SubsetDto"
required: true
responses:
- "417":
- description: Failed to insert query into query store of data database
+ "403":
+ description: Not allowed to find subset
content:
application/json:
schema:
@@ -1003,21 +1075,21 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to communicate with database
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not allowed to find subset
+ "417":
+ description: Failed to insert query into query store of data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
+ "406":
+ description: Failed to format data
content:
application/json:
schema:
@@ -1034,65 +1106,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- security:
- - basicAuth: []
- - bearerAuth: []
- /api/database/{databaseId}/view/{viewId}/export:
- get:
- tags:
- - view-endpoint
- summary: Get view data
- description: "Gets data from view with id as downloadable file. For tables in\
- \ private databases, the user needs to have at least *READ* access to the\
- \ associated database."
- operationId: exportDataset
- parameters:
- - name: databaseId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: viewId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: timestamp
- in: query
- required: false
- schema:
- type: string
- format: date-time
- responses:
- "404":
- description: Failed to find view in metadata database or export dataset
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Export view data not allowed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Exported view data
- content:
- application/json:
- schema:
- type: string
- format: binary
- "400":
- description: Request pagination or view data select query is malformed
+ description: Failed to communicate with database
content:
application/json:
schema:
@@ -1129,26 +1144,6 @@ paths:
type: integer
format: int64
responses:
- "200":
- description: Found table history
- content:
- application/json:
- schema:
- type: array
- items:
- $ref: "#/components/schemas/TableHistoryDto"
- "404":
- description: Failed to find table history in data database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Find table history not allowed
content:
@@ -1161,69 +1156,26 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- security:
- - basicAuth: []
- - bearerAuth: []
- /api/database/{databaseId}/table/{tableId}/export:
- get:
- tags:
- - table-endpoint
- summary: Get table data
- description: "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\
- \ associated database."
- operationId: exportDataset_1
- parameters:
- - name: databaseId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: tableId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: timestamp
- in: query
- required: false
- schema:
- type: string
- format: date-time
- responses:
- "503":
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find table in metadata database
+ "200":
+ description: Found table history
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Export table data not allowed
+ type: array
+ items:
+ $ref: "#/components/schemas/TableHistoryDto"
+ "503":
+ description: Failed to establish connection with the metadata service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Request pagination or table data select query is malformed
+ "404":
+ description: Failed to find table history in data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Exported table data
- content:
- application/json:
- schema:
- type: string
- format: binary
security:
- basicAuth: []
- bearerAuth: []
@@ -1251,11 +1203,6 @@ paths:
schema:
type: string
format: uuid
- - name: Accept
- in: header
- required: true
- schema:
- type: string
- name: timestamp
in: query
required: false
@@ -1263,40 +1210,40 @@ paths:
type: string
format: date-time
responses:
- "503":
- description: Failed to communicate with database
+ "200":
+ description: Found subset
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
+ $ref: "#/components/schemas/QueryDto"
+ text/csv: {}
"403":
description: Not allowed to find subset
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "406":
- description: Failed to find acceptable representation
+ "404":
+ description: Failed to find database in metadata database or query in query
+ store of the data database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database in metadata database or query in query
- store of the data database
+ "400":
+ description: Malformed select query
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Found subset
+ "406":
+ description: Failed to find acceptable representation
content:
application/json:
schema:
- $ref: "#/components/schemas/QueryDto"
- text/csv: {}
- "400":
- description: Malformed select query
+ $ref: "#/components/schemas/ApiErrorDto"
+ "503":
+ description: Failed to communicate with database
content:
application/json:
schema:
@@ -2102,6 +2049,7 @@ components:
- id
- language
- licenses
+ - links
- owner
- publication_year
- publisher
@@ -2117,6 +2065,8 @@ components:
type: string
format: uuid
example: b97cd56b-66ca-4354-9e6c-f47210cfaaec
+ links:
+ $ref: "#/components/schemas/LinksDto"
type:
type: string
example: database
@@ -2448,6 +2398,21 @@ components:
\ preservation of copyright and license notices. Licensed works, modifications,\
\ and larger works may be distributed under different terms and without\
\ source code."
+ LinksDto:
+ required:
+ - self
+ - self_html
+ type: object
+ properties:
+ self:
+ type: string
+ example: http://example.com/api/
+ data:
+ type: string
+ example: http://example.com
+ self_html:
+ type: string
+ example: http://example.com
RelatedIdentifierDto:
required:
- id
diff --git a/.docs/.openapi/api-metadata.yaml b/.docs/.openapi/api-metadata.yaml
index b7f380213b76fcf6455cba3b309a6fcf85c59440..e3769be04d2a9726dc40999bad56daa1c537d613 100644
--- a/.docs/.openapi/api-metadata.yaml
+++ b/.docs/.openapi/api-metadata.yaml
@@ -11,7 +11,7 @@ info:
version: 1.7.1
externalDocs:
description: Sourcecode Documentation
- url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.7/system-services-metadata/
+ url: https://www.ifs.tuwien.ac.at/infrastructures/dbrepo/1.7.1/system-services-metadata/
servers:
- url: http://localhost
description: Development instance
@@ -36,18 +36,18 @@ paths:
type: string
format: uuid
responses:
- "200":
- description: Found user
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/UserDto"
"404":
description: User was not found
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "200":
+ description: Found user
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/UserDto"
"403":
description: Find user is not permitted
content:
@@ -77,20 +77,20 @@ paths:
$ref: "#/components/schemas/UserUpdateDto"
required: true
responses:
- "403":
- description: Not allowed to modify user metadata
+ "400":
+ description: Modify user query is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to modify user at auth service
+ "404":
+ description: Failed to find database/user in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database/user in metadata database
+ "503":
+ description: Failed to modify user at auth service
content:
application/json:
schema:
@@ -101,8 +101,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/UserDto"
- "400":
- description: Modify user query is malformed
+ "403":
+ description: Not allowed to modify user metadata
content:
application/json:
schema:
@@ -127,18 +127,18 @@ paths:
type: string
format: uuid
responses:
- "200":
- description: Found user
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/UserDto"
"404":
description: User was not found
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "200":
+ description: Found user
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/UserDto"
"403":
description: Find user is not permitted
content:
@@ -194,20 +194,8 @@ paths:
$ref: "#/components/schemas/CreateDatabaseDto"
required: true
responses:
- "502":
- description: Connection to search service failed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "409":
- description: Query store could not be created
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to save in search service
+ "400":
+ description: Database create query is malformed or image is not supported
content:
application/json:
schema:
@@ -224,8 +212,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Database create query is malformed or image is not supported
+ "409":
+ description: Query store could not be created
content:
application/json:
schema:
@@ -243,6 +231,18 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "503":
+ description: Failed to save in search service
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -303,6 +303,12 @@ paths:
type: string
format: uuid
responses:
+ "200":
+ description: Found database access
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/DatabaseAccessDto"
"403":
description: No access to this database
content:
@@ -315,12 +321,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Found database access
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/DatabaseAccessDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -351,14 +351,9 @@ paths:
$ref: "#/components/schemas/CreateAccessDto"
required: true
responses:
- "404":
- description: Database or user not found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Access could not be updated in the data service
+ "502":
+ description: Access could not be updated due to connection error in the
+ data service
content:
application/json:
schema:
@@ -372,9 +367,8 @@ paths:
$ref: "#/components/schemas/ApiErrorDto"
"202":
description: Modified access
- "502":
- description: Access could not be updated due to connection error in the
- data service
+ "503":
+ description: Access could not be updated in the data service
content:
application/json:
schema:
@@ -385,6 +379,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Database or user not found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -415,14 +415,20 @@ paths:
$ref: "#/components/schemas/CreateAccessDto"
required: true
responses:
+ "502":
+ description: Access could not be created due to connection error
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"202":
description: Granting access succeeded
content:
application/json:
schema:
$ref: "#/components/schemas/DatabaseAccessDto"
- "404":
- description: Database or user not found
+ "403":
+ description: Failed giving access
content:
application/json:
schema:
@@ -439,14 +445,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Failed giving access
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Access could not be created due to connection error
+ "404":
+ description: Database or user not found
content:
application/json:
schema:
@@ -475,6 +475,12 @@ paths:
type: string
format: uuid
responses:
+ "502":
+ description: Access could not be created due to connection error
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Revoke of access not permitted as no access was found
content:
@@ -489,12 +495,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Access could not be created due to connection error
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"404":
description: "User, database with access was not found"
content:
@@ -534,6 +534,12 @@ paths:
type: string
format: uuid
responses:
+ "200":
+ description: Found database access
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/DatabaseAccessDto"
"403":
description: No access to this database
content:
@@ -546,12 +552,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Found database access
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/DatabaseAccessDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -665,18 +665,18 @@ paths:
$ref: "#/components/schemas/BannerMessageUpdateDto"
required: true
responses:
- "404":
- description: Could not find message
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"202":
description: Updated message
content:
application/json:
schema:
$ref: "#/components/schemas/BannerMessageBriefDto"
+ "404":
+ description: Could not find message
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -694,16 +694,16 @@ paths:
type: string
format: uuid
responses:
- "202":
- description: Deleted message
- content:
- application/json: {}
"404":
description: Could not find message
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "202":
+ description: Deleted message
+ content:
+ application/json: {}
security:
- bearerAuth: []
- basicAuth: []
@@ -817,9 +817,8 @@ paths:
schema:
type: string
responses:
- "400":
- description: "Identifier could not be exported, the requested style is not\
- \ known"
+ "403":
+ description: Not allowed to view identifier
content:
application/json:
schema:
@@ -830,24 +829,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "409":
- description: Exported resource was not found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to find in data service
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "410":
- description: Failed to retrieve from S3 endpoint
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Found identifier successfully
content:
@@ -857,20 +838,26 @@ paths:
application/ld+json:
schema:
$ref: "#/components/schemas/LdDatasetDto"
- text/csv: {}
text/xml: {}
text/bibliography: {}
text/bibliography; style=apa: {}
text/bibliography; style=ieee: {}
text/bibliography; style=bibtex: {}
- "403":
- description: Not allowed to view identifier
+ "410":
+ description: Failed to retrieve from S3 endpoint
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Identifier could not be found
+ "409":
+ description: Exported resource was not found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: "Identifier could not be exported, the requested style is not\
+ \ known"
content:
application/json:
schema:
@@ -881,6 +868,18 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Identifier could not be found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "503":
+ description: Failed to find in data service
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
put:
tags:
- identifier-endpoint
@@ -904,20 +903,20 @@ paths:
$ref: "#/components/schemas/IdentifierSaveDto"
required: true
responses:
- "502":
- description: Connection to search service failed
+ "404":
+ description: "Failed to find database, table or view"
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Insufficient access rights or authorities
+ "202":
+ description: Saved identifier
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: "Failed to find database, table or view"
+ $ref: "#/components/schemas/IdentifierDto"
+ "400":
+ description: Identifier form contains invalid request data
content:
application/json:
schema:
@@ -928,18 +927,18 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Identifier form contains invalid request data
+ "403":
+ description: Insufficient access rights or authorities
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Saved identifier
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
- $ref: "#/components/schemas/IdentifierDto"
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -957,12 +956,6 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"503":
description: Failed to delete in search service
content:
@@ -977,6 +970,12 @@ paths:
$ref: "#/components/schemas/ApiErrorDto"
"202":
description: Deleted identifier
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Deleting identifier not permitted
content:
@@ -1002,42 +1001,42 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
+ "404":
+ description: "Failed to find database, table or view"
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Insufficient access rights or authorities
+ "400":
+ description: Identifier form contains invalid request data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: "Failed to find database, table or view"
+ "202":
+ description: Published identifier
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
+ $ref: "#/components/schemas/IdentifierDto"
"503":
description: Failed to save in search service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Identifier form contains invalid request data
+ "403":
+ description: Insufficient access rights or authorities
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Published identifier
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
- $ref: "#/components/schemas/IdentifierDto"
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -1063,8 +1062,8 @@ paths:
$ref: "#/components/schemas/DatabaseModifyVisibilityDto"
required: true
responses:
- "502":
- description: Connection to search service failed
+ "400":
+ description: The visibility payload is malformed
content:
application/json:
schema:
@@ -1075,12 +1074,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: The visibility payload is malformed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Visibility modification is not permitted
content:
@@ -1093,6 +1086,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/DatabaseBriefDto"
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"404":
description: Failed to find database in metadata database
content:
@@ -1123,12 +1122,6 @@ paths:
type: string
format: uuid
responses:
- "403":
- description: Find view is not permitted
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"404":
description: "Database, view or user could not be found"
content:
@@ -1141,6 +1134,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ViewDto"
+ "403":
+ description: Find view is not permitted
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -1171,12 +1170,6 @@ paths:
$ref: "#/components/schemas/ViewUpdateDto"
required: true
responses:
- "502":
- description: Connection to search service failed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"404":
description: Database or View could not be found
content:
@@ -1201,6 +1194,12 @@ paths:
'*/*':
schema:
$ref: "#/components/schemas/ViewBriefDto"
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"400":
description: Update view query is malformed
content:
@@ -1230,22 +1229,22 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
+ "404":
+ description: "Database, view or user could not be found"
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
"202":
description: Delete view successfully
- "503":
- description: Failed to save in search service
+ "423":
+ description: Delete view resulted in an invalid query statement
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: "Database, view or user could not be found"
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
@@ -1256,8 +1255,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "423":
- description: Delete view resulted in an invalid query statement
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1295,18 +1294,18 @@ paths:
type: string
format: uuid
responses:
- "403":
- description: Access to the database is forbidden
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Find table successfully
content:
application/json:
schema:
$ref: "#/components/schemas/TableDto"
+ "403":
+ description: Access to the database is forbidden
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"404":
description: "Table, database or container could not be found"
content:
@@ -1342,14 +1341,8 @@ paths:
$ref: "#/components/schemas/TableUpdateDto"
required: true
responses:
- "502":
- description: Connection to search service failed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to save in search service
+ "400":
+ description: Update table visibility payload is malformed
content:
application/json:
schema:
@@ -1360,8 +1353,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/TableBriefDto"
- "400":
- description: Update table visibility payload is malformed
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
@@ -1372,6 +1365,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"403":
description: Update table visibility not permitted
content:
@@ -1403,28 +1402,28 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
+ "400":
+ description: Delete table query resulted in an invalid query statement
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Access to the database is forbidden
+ "202":
+ description: Delete table successfully
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to save in search service
+ "403":
+ description: Access to the database is forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Delete table successfully
- "400":
- description: Delete table query resulted in an invalid query statement
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1461,32 +1460,32 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
+ "403":
+ description: Not the owner
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to save in search service
+ "404":
+ description: Failed to find database/table in metadata database
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Failed to map column statistic to known columns
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Not the owner
+ "400":
+ description: Failed to map column statistic to known columns
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database/table in metadata database
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1532,18 +1531,12 @@ paths:
$ref: "#/components/schemas/ColumnSemanticsUpdateDto"
required: true
responses:
- "502":
- description: Connection to search service failed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Access to the database is forbidden
+ "202":
+ description: Updated column semantics successfully
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
+ $ref: "#/components/schemas/ColumnDto"
"404":
description: Failed to find user/table/database/ontology in metadata database
content:
@@ -1556,12 +1549,18 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Updated column semantics successfully
+ "403":
+ description: Access to the database is forbidden
content:
application/json:
schema:
- $ref: "#/components/schemas/ColumnDto"
+ $ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"400":
description: Update semantic concept query is malformed or update unit of
measurement query is malformed
@@ -1594,18 +1593,12 @@ paths:
$ref: "#/components/schemas/DatabaseTransferDto"
required: true
responses:
- "502":
- description: Connection to search service failed
+ "400":
+ description: Owner payload is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Transfer of ownership was successful
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/DatabaseBriefDto"
"503":
description: Failed to save in search service
content:
@@ -1618,8 +1611,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Owner payload is malformed
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1630,6 +1623,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "202":
+ description: Transfer of ownership was successful
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/DatabaseBriefDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -1650,26 +1649,26 @@ paths:
type: string
format: uuid
responses:
- "502":
- description: Connection to search service failed
+ "200":
+ description: Refreshed database views metadata
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
+ $ref: "#/components/schemas/DatabaseBriefDto"
"503":
description: Failed to save in search service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Refreshed database views metadata
+ "403":
+ description: Refresh view metadata is not permitted
content:
application/json:
schema:
- $ref: "#/components/schemas/DatabaseBriefDto"
- "403":
- description: Refresh view metadata is not permitted
+ $ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1700,14 +1699,8 @@ paths:
type: string
format: uuid
responses:
- "403":
- description: Not allowed to refresh table metadata
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Connection to search service failed
+ "400":
+ description: Failed to parse payload at search service
content:
application/json:
schema:
@@ -1724,8 +1717,14 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Failed to parse payload at search service
+ "403":
+ description: Not allowed to refresh table metadata
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1754,12 +1753,6 @@ paths:
type: string
format: uuid
responses:
- "404":
- description: Database or user could not be found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: View of image was successful
content:
@@ -1769,6 +1762,12 @@ paths:
items:
type: string
format: byte
+ "404":
+ description: Database or user could not be found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -1793,14 +1792,20 @@ paths:
$ref: "#/components/schemas/DatabaseModifyImageDto"
required: true
responses:
+ "403":
+ description: Modify of image is not permitted
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"410":
description: File was not found in the Storage Service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Connection to search service failed
+ "404":
+ description: Database could not be found
content:
application/json:
schema:
@@ -1817,14 +1822,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/DatabaseBriefDto"
- "404":
- description: Database could not be found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "403":
- description: Modify of image is not permitted
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -1948,12 +1947,6 @@ paths:
$ref: "#/components/schemas/ImageCreateDto"
required: true
responses:
- "400":
- description: Image specification is invalid
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"409":
description: Image already exists
content:
@@ -1966,6 +1959,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ImageDto"
+ "400":
+ description: Image specification is invalid
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -2054,8 +2053,8 @@ paths:
$ref: "#/components/schemas/CreateIdentifierDto"
required: true
responses:
- "502":
- description: Connection to search service failed
+ "404":
+ description: "Failed to find database, table or view"
content:
application/json:
schema:
@@ -2066,26 +2065,26 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/IdentifierDto"
- "403":
- description: Insufficient access rights or authorities
+ "400":
+ description: Identifier form contains invalid request data
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: "Failed to find database, table or view"
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "503":
- description: Failed to save in search service
+ "403":
+ description: Insufficient access rights or authorities
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Identifier form contains invalid request data
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -2146,14 +2145,8 @@ paths:
$ref: "#/components/schemas/CreateViewDto"
required: true
responses:
- "423":
- description: Create view resulted in an invalid query statement
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Connection to search service failed
+ "404":
+ description: Failed to find database/user in metadata database.
content:
application/json:
schema:
@@ -2164,8 +2157,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ViewBriefDto"
- "503":
- description: Failed to save in search service
+ "423":
+ description: Create view resulted in an invalid query statement
content:
application/json:
schema:
@@ -2176,8 +2169,8 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Create view query is malformed
+ "503":
+ description: Failed to save in search service
content:
application/json:
schema:
@@ -2188,8 +2181,14 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database/user in metadata database.
+ "502":
+ description: Connection to search service failed
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "400":
+ description: Create view query is malformed
content:
application/json:
schema:
@@ -2220,12 +2219,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Database could not be found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: List tables
content:
@@ -2234,6 +2227,12 @@ paths:
type: array
items:
$ref: "#/components/schemas/TableBriefDto"
+ "404":
+ description: Database could not be found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -2257,24 +2256,12 @@ paths:
$ref: "#/components/schemas/CreateTableDto"
required: true
responses:
- "403":
- description: Create table not permitted
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "502":
- description: Connection to search service failed
+ "400":
+ description: Create table query is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "201":
- description: Created a new table
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/TableBriefDto"
"409":
description: Create table conflicts with existing table name
content:
@@ -2287,14 +2274,26 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "201":
+ description: Created a new table
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/TableBriefDto"
"404":
description: "Database, container or user could not be found"
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "400":
- description: Create table query is malformed
+ "403":
+ description: Create table not permitted
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "502":
+ description: Connection to search service failed
content:
application/json:
schema:
@@ -2338,6 +2337,12 @@ paths:
$ref: "#/components/schemas/CreateContainerDto"
required: true
responses:
+ "409":
+ description: Container name already exists
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"403":
description: "Create container not permitted, need authority `create-container`"
content:
@@ -2356,12 +2361,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ContainerDto"
- "409":
- description: Container name already exists
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"404":
description: Container image or user could not be found
content:
@@ -2437,26 +2436,26 @@ paths:
schema:
type: string
responses:
- "400":
- description: Filter params are invalid
+ "200":
+ description: Found entities
content:
application/json:
schema:
- $ref: "#/components/schemas/ApiErrorDto"
+ type: array
+ items:
+ $ref: "#/components/schemas/EntityDto"
"417":
description: Generated query or uri is malformed
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "200":
- description: Found entities
+ "400":
+ description: Filter params are invalid
content:
application/json:
schema:
- type: array
- items:
- $ref: "#/components/schemas/EntityDto"
+ $ref: "#/components/schemas/ApiErrorDto"
"404":
description: Could not find ontology
content:
@@ -2506,18 +2505,18 @@ paths:
type: string
format: uuid
responses:
- "404":
- description: Could not find message
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Get messages
content:
application/json:
schema:
$ref: "#/components/schemas/BannerMessageDto"
+ "404":
+ description: Could not find message
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
/api/license:
get:
tags:
@@ -2549,18 +2548,18 @@ paths:
schema:
type: string
responses:
- "404":
- description: Failed to find metadata for identifier
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Retrieved metadata from identifier
content:
application/json:
schema:
$ref: "#/components/schemas/IdentifierDto"
+ "404":
+ description: Failed to find metadata for identifier
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
/api/database/{databaseId}:
get:
tags:
@@ -2576,18 +2575,6 @@ paths:
type: string
format: uuid
responses:
- "403":
- description: Not allowed to view database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Database could not be found
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Database found successfully
headers:
@@ -2604,6 +2591,18 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/DatabaseBriefDto"
+ "404":
+ description: Database could not be found
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
+ "403":
+ description: Not allowed to view database
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -2635,12 +2634,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "417":
- description: Generated query is malformed
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Suggested table semantics successfully
content:
@@ -2649,8 +2642,8 @@ paths:
type: array
items:
$ref: "#/components/schemas/EntityDto"
- "422":
- description: Ontology does not have rdf or sparql endpoint
+ "417":
+ description: Generated query is malformed
content:
application/json:
schema:
@@ -2667,6 +2660,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "422":
+ description: Ontology does not have rdf or sparql endpoint
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -2703,6 +2702,12 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "404":
+ description: Failed to find database/table in metadata database
+ content:
+ application/json:
+ schema:
+ $ref: "#/components/schemas/ApiErrorDto"
"200":
description: Suggested table column semantics successfully
content:
@@ -2717,12 +2722,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "404":
- description: Failed to find database/table in metadata database
- content:
- application/json:
- schema:
- $ref: "#/components/schemas/ApiErrorDto"
security:
- bearerAuth: []
- basicAuth: []
@@ -2773,14 +2772,14 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
+ "202":
+ description: Deleted container
"403":
description: "Create container not permitted, need authority `delete-container`"
content:
application/json:
schema:
$ref: "#/components/schemas/ApiErrorDto"
- "202":
- description: Deleted container
security:
- bearerAuth: []
- basicAuth: []
@@ -2802,59 +2801,6 @@ paths:
$ref: "#/components/schemas/ConceptDto"
components:
schemas:
- UserAttributesDto:
- required:
- - language
- - theme
- type: object
- properties:
- theme:
- type: string
- example: light
- orcid:
- type: string
- example: https://orcid.org/0000-0002-1825-0097
- affiliation:
- type: string
- example: Brown University
- language:
- type: string
- example: en
- UserDto:
- required:
- - attributes
- - id
- - password
- - username
- type: object
- properties:
- id:
- type: string
- format: uuid
- example: 1ffc7b0e-9aeb-4e8b-b8f1-68f3936155b4
- name:
- type: string
- example: Josiah Carberry
- username:
- type: string
- example: username
- password:
- type: string
- example: p4ssw0rd
- attributes:
- $ref: "#/components/schemas/UserAttributesDto"
- last_retrieved:
- type: string
- format: date-time
- qualified_name:
- type: string
- example: Josiah Carberry — @jcarberry
- given_name:
- type: string
- example: Josiah
- family_name:
- type: string
- example: Carberry
ApiErrorDto:
required:
- code
@@ -2941,6 +2887,59 @@ components:
code:
type: string
example: error.service.code
+ UserAttributesDto:
+ required:
+ - language
+ - theme
+ type: object
+ properties:
+ theme:
+ type: string
+ example: light
+ orcid:
+ type: string
+ example: https://orcid.org/0000-0002-1825-0097
+ affiliation:
+ type: string
+ example: Brown University
+ language:
+ type: string
+ example: en
+ UserDto:
+ required:
+ - attributes
+ - id
+ - password
+ - username
+ type: object
+ properties:
+ id:
+ type: string
+ format: uuid
+ example: 1ffc7b0e-9aeb-4e8b-b8f1-68f3936155b4
+ name:
+ type: string
+ example: Josiah Carberry
+ username:
+ type: string
+ example: username
+ password:
+ type: string
+ example: p4ssw0rd
+ attributes:
+ $ref: "#/components/schemas/UserAttributesDto"
+ last_retrieved:
+ type: string
+ format: date-time
+ qualified_name:
+ type: string
+ example: Josiah Carberry — @jcarberry
+ given_name:
+ type: string
+ example: Josiah
+ family_name:
+ type: string
+ example: Carberry
CreatorBriefDto:
required:
- creator_name
@@ -4750,6 +4749,7 @@ components:
- id
- language
- licenses
+ - links
- owner
- publication_year
- publisher
@@ -4765,6 +4765,8 @@ components:
type: string
format: uuid
example: b97cd56b-66ca-4354-9e6c-f47210cfaaec
+ links:
+ $ref: "#/components/schemas/LinksDto"
type:
type: string
example: database
@@ -5078,6 +5080,21 @@ components:
award_title:
type: string
example: EOSC-Life
+ LinksDto:
+ required:
+ - self
+ - self_html
+ type: object
+ properties:
+ self:
+ type: string
+ example: http://example.com/api/
+ data:
+ type: string
+ example: http://example.com
+ self_html:
+ type: string
+ example: http://example.com
RelatedIdentifierDto:
required:
- id
@@ -6371,14 +6388,14 @@ components:
type: string
resumptionToken:
type: string
- parametersString:
- type: string
fromDate:
type: string
format: date-time
untilDate:
type: string
format: date-time
+ parametersString:
+ type: string
BannerMessageDto:
required:
- id
diff --git a/.docs/.openapi/api.yaml b/.docs/.openapi/api.yaml
index 883a0efffe0d6959a2453e61f01e087e9bc0cf22..0fcd84503c6bd92530804d6e3e02242fe205d689 100644
--- a/.docs/.openapi/api.yaml
+++ b/.docs/.openapi/api.yaml
@@ -186,6 +186,11 @@ paths:
schema:
type: string
format: date-time
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
'200':
description: Retrieved view data
@@ -202,6 +207,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Request pagination is malformed
content:
@@ -220,6 +226,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'409':
description: View schema could not be mapped
content:
@@ -274,6 +286,11 @@ paths:
schema:
type: string
format: date-time
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
'200':
description: Retrieved view data
@@ -290,6 +307,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Request pagination is malformed
content:
@@ -308,6 +326,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'409':
description: View schema could not be mapped
content:
@@ -365,6 +389,11 @@ paths:
schema:
type: integer
format: int64
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
'200':
description: Get table data
@@ -381,6 +410,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Request pagination or table data select query is malformed
content:
@@ -399,6 +429,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'503':
description: Failed to establish connection with the metadata service
content:
@@ -640,6 +676,11 @@ paths:
schema:
type: integer
format: int64
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
responses:
'200':
description: Get table data
@@ -656,6 +697,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Request pagination or table data select query is malformed
content:
@@ -674,6 +716,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'503':
description: Failed to establish connection with the metadata service
content:
@@ -708,6 +756,11 @@ paths:
schema:
type: string
format: uuid
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
- name: timestamp
in: query
required: false
@@ -748,6 +801,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Invalid pagination
content:
@@ -768,6 +822,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'503':
description: Failed to communicate with database
content:
@@ -801,6 +861,11 @@ paths:
schema:
type: string
format: uuid
+ - name: Accept
+ in: header
+ required: true
+ schema:
+ type: string
- name: timestamp
in: query
required: false
@@ -841,6 +906,7 @@ paths:
application/json:
schema:
type: string
+ text/csv: {}
'400':
description: Invalid pagination
content:
@@ -861,6 +927,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'503':
description: Failed to communicate with database
content:
@@ -1164,6 +1236,12 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorDto'
+ '406':
+ description: Failed to format data
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ApiErrorDto'
'417':
description: Failed to insert query into query store of data database
content:
@@ -1185,70 +1263,6 @@ paths:
security:
- basicAuth: []
- bearerAuth: []
- '/api/database/{databaseId}/view/{viewId}/export':
- get:
- tags:
- - view-endpoint
- summary: Get view data
- description: >-
- Gets data from view with id as downloadable file. For tables in private
- databases, the user needs to have at least *READ* access to the
- associated database.
- operationId: exportDataset
- parameters:
- - name: databaseId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: viewId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: timestamp
- in: query
- required: false
- schema:
- type: string
- format: date-time
- responses:
- '200':
- description: Exported view data
- content:
- application/json:
- schema:
- type: string
- format: binary
- '400':
- description: Request pagination or view data select query is malformed
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '403':
- description: Export view data not allowed
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '404':
- description: Failed to find view in metadata database or export dataset
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '503':
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- security:
- - basicAuth: []
- - bearerAuth: []
'/api/database/{databaseId}/table/{tableId}/history':
get:
tags:
@@ -1314,70 +1328,6 @@ paths:
security:
- basicAuth: []
- bearerAuth: []
- '/api/database/{databaseId}/table/{tableId}/export':
- get:
- tags:
- - table-endpoint
- summary: Get table data
- description: >-
- 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
- associated database.
- operationId: exportDataset_1
- parameters:
- - name: databaseId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: tableId
- in: path
- required: true
- schema:
- type: string
- format: uuid
- - name: timestamp
- in: query
- required: false
- schema:
- type: string
- format: date-time
- responses:
- '200':
- description: Exported table data
- content:
- application/json:
- schema:
- type: string
- format: binary
- '400':
- description: Request pagination or table data select query is malformed
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '403':
- description: Export table data not allowed
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '404':
- description: Failed to find table in metadata database
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- '503':
- description: Failed to establish connection with the metadata service
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/ApiErrorDto'
- security:
- - basicAuth: []
- - bearerAuth: []
'/api/database/{databaseId}/subset/{subsetId}':
get:
tags:
@@ -1403,11 +1353,6 @@ paths:
schema:
type: string
format: uuid
- - name: Accept
- in: header
- required: true
- schema:
- type: string
- name: timestamp
in: query
required: false
@@ -2282,7 +2227,6 @@ paths:
application/ld+json:
schema:
$ref: '#/components/schemas/LdDatasetDto'
- text/csv: {}
text/xml: {}
text/bibliography: {}
text/bibliography; style=apa: {}
@@ -5332,6 +5276,7 @@ components:
- id
- language
- licenses
+ - links
- owner
- publication_year
- publisher
@@ -5347,6 +5292,8 @@ components:
type: string
format: uuid
example: b97cd56b-66ca-4354-9e6c-f47210cfaaec
+ links:
+ $ref: '#/components/schemas/LinksDto'
type:
type: string
example: database
@@ -5681,6 +5628,21 @@ components:
preservation of copyright and license notices. Licensed works,
modifications, and larger works may be distributed under different
terms and without source code.
+ LinksDto:
+ required:
+ - self
+ - self_html
+ type: object
+ properties:
+ self:
+ type: string
+ example: 'http://example.com/api/'
+ data:
+ type: string
+ example: 'http://example.com'
+ self_html:
+ type: string
+ example: 'http://example.com'
RelatedIdentifierDto:
required:
- id
@@ -8414,14 +8376,14 @@ components:
type: string
resumptionToken:
type: string
- parametersString:
- type: string
fromDate:
type: string
format: date-time
untilDate:
type: string
format: date-time
+ parametersString:
+ type: string
BannerMessageDto:
required:
- id
diff --git a/helm/dbrepo/charts/seaweedfs-4.2.1.tgz b/helm/dbrepo/charts/seaweedfs-4.2.1.tgz
index f68e0bea5c235a15b317317f1e757fe29be1c73c..b26358e59779d3206d9c834f59b08e7f2f84149b 100644
Binary files a/helm/dbrepo/charts/seaweedfs-4.2.1.tgz and b/helm/dbrepo/charts/seaweedfs-4.2.1.tgz differ
diff --git a/helm/seaweedfs/charts/mariadb-20.2.4.tgz b/helm/seaweedfs/charts/mariadb-20.2.4.tgz
deleted file mode 100644
index eb0f7bcfab6286495ed5338abdb8221b1f89805c..0000000000000000000000000000000000000000
Binary files a/helm/seaweedfs/charts/mariadb-20.2.4.tgz and /dev/null differ
diff --git a/helm/seaweedfs/charts/postgresql-16.4.9.tgz b/helm/seaweedfs/charts/postgresql-16.4.9.tgz
deleted file mode 100644
index 4bb0578224f0d8817e757a759547b171798bd407..0000000000000000000000000000000000000000
Binary files a/helm/seaweedfs/charts/postgresql-16.4.9.tgz and /dev/null differ