From 087ca0727bcb99a94ecb133670a768bd989c5349 Mon Sep 17 00:00:00 2001 From: sanderegg <35365065+sanderegg@users.noreply.github.com> Date: Fri, 26 Aug 2022 14:37:54 +0200 Subject: [PATCH] add tags --- api/specs/storage/openapi.yaml | 43 ++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/api/specs/storage/openapi.yaml b/api/specs/storage/openapi.yaml index bd410c51edcc..0f4844f1fce3 100644 --- a/api/specs/storage/openapi.yaml +++ b/api/specs/storage/openapi.yaml @@ -23,11 +23,18 @@ servers: enum: - v0 default: v0 +tags: + - name: maintenance + - name: location + - name: dataset + - name: file paths: /: get: summary: Service health-check endpoint description: Some general information on the API and state of the service behind + tags: + - maintenance operationId: health_check responses: "200": @@ -43,6 +50,8 @@ paths: get: summary: checks status of self and connected services operationId: get_status + tags: + - maintenance responses: "200": description: returns app status check @@ -51,6 +60,8 @@ paths: get: summary: Lists available storage locations operationId: get_storage_locations + tags: + - location parameters: - name: user_id in: query @@ -71,6 +82,8 @@ paths: post: summary: Manually triggers the synchronisation of the file meta data table in the database operationId: synchronise_meta_data_table + tags: + - location parameters: - name: location_id in: path @@ -103,6 +116,8 @@ paths: get: summary: Lists all dataset's metadata operationId: get_datasets_metadata + tags: + - dataset parameters: - name: location_id in: path @@ -128,6 +143,8 @@ paths: get: summary: Lists all file's metadata operationId: get_files_metadata + tags: + - file parameters: - name: location_id in: path @@ -158,6 +175,8 @@ paths: get: summary: Get dataset metadata operationId: get_files_metadata_dataset + tags: + - dataset parameters: - name: location_id in: path @@ -188,6 +207,8 @@ paths: get: summary: Get file metadata operationId: get_file_metadata + tags: + - file parameters: - name: file_id in: path @@ -218,6 +239,8 @@ paths: get: summary: Gets download link for file at location operationId: download_file + tags: + - file parameters: - name: file_id in: path @@ -256,6 +279,8 @@ paths: put: summary: Returns upload object operationId: upload_file + tags: + - file parameters: - name: file_id in: path @@ -316,6 +341,8 @@ paths: delete: summary: Deletes file operationId: delete_file + tags: + - file parameters: - name: file_id in: path @@ -342,6 +369,8 @@ paths: post: summary: Asks the server to abort the upload and revert to the last valid version if any operationId: abort_upload_file + tags: + - file parameters: - name: file_id in: path @@ -368,6 +397,8 @@ paths: post: summary: Asks the server to complete the upload operationId: complete_upload_file + tags: + - file parameters: - name: file_id in: path @@ -427,6 +458,8 @@ paths: post: summary: Check for upload completion operationId: is_completed_upload_file + tags: + - file parameters: - name: future_id in: path @@ -462,6 +495,8 @@ paths: post: summary: Returns the temporary access credentials for the user storage space operationId: get_or_create_temporary_s3_access + tags: + - file parameters: - name: user_id in: query @@ -482,6 +517,8 @@ paths: post: summary: Returns metadata for all files matching a pattern operationId: search_files_starting_with + tags: + - file parameters: - name: user_id in: query @@ -508,6 +545,8 @@ paths: post: summary: Deep copies of all data from source to destination project in s3 operationId: copy_folders_from_project + tags: + - file parameters: - name: user_id in: query @@ -543,6 +582,8 @@ paths: delete: summary: Deletes all objects within a node_id or within a project_id if node_id is omitted operationId: delete_folders_of_project + tags: + - file parameters: - name: folder_id in: path @@ -567,6 +608,8 @@ paths: post: summary: Copy as soft link operationId: copy_as_soft_link + tags: + - file parameters: - name: file_id in: path