diff --git a/.docs/.swagger/api-metadata.yaml b/.docs/.swagger/api-metadata.yaml index df5304c003b4f4b88431c223fa2233f9dc90a8b6..bcfa22b1e63f10a2899d354aba0c1e7d50caaa46 100644 --- a/.docs/.swagger/api-metadata.yaml +++ b/.docs/.swagger/api-metadata.yaml @@ -38,8 +38,8 @@ paths: type: integer format: int64 responses: - "404": - description: "Table, database or user could not be found" + "409": + description: Query store failed to query table history content: application/json: schema: @@ -50,6 +50,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Find table history is not permitted + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "200": description: Find table history successfully content: @@ -58,14 +64,8 @@ paths: type: array items: $ref: '#/components/schemas/TableHistoryDto' - "403": - description: Find table history is not permitted - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Query store failed to query table history + "404": + description: "Table, database or user could not be found" content: application/json: schema: @@ -92,8 +92,8 @@ paths: type: integer format: int64 responses: - "404": - description: "Table, database or user could not be found" + "409": + description: Query store failed to query table history content: application/json: schema: @@ -104,6 +104,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Find table history is not permitted + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "200": description: Find table history successfully content: @@ -112,14 +118,8 @@ paths: type: array items: $ref: '#/components/schemas/TableHistoryDto' - "403": - description: Find table history is not permitted - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Query store failed to query table history + "404": + description: "Table, database or user could not be found" content: application/json: schema: @@ -178,6 +178,12 @@ paths: schema: type: string responses: + "422": + description: Could not import csv via sidecar + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "400": description: Table data is malformed or image is not supported content: @@ -190,24 +196,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Get table data successfully - content: - '*/*': - schema: - $ref: '#/components/schemas/QueryResultDto' "403": description: Access to the database is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Could not import csv via sidecar + "202": + description: Get table data successfully content: - application/json: + '*/*': schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/QueryResultDto' security: - bearerAuth: [] - basicAuth: [] @@ -237,18 +237,18 @@ paths: $ref: '#/components/schemas/TableCsvDto' required: true responses: - "202": - description: Inserted data successfully - content: - '*/*': - schema: - type: object "404": description: Table or database could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Inserted data successfully + content: + '*/*': + schema: + type: object "400": description: Insert table data is malformed content: @@ -292,14 +292,14 @@ paths: responses: "202": description: Deleted table data successfully - "404": - description: Table or database could not be found + "400": + description: Table data or query is malformed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Table data or query is malformed + "404": + description: Table or database could not be found content: application/json: schema: @@ -363,6 +363,12 @@ paths: schema: type: string responses: + "422": + description: Could not import csv via sidecar + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "400": description: Table data is malformed or image is not supported content: @@ -375,24 +381,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Get table data successfully - content: - '*/*': - schema: - $ref: '#/components/schemas/QueryResultDto' "403": description: Access to the database is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Could not import csv via sidecar + "202": + description: Get table data successfully content: - application/json: + '*/*': schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/QueryResultDto' security: - bearerAuth: [] - basicAuth: [] @@ -410,24 +410,24 @@ paths: type: string format: uuid responses: - "200": - description: Found user + "403": + description: Find user is not permitted content: application/json: schema: - $ref: '#/components/schemas/UserDto' + $ref: '#/components/schemas/ApiErrorDto' "404": description: User was not found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Find user is not permitted + "200": + description: Found user content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/UserDto' security: - bearerAuth: [] - basicAuth: [] @@ -450,18 +450,6 @@ paths: $ref: '#/components/schemas/UserUpdateDto' required: true responses: - "403": - description: Modify user is not permitted - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Modified user information - content: - application/json: - schema: - $ref: '#/components/schemas/UserDto' "405": description: Foreign user modification content: @@ -480,6 +468,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Modify user is not permitted + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Modified user information + content: + application/json: + schema: + $ref: '#/components/schemas/UserDto' security: - bearerAuth: [] - basicAuth: [] @@ -503,8 +503,8 @@ paths: $ref: '#/components/schemas/UserThemeSetDto' required: true responses: - "404": - description: User or user attribute was not found + "405": + description: Foreign user modification content: application/json: schema: @@ -521,8 +521,8 @@ paths: application/json: schema: $ref: '#/components/schemas/UserDto' - "405": - description: Foreign user modification + "404": + description: User or user attribute was not found content: application/json: schema: @@ -550,36 +550,36 @@ paths: $ref: '#/components/schemas/UserPasswordDto' required: true responses: - "404": - description: User was not found + "403": + description: Modify is not allowed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "503": - description: Authentication service does not respond + "404": + description: User was not found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Modified user password - content: - application/json: - schema: - $ref: '#/components/schemas/UserDto' "405": description: Foreign user modification content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Modify is not allowed + "503": + description: Authentication service does not respond content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Modified user password + content: + application/json: + schema: + $ref: '#/components/schemas/UserDto' security: - bearerAuth: [] - basicAuth: [] @@ -656,16 +656,16 @@ paths: type: integer format: int64 responses: + "202": + description: Deleted ontology successfully + content: + application/json: {} "404": description: Could not find ontology content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Deleted ontology successfully - content: - application/json: {} security: - bearerAuth: [] - basicAuth: [] @@ -683,18 +683,18 @@ paths: type: integer format: int64 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' put: tags: - maintenance-endpoint @@ -726,6 +726,9 @@ paths: application/json: schema: $ref: '#/components/schemas/BannerMessageBriefDto' + security: + - bearerAuth: [] + - basicAuth: [] delete: tags: - maintenance-endpoint @@ -739,16 +742,19 @@ paths: type: integer format: int64 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: [] /api/image/{id}: get: tags: @@ -763,18 +769,18 @@ paths: type: integer format: int64 responses: - "404": - description: Image could not be found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Found image content: application/json: schema: $ref: '#/components/schemas/ImageDto' + "404": + description: Image could not be found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' put: tags: - image-endpoint @@ -794,18 +800,18 @@ paths: $ref: '#/components/schemas/ImageChangeDto' required: true responses: - "404": - description: Image could not be found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "202": description: Updated image successfully content: application/json: schema: $ref: '#/components/schemas/ImageDto' + "404": + description: Image could not be found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -822,14 +828,14 @@ paths: type: integer format: int64 responses: + "202": + description: Deleted image successfully "404": description: Image could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Deleted image successfully security: - bearerAuth: [] - basicAuth: [] @@ -853,24 +859,24 @@ paths: $ref: '#/components/schemas/DatabaseModifyVisibilityDto' required: true responses: - "404": - description: Database could not be found + "202": + description: Visibility modified successfully content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/DatabaseDto' "403": description: Visibility modification is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Visibility modified successfully + "404": + description: Database could not be found content: application/json: schema: - $ref: '#/components/schemas/DatabaseDto' + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -894,12 +900,6 @@ paths: $ref: '#/components/schemas/DatabaseTransferDto' required: true responses: - "403": - description: Transfer of ownership is not permitted - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "202": description: Transfer of ownership was successful content: @@ -912,6 +912,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Transfer of ownership is not permitted + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -940,11 +946,6 @@ paths: schema: type: integer format: int64 - - name: Authorization - in: header - required: true - schema: - type: string requestBody: content: application/json: @@ -958,12 +959,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Updated column semantics successfully - content: - application/json: - schema: - $ref: '#/components/schemas/ColumnDto' "400": description: Update semantic concept query is malformed or update unit of measurement query is malformed @@ -971,6 +966,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Updated column semantics successfully + content: + application/json: + schema: + $ref: '#/components/schemas/ColumnDto' "403": description: Access to the database is forbidden content: @@ -1000,30 +1001,30 @@ paths: $ref: '#/components/schemas/DatabaseModifyImageDto' required: true responses: - "410": - description: File was not found in the Storage Service + "404": + description: Database or user could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Modify of image was successful - content: - application/json: - schema: - $ref: '#/components/schemas/DatabaseDto' "403": description: Modify of image is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: Database or user could not be found + "410": + description: File was not found in the Storage Service content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Modify of image was successful + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseDto' security: - bearerAuth: [] - basicAuth: [] @@ -1053,10 +1054,8 @@ paths: $ref: '#/components/schemas/DatabaseModifyAccessDto' required: true responses: - "202": - description: Modify access succeeded - "404": - description: Database or user not found + "400": + description: Modify access query or database connection is malformed content: application/json: schema: @@ -1068,12 +1067,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Modify access query or database connection is malformed + "404": + description: Database or user not found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Modify access succeeded security: - bearerAuth: [] - basicAuth: [] @@ -1102,14 +1103,16 @@ paths: $ref: '#/components/schemas/DatabaseGiveAccessDto' required: true responses: - "404": - description: Database or user not found + "202": + description: Granting access succeeded + "400": + description: Granting access query or database connection is malformed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Granting access query or database connection is malformed + "405": + description: Granting access not permitted content: application/json: schema: @@ -1120,10 +1123,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Granting access succeeded - "405": - description: Granting access not permitted + "404": + description: Database or user not found content: application/json: schema: @@ -1150,10 +1151,8 @@ paths: type: string format: uuid responses: - "202": - description: Revoked access successfully - "403": - description: Revoke of access not permitted as no access was found + "404": + description: "User, database with access was not found" content: application/json: schema: @@ -1164,8 +1163,10 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "User, database with access was not found" + "202": + description: Revoked access successfully + "403": + description: Revoke of access not permitted as no access was found content: application/json: schema: @@ -1193,38 +1194,38 @@ paths: type: integer format: int64 responses: - "501": - description: Image is not supported + "404": + description: "Database, query or user could not be found" content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "504": - description: Query store failed to select query + "405": + description: Find query is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, query or user could not be found" + "501": + description: Image is not supported content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "200": - description: List queries - content: - application/json: - schema: - $ref: '#/components/schemas/QueryDto' "503": description: Connection to the database failed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "405": - description: Find query is not permitted + "200": + description: List queries + content: + application/json: + schema: + $ref: '#/components/schemas/QueryDto' + "504": + description: Query store failed to select query content: application/json: schema: @@ -1257,42 +1258,42 @@ paths: $ref: '#/components/schemas/QueryPersistDto' required: true responses: - "200": - description: Persist query successful + "404": + description: "Database, query or user could not be found" content: application/json: schema: - $ref: '#/components/schemas/QueryDto' - "403": - description: Not allowed to persist query + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Persist query is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Image not supported + "412": + description: Query is already persisted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, query or user could not be found" + "403": + description: Not allowed to persist query content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "412": - description: Query is already persisted + "400": + description: Image not supported content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "405": - description: Persist query is not permitted + "200": + description: Persist query successful content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/QueryDto' security: - bearerAuth: [] - basicAuth: [] @@ -1323,12 +1324,16 @@ paths: $ref: '#/components/schemas/SignupRequestDto' required: true responses: - "201": - description: Created user + "417": + description: User with e-mail already exists content: application/json: schema: - $ref: '#/components/schemas/UserBriefDto' + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Parameters are not well-formed (likely email) + content: + application/json: {} "409": description: User with username already exists content: @@ -1341,16 +1346,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Parameters are not well-formed (likely email) - content: - application/json: {} - "417": - description: User with e-mail already exists + "201": + description: Created user content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/UserBriefDto' /api/semantic/ontology: get: tags: @@ -1420,6 +1421,9 @@ paths: application/json: schema: $ref: '#/components/schemas/BannerMessageBriefDto' + security: + - bearerAuth: [] + - basicAuth: [] /api/image: get: tags: @@ -1447,6 +1451,12 @@ paths: $ref: '#/components/schemas/ImageCreateDto' required: true responses: + "201": + description: Created image + content: + application/json: + schema: + $ref: '#/components/schemas/ImageDto' "400": description: Image specification is invalid content: @@ -1459,12 +1469,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "201": - description: Created image - content: - application/json: - schema: - $ref: '#/components/schemas/ImageDto' security: - bearerAuth: [] - basicAuth: [] @@ -1530,38 +1534,32 @@ paths: $ref: '#/components/schemas/IdentifierSaveDto' required: true responses: - "503": - description: DataCite system did not respond - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Insufficient access rights or authorities + "406": + description: Creating identifier not allowed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Failed to find database, table or view" + "405": + description: Creating identifier not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "204": - description: Identifier could not be created + "502": + description: Query information could not be retrieved content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Identifier form contains invalid request data + "409": + description: Identifier for this resource already exists content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Identifier for this resource already exists + "403": + description: Insufficient access rights or authorities content: application/json: schema: @@ -1572,20 +1570,26 @@ paths: application/json: schema: $ref: '#/components/schemas/IdentifierDto' - "405": - description: Creating identifier not permitted + "503": + description: DataCite system did not respond content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "502": - description: Query information could not be retrieved + "400": + description: Identifier form contains invalid request data content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "406": - description: Creating identifier not allowed + "204": + description: Identifier could not be created + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: "Failed to find database, table or view" content: application/json: schema: @@ -1632,43 +1636,43 @@ paths: $ref: '#/components/schemas/DatabaseCreateDto' required: true responses: - "403": - description: Database create permission is missing or grant permissions - at broker service failed + "409": + description: Query store could not be created content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Query store could not be created + "503": + description: Connection to the database failed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Container, user or database could not be found" + "400": + description: Database create query is malformed or image is not supported content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "201": - description: Created a new database + "403": + description: Database create permission is missing or grant permissions + at broker service failed content: application/json: schema: - $ref: '#/components/schemas/DatabaseBriefDto' - "400": - description: Database create query is malformed or image is not supported + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: "Container, user or database could not be found" content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "503": - description: Connection to the database failed + "201": + description: Created a new database content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/DatabaseBriefDto' security: - bearerAuth: [] - basicAuth: [] @@ -1684,12 +1688,6 @@ paths: schema: type: string responses: - "404": - description: User not found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Count databases content: @@ -1698,6 +1696,12 @@ paths: type: array items: $ref: '#/components/schemas/DatabaseDto' + "404": + description: User not found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' /api/database/{databaseId}/view: get: tags: @@ -1712,6 +1716,12 @@ paths: type: integer format: int64 responses: + "404": + description: Database or user could not be found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "200": description: Find views successfully content: @@ -1719,13 +1729,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/ViewBriefDto' - "404": - description: Database or user could not be found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/ViewBriefDto' security: - bearerAuth: [] - basicAuth: [] @@ -1748,50 +1752,50 @@ paths: $ref: '#/components/schemas/ViewCreateDto' required: true responses: - "423": - description: Create view resulted in an invalid query statement + "404": + description: Database or user could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "201": - description: Create view successfully + "405": + description: Create view is not permitted content: application/json: schema: - $ref: '#/components/schemas/ViewBriefDto' - "401": - description: Credentials missing + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Create view query is malformed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "405": - description: Create view is not permitted + "403": + description: Credentials missing content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "503": - description: Connection to the database failed + "401": + description: Credentials missing content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Create view query is malformed + "503": + description: Connection to the database failed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Credentials missing + "201": + description: Create view successfully content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' - "404": - description: Database or user could not be found + $ref: '#/components/schemas/ViewBriefDto' + "423": + description: Create view resulted in an invalid query statement content: application/json: schema: @@ -1813,26 +1817,26 @@ paths: type: integer format: int64 responses: - "403": - description: List tables not permitted + "200": + description: List tables content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + type: array + items: + $ref: '#/components/schemas/TableBriefDto' "404": description: Database could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "200": - description: List tables + "403": + description: List tables not permitted content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/TableBriefDto' + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -1855,14 +1859,14 @@ paths: $ref: '#/components/schemas/TableCreateDto' required: true responses: - "403": - description: Create table not permitted + "409": + description: Create table conflicts with existing table name content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Create table conflicts with existing table name + "400": + description: Create table query is malformed content: application/json: schema: @@ -1873,18 +1877,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "201": - description: Created a new table + "403": + description: Create table not permitted content: application/json: schema: - $ref: '#/components/schemas/TableBriefDto' - "400": - description: Create table query is malformed + $ref: '#/components/schemas/ApiErrorDto' + "201": + description: Created a new table content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' + $ref: '#/components/schemas/TableBriefDto' security: - bearerAuth: [] - basicAuth: [] @@ -1916,8 +1920,8 @@ paths: responses: "202": description: Import table data successfully - "400": - description: Table data is malformed + "422": + description: Could not import csv via sidecar content: application/json: schema: @@ -1940,8 +1944,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Could not import csv via sidecar + "400": + description: Table data is malformed content: application/json: schema: @@ -1968,20 +1972,22 @@ paths: schema: type: boolean responses: - "501": - description: Image is not supported + "405": + description: Find all queries is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, container or user could not be found" + "200": + description: List queries content: application/json: schema: - $ref: '#/components/schemas/ApiErrorDto' - "504": - description: Query store failed to select query + type: array + items: + $ref: '#/components/schemas/QueryBriefDto' + "501": + description: Image is not supported content: application/json: schema: @@ -1992,16 +1998,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "200": - description: List queries - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/QueryBriefDto' - "405": - description: Find all queries is not permitted + "404": + description: "Database, container or user could not be found" content: application/json: schema: @@ -2013,6 +2011,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "504": + description: Query store failed to select query + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -2060,32 +2064,32 @@ paths: $ref: '#/components/schemas/ExecuteStatementDto' required: true responses: - "403": - description: Execute query not permitted + "404": + description: "Database, query or user could not be found" content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Image is not supported + "417": + description: Could not parse columns content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "417": - description: Could not parse columns + "403": + description: Execute query not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Could not store query in query store + "400": + description: Image is not supported content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, query or user could not be found" + "409": + description: Could not store query in query store content: application/json: schema: @@ -2133,12 +2137,6 @@ paths: $ref: '#/components/schemas/ContainerCreateRequestDto' required: true responses: - "201": - description: Created a new container - content: - application/json: - schema: - $ref: '#/components/schemas/ContainerBriefDto' "409": description: Container name already exists content: @@ -2151,6 +2149,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "201": + description: Created a new container + content: + application/json: + schema: + $ref: '#/components/schemas/ContainerBriefDto' security: - bearerAuth: [] - basicAuth: [] @@ -2193,24 +2197,12 @@ paths: schema: type: string responses: - "400": - description: Filter params are invalid - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "417": description: Generated query or uri is malformed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: Could not find ontology - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "422": description: Ontology does not have rdf or sparql endpoint content: @@ -2225,6 +2217,18 @@ paths: type: array items: $ref: '#/components/schemas/EntityDto' + "404": + description: Could not find ontology + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Filter params are invalid + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -2248,12 +2252,6 @@ paths: type: integer format: int64 responses: - "417": - description: Generated query is malformed - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Suggested table semantics successfully content: @@ -2262,14 +2260,20 @@ paths: type: array items: $ref: '#/components/schemas/TableColumnEntityDto' + "422": + description: Ontology does not have rdf or sparql endpoint + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "404": description: Could not find the table content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Ontology does not have rdf or sparql endpoint + "417": + description: Generated query is malformed content: application/json: schema: @@ -2303,12 +2307,6 @@ paths: type: integer format: int64 responses: - "417": - description: Generated query is malformed - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Suggested table column semantics successfully content: @@ -2317,14 +2315,20 @@ paths: type: array items: $ref: '#/components/schemas/TableColumnEntityDto' - "404": - description: Could not find the table column + "422": + description: Ontology does not have rdf or sparql endpoint content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Ontology does not have rdf or sparql endpoint + "417": + description: Generated query is malformed + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Could not find the table column content: application/json: schema: @@ -2366,21 +2370,14 @@ paths: schema: type: string responses: - "400": - description: "Identifier could not be exported, the requested style is not\ - \ known" - content: - text/bibliography: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "503": - description: Identifier could not exported from database as it is not reachable + "404": + description: Identifier could not be found content: text/csv: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Exported resource was not found + "410": + description: Failed to retrieve from S3 endpoint content: text/csv: schema: @@ -2391,14 +2388,21 @@ paths: text/csv: schema: $ref: '#/components/schemas/ApiErrorDto' - "410": - description: Failed to retrieve from S3 endpoint + "409": + description: Exported resource was not found content: text/csv: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: Identifier could not be found + "400": + description: "Identifier could not be exported, the requested style is not\ + \ known" + content: + text/bibliography: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "503": + description: Identifier could not exported from database as it is not reachable content: text/csv: schema: @@ -2482,12 +2486,6 @@ paths: type: integer format: int64 responses: - "404": - description: Database or exchange could not be found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "503": description: Connection to the broker service could not be established content: @@ -2500,6 +2498,12 @@ paths: application/json: schema: $ref: '#/components/schemas/DatabaseDto' + "404": + description: Database or exchange could not be found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -2530,37 +2534,37 @@ paths: format: date-time responses: "422": - description: Sidecar operation could not be completed - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' - "201": - description: Created identifier + description: Sidecar operation could not be completed content: application/json: schema: - $ref: '#/components/schemas/IdentifierDto' + $ref: '#/components/schemas/ApiErrorDto' "409": description: Failed to export file from sidecar content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Images is not supported or table/query is malformed + "403": + description: Operation is not allowed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "410": - description: Blob storage operation could not be completed + "503": + description: Database connection could not be established content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "503": - description: Database connection could not be established + "201": + description: Created identifier + content: + application/json: + schema: + $ref: '#/components/schemas/IdentifierDto' + "410": + description: Blob storage operation could not be completed content: application/json: schema: @@ -2571,8 +2575,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Operation is not allowed + "400": + description: Images is not supported or table/query is malformed content: application/json: schema: @@ -2594,6 +2598,12 @@ paths: type: integer format: int64 responses: + "200": + description: Found database access + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseAccessDto' "403": description: No access to this database content: @@ -2606,12 +2616,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: [] @@ -2641,18 +2645,18 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, view or user could not be found" - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Find view successfully content: application/json: schema: $ref: '#/components/schemas/ViewDto' + "404": + description: "Database, view or user could not be found" + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -2675,14 +2679,14 @@ paths: type: integer format: int64 responses: - "405": - description: Delete view is not permitted + "403": + description: Deletion not allowed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, view or user could not be found" + "503": + description: Connection to the database failed content: application/json: schema: @@ -2693,22 +2697,22 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "423": - description: Delete view resulted in an invalid query statement + "405": + description: Delete view is not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "200": - description: Delete view successfully - "503": - description: Connection to the database failed + "423": + description: Delete view resulted in an invalid query statement content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Deletion not allowed + "200": + description: Delete view successfully + "404": + description: "Database, view or user could not be found" content: application/json: schema: @@ -2748,20 +2752,14 @@ paths: type: integer format: int64 responses: - "400": - description: Pagination not in valid range or find data query is malformed - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "200": description: Find data successfully content: application/json: schema: $ref: '#/components/schemas/QueryResultDto' - "404": - description: "Database, view, container or user could not be found" + "400": + description: Pagination not in valid range or find data query is malformed content: application/json: schema: @@ -2772,6 +2770,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "404": + description: "Database, view, container or user could not be found" + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -2795,14 +2799,14 @@ paths: type: integer format: int64 responses: - "400": - description: Pagination not in valid range or find data query is malformed + "409": + description: Could not count query data content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "404": - description: "Database, view, container or user could not be found" + "403": + description: Count data not allowed content: application/json: schema: @@ -2814,14 +2818,14 @@ paths: schema: type: integer format: int64 - "409": - description: Could not count query data + "400": + description: Pagination not in valid range or find data query is malformed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "403": - description: Count data not allowed + "404": + description: "Database, view, container or user could not be found" content: application/json: schema: @@ -2849,12 +2853,6 @@ paths: type: integer format: int64 responses: - "200": - description: Find table successfully - content: - application/json: - schema: - $ref: '#/components/schemas/TableDto' "503": description: Could not communicate with the broker service content: @@ -2873,6 +2871,12 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "200": + description: Find table successfully + content: + application/json: + schema: + $ref: '#/components/schemas/TableDto' security: - bearerAuth: [] - basicAuth: [] @@ -2895,8 +2899,6 @@ paths: type: integer format: int64 responses: - "202": - description: Delete table successfully "400": description: Delete table query resulted in an invalid query statement content: @@ -2915,6 +2917,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "202": + description: Delete table successfully security: - bearerAuth: [] - basicAuth: [] @@ -2944,6 +2948,12 @@ paths: type: string format: date-time responses: + "422": + description: Could not import csv via sidecar + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "400": description: Table data is malformed or image is not supported content: @@ -2956,25 +2966,19 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "202": - description: Get table data count successfully - content: - '*/*': - schema: - type: integer - format: int64 "403": description: Access to the database is forbidden content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "422": - description: Could not import csv via sidecar + "202": + description: Get table data count successfully content: - application/json: + '*/*': schema: - $ref: '#/components/schemas/ApiErrorDto' + type: integer + format: int64 security: - bearerAuth: [] - basicAuth: [] @@ -3003,32 +3007,26 @@ paths: schema: type: string responses: - "403": - description: Execute query not permitted + "409": + description: Export of query failed content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Image is not supported + "200": + description: Executed query content: - application/json: + '*/*': schema: - $ref: '#/components/schemas/ApiErrorDto' + type: object "410": description: Could not find in S3 storage content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "200": - description: Executed query - content: - '*/*': - schema: - type: object - "404": - description: Database or query could not be found + "403": + description: Execute query not permitted content: application/json: schema: @@ -3039,8 +3037,14 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Export of query failed + "400": + description: Image is not supported + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Database or query could not be found content: application/json: schema: @@ -3093,6 +3097,12 @@ paths: schema: type: string responses: + "417": + description: Could not parse columns + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' "403": description: Execute query not permitted content: @@ -3105,8 +3115,8 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "417": - description: Could not parse columns + "409": + description: Could not store query in query store content: application/json: schema: @@ -3117,12 +3127,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "409": - description: Could not store query in query store - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "202": description: Executed query content: @@ -3152,20 +3156,20 @@ paths: type: integer format: int64 responses: - "403": - description: Execute query not permitted + "417": + description: Could not parse columns content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "400": - description: Image is not supported + "403": + description: Execute query not permitted content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' - "417": - description: Could not parse columns + "400": + description: Image is not supported content: application/json: schema: @@ -3214,18 +3218,18 @@ paths: type: integer format: int64 responses: - "200": - description: Found container - content: - application/json: - schema: - $ref: '#/components/schemas/ContainerDto' "404": description: Container image could not be found content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' + "200": + description: Found container + content: + application/json: + schema: + $ref: '#/components/schemas/ContainerDto' delete: tags: - container-endpoint @@ -3239,18 +3243,18 @@ paths: type: integer format: int64 responses: - "404": - description: Container not found - content: - application/json: - schema: - $ref: '#/components/schemas/ApiErrorDto' "202": description: Deleted container successfully content: '*/*': schema: type: object + "404": + description: Container not found + content: + application/json: + schema: + $ref: '#/components/schemas/ApiErrorDto' security: - bearerAuth: [] - basicAuth: [] @@ -4149,6 +4153,8 @@ components: ForeignKeyDto: type: object properties: + name: + type: string columns: type: array items: @@ -6686,6 +6692,9 @@ components: null_element: type: string example: NA + line_termination: + type: string + example: \r\n ExecuteStatementDto: required: - statement @@ -6785,14 +6794,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 @@ -6982,12 +6991,12 @@ components: type: string identifier: $ref: '#/components/schemas/Identifier' + apaName: + type: string bibtexName: type: string ieeeName: type: string - apaName: - type: string Database: type: object properties: @@ -7081,6 +7090,8 @@ components: fkid: type: integer format: int64 + name: + type: string table: $ref: '#/components/schemas/Table' referencedTable: @@ -7965,6 +7976,8 @@ components: lastModified: type: string format: date-time + processedConstraints: + type: boolean TableColumn: type: object properties: @@ -8110,6 +8123,8 @@ components: uid: type: integer format: int64 + name: + type: string table: $ref: '#/components/schemas/Table' columns: @@ -8177,13 +8192,28 @@ components: columns: type: array items: - $ref: '#/components/schemas/TableColumn' + $ref: '#/components/schemas/ViewColumn' created: type: string format: date-time lastModified: type: string format: date-time + ViewColumn: + type: object + properties: + id: + type: integer + format: int64 + alias: + type: string + ordinalPosition: + type: integer + format: int32 + view: + $ref: '#/components/schemas/View' + column: + $ref: '#/components/schemas/TableColumn' QueryBriefDto: required: - created diff --git a/Makefile b/Makefile index 19f2a215f992f569b36e5ed73ee0c0be06022840..45e493ffa90202c9268578eeb2213fc712c74cd4 100644 --- a/Makefile +++ b/Makefile @@ -222,7 +222,5 @@ test: test-backend test-frontend teardown: ./bin/teardown.sh -docs: build-docker - docker compose up -d || docker compose down - cd .docs && bash generate_swagger.sh || docker compose down - docker compose down +build-api: build-docker + bash .docs/.swagger/swagger-generate.sh