{"openapi":"3.1.0","info":{"title":"BFF Web","description":"Backend for Frontend Web","version":"0.1.0"},"paths":{"/v1/activity-logs/{dataset_code}":{"get":{"tags":["Activity Logs","Activity Logs"],"summary":"Fetch activity logs of a dataset from the search service","description":"Fetch activity logs of a dataset.","operationId":"get_v1_activity_logs__dataset_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Code"},"name":"dataset_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_code}/announcements/":{"get":{"tags":["Announcements"],"summary":"List project announcements","description":"List announcements for project.\n\nThe \"project\" type notifications are queried using the notification service.","operationId":"list_project_announcements_v1_project__project_code__announcements__get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Announcements"],"summary":"Create project announcement","description":"Create announcement for project.\n\nThe \"project\" type notification is created using the notification service.","operationId":"create_project_announcement_v1_project__project_code__announcements__post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAnnouncementCreateSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/maintenance-announcements/":{"get":{"tags":["Announcements"],"summary":"List maintenance announcements","operationId":"list_maintenance_announcements_v1_maintenance_announcements__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Announcements"],"summary":"Create maintenance announcement","operationId":"create_maintenance_announcement_v1_maintenance_announcements__post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/maintenance-announcements/{announcement_id}":{"get":{"tags":["Announcements"],"summary":"Get maintenance announcement","operationId":"get_maintenance_announcement_v1_maintenance_announcements__announcement_id__get","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Announcement Id"},"name":"announcement_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Announcements"],"summary":"Delete maintenance announcement","operationId":"delete_maintenance_announcement_v1_maintenance_announcements__announcement_id__delete","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Announcement Id"},"name":"announcement_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Announcements"],"summary":"Update maintenance announcement","operationId":"update_maintenance_announcement_v1_maintenance_announcements__announcement_id__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Announcement Id"},"name":"announcement_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/maintenance-announcements/{announcement_id}/unsubscribe":{"post":{"tags":["Announcements"],"summary":"Unsubscribe from maintenance announcement","operationId":"unsubscribe_from_maintenance_announcement_v1_maintenance_announcements__announcement_id__unsubscribe_post","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Announcement Id"},"name":"announcement_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/archive":{"get":{"tags":["Archive","Archive"],"summary":"Get a zip preview given file id","operationId":"get_v1_archive_get","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/lastlogin":{"put":{"tags":["Auth","Auth"],"summary":"Update user's last login time","operationId":"put_v1_users_lastlogin_put","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/user/status":{"get":{"tags":["Auth","Auth"],"summary":"Get users status given the email","operationId":"get_v1_user_status_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/user/account":{"put":{"tags":["Auth","Auth"],"summary":"user account mangaement","operationId":"put_v1_user_account_put","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/contact":{"post":{"tags":["Contact Us","Contact Us"],"summary":"Sends a contact us message","operationId":"post_v1_contact_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/users":{"put":{"tags":["User Activate","User Activate"],"summary":"Activate AD user account on platform","description":"This method allow user to activate the AD user account on platform.","operationId":"put_v1_users_put","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/users/default":{"get":{"tags":["User Activate","User Activate"],"summary":"Get","operationId":"get_v1_users_default_get","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["User Activate","User Activate"],"summary":"Post","operationId":"post_v1_users_default_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/containers/{project_id}/users/{username}":{"put":{"tags":["Container User Actions","Container User Actions"],"summary":"Update a users role in project","description":"This method allow user to update user's permission to a specific dataset.","operationId":"put_v1_containers__project_id__users__username__put","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Container User Actions","Container User Actions"],"summary":"Add user to project","description":"This method allow container admin to add single user to a specific container with permission.","operationId":"post_v1_containers__project_id__users__username__post","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Container User Actions","Container User Actions"],"summary":"Remove user from project","description":"This method allow user to remove user's permission to a specific container.","operationId":"delete_v1_containers__project_id__users__username__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/containers/":{"get":{"tags":["Containers","Containers"],"summary":"List and query all projects","description":"List and Query on all projects\".","operationId":"get_v1_containers__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/containers/{project_id}":{"put":{"tags":["Containers","Containers"],"summary":"Update a project","description":"Update a project.","operationId":"put_v1_containers__project_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/containers/{project_id}/folder":{"post":{"tags":["Folder Create","Folder Create"],"summary":"Create a folder in a project","operationId":"post_v1_containers__project_id__folder_post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/platform":{"get":{"tags":["User Operations","User Operations"],"summary":"List all users in platform","description":"This method allow user to fetch all registered users in the platform.","operationId":"get_v1_users_platform_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/containers/{project_id}/admins":{"get":{"tags":["User Operations","User Operations"],"summary":"List all admins in a project","description":"This method allow user to fetch all admins under a specific project with permissions.","operationId":"get_v1_containers__project_id__admins_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/containers/{project_id}/users":{"get":{"tags":["User Operations","User Operations"],"summary":"List all users in a project","description":"This method allow user to fetch all users under a specific dataset with permissions.","operationId":"get_v1_containers__project_id__users_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/containers/{project_id}/roles/users/stats":{"get":{"tags":["User Operations","User Operations"],"summary":"List number of users per realm role for a project","description":"Allow user to fetch number of users under admin, collaborator, and contributor roles for a project.","operationId":"get_v1_containers__project_id__roles_users_stats_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{username}/containers":{"post":{"tags":["User Operations","User Operations"],"summary":"Query user's containers","description":"This method allow user to get the user's permission towards all containers (except default).","operationId":"post_v1_users__username__containers_post","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/request/copy/{project_code}":{"get":{"tags":["Copy Request","Copy Request"],"summary":"List copy requests by project_code","operationId":"get_v1_request_copy__project_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Copy Request","Copy Request"],"summary":"Update a copy request","operationId":"put_v1_request_copy__project_code__put","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Copy Request","Copy Request"],"summary":"Create a copy request","operationId":"post_v1_request_copy__project_code__post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/request/copy/{project_code}/files":{"get":{"tags":["Copy Request","Copy Request"],"summary":"View a copy requests files","operationId":"get_v1_request_copy__project_code__files_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Copy Request","Copy Request"],"summary":"Update file status in a copy request","operationId":"put_v1_request_copy__project_code__files_put","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Copy Request","Copy Request"],"summary":"Update file status in a copy request","operationId":"patch_v1_request_copy__project_code__files_patch","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/request/copy/{project_code}/pending-files":{"get":{"tags":["Copy Request","Copy Request"],"summary":"Get pending files remaining in a copy request","operationId":"get_v1_request_copy__project_code__pending_files_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/manifests":{"get":{"tags":["Attribute Templates","Attribute Templates"],"summary":"List attribute templates by project_code","description":"List attribute templates by project_code.","operationId":"get_v1_data_manifests_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Create a new attribute template","description":"Create a new attribute template.","operationId":"post_v1_data_manifests_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/data/manifest/{manifest_id}":{"get":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Get attribute template by id","description":"Get an attribute template by id.","operationId":"get_v1_data_manifest__manifest_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Manifest Id"},"name":"manifest_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Update attributes or name of a template by id","description":"Update attributes or name of template by id.","operationId":"put_v1_data_manifest__manifest_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Manifest Id"},"name":"manifest_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Delete an attribute template","description":"Delete an attribute template.","operationId":"delete_v1_data_manifest__manifest_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Manifest Id"},"name":"manifest_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/file/{file_id}/manifest":{"put":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Update attributes of template attached to a file","operationId":"put_v1_file__file_id__manifest_put","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/import/manifest":{"post":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Import attribute template from portal as JSON","operationId":"post_v1_import_manifest_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/file/manifest/query":{"post":{"tags":["Attribute Templates","Attribute Templates"],"summary":"List template attributes for file","operationId":"post_v1_file_manifest_query_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/file/attributes/attach":{"post":{"tags":["Attribute Templates","Attribute Templates"],"summary":"Attach attributes to files or folders","operationId":"post_v1_file_attributes_attach_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/datasets/{dataset_id_or_code}":{"get":{"tags":["Dataset","Dataset"],"summary":"Get dataset by id or code","operationId":"get_v1_datasets__dataset_id_or_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id Or Code"},"name":"dataset_id_or_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset","Dataset"],"summary":"Delete dataset by id or code","operationId":"delete_v1_datasets__dataset_id_or_code__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id Or Code"},"name":"dataset_id_or_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/{dataset_id}":{"put":{"tags":["Dataset","Dataset"],"summary":"Update dataset by id","operationId":"put_v1_datasets__dataset_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/datasets/":{"get":{"tags":["Dataset","Dataset"],"summary":"List all Datasets user can access.","operationId":"__call___v1_datasets__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Dataset","Dataset"],"summary":"Create dataset","operationId":"post_v1_datasets__post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/dataset-version-sharing-requests/":{"get":{"tags":["Dataset","Dataset"],"summary":"List all Dataset Version Sharing Requests user can access.","operationId":"__call___v1_dataset_version_sharing_requests__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Dataset","Dataset"],"summary":"Create Dataset Version Sharing Request","operationId":"post_v1_dataset_version_sharing_requests__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDatasetVersionSharingRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset-version-sharing-requests/{version_sharing_request_id}":{"patch":{"tags":["Dataset","Dataset"],"summary":"Update Dataset Version Sharing Request","operationId":"patch_v1_dataset_version_sharing_requests__version_sharing_request_id__patch","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Version Sharing Request Id"},"name":"version_sharing_request_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Session-Id"},"name":"session-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Authorization"},"name":"authorization","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDatasetVersionSharingRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/files":{"get":{"tags":["Dataset","Dataset"],"summary":"List dataset files","operationId":"get_v1_dataset__dataset_id__files_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Dataset","Dataset"],"summary":"Recieve the file list from a project and Copy them under the dataset","operationId":"put_v1_dataset__dataset_id__files_put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Dataset","Dataset"],"summary":"Move dataset files","operationId":"post_v1_dataset__dataset_id__files_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset","Dataset"],"summary":"Remove dataset files","operationId":"delete_v1_dataset__dataset_id__files_delete","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/files/{file_id}":{"post":{"tags":["Dataset","Dataset"],"summary":"update files within the dataset","operationId":"post_v1_dataset__dataset_id__files__file_id__post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/file/tasks":{"get":{"tags":["Dataset","Dataset"],"summary":"Dataset Tasks","operationId":"get_v1_dataset__dataset_id__file_tasks_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset","Dataset"],"summary":"Dataset Tasks","operationId":"delete_v1_dataset__dataset_id__file_tasks_delete","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/central-node/upload":{"post":{"tags":["Central Node","Central Node"],"summary":"Initiate file upload to the Central Node.","operationId":"init_v1_central_node_upload_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitFileUploadSchema"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/central-node/upload/{upload_key}":{"get":{"tags":["Central Node","Central Node"],"summary":"Wait file upload authorization from the Central Node.","operationId":"wait_v1_central_node_upload__upload_key__get","parameters":[{"required":true,"schema":{"type":"string","title":"Upload Key"},"name":"upload_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Authorization"},"name":"authorization","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/folder":{"post":{"tags":["Dataset Folder","Dataset Folder"],"summary":"Create empty folder in dataset","operationId":"post_v1_dataset__dataset_id__folder_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/invitations":{"post":{"tags":["Invitations","Invitations"],"summary":"create invitation in platform","description":"This method allow to create invitation in platform.","operationId":"post_v1_invitations_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/invitation/check/{email}":{"get":{"tags":["Invitations","Invitations"],"summary":"Check if a user exists","operationId":"get_v1_invitation_check__email__get","parameters":[{"required":true,"schema":{"type":"string","title":"Email"},"name":"email","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/register/invitation/{invitation_code}":{"get":{"tags":["Invitations","Invitations"],"summary":"Get invitation by invitation code","operationId":"get_v1_register_invitation__invitation_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Invitation Code"},"name":"invitation_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invitations","Invitations"],"summary":"Get invitation by invitation code","operationId":"post_v1_register_invitation__invitation_code__post","parameters":[{"required":true,"schema":{"type":"string","title":"Invitation Code"},"name":"invitation_code","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterPOST"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/invitation-list":{"post":{"tags":["Invitations","Invitations"],"summary":"list invitations","description":"This method allow to get all pending users from invitation links.","operationId":"post_v1_invitation_list_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/invitations/external":{"get":{"tags":["Invitations","Invitations"],"summary":"check if external registration is enabled","operationId":"get_v1_invitations_external_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/dataset/{dataset_id}/schema":{"post":{"tags":["Dataset Schema","Dataset Schema"],"summary":"Create a new schema","operationId":"post_v1_dataset__dataset_id__schema_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schema/{schema_id}":{"get":{"tags":["Dataset Schema","Dataset Schema"],"summary":"Get a schema by id","operationId":"get_v1_dataset__dataset_id__schema__schema_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Schema Id"},"name":"schema_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Dataset Schema","Dataset Schema"],"summary":"Update a schema","operationId":"put_v1_dataset__dataset_id__schema__schema_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Schema Id"},"name":"schema_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset Schema","Dataset Schema"],"summary":"Delete a schema by id","operationId":"delete_v1_dataset__dataset_id__schema__schema_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Schema Id"},"name":"schema_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schema/list":{"post":{"tags":["Dataset Schema","Dataset Schema"],"summary":"List schemas","operationId":"post_v1_dataset__dataset_id__schema_list_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL/{template_id}":{"get":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"Get schema template by id","operationId":"get_v1_dataset__dataset_id__schemaTPL__template_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"Update schema template by id","operationId":"put_v1_dataset__dataset_id__schemaTPL__template_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"Delete schema template by id","operationId":"delete_v1_dataset__dataset_id__schemaTPL__template_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL":{"post":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"Create schema template","operationId":"post_v1_dataset__dataset_id__schemaTPL_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/schemaTPL/list":{"post":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"List and query schema templates","operationId":"post_v1_dataset__dataset_id__schemaTPL_list_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/schemaTPL/list":{"post":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"List and query schema templates","operationId":"post_v1_dataset_schemaTPL_list_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/dataset/schemaTPL/default/{template_id}":{"get":{"tags":["Dataset Schema Template","Dataset Schema Template"],"summary":"Get default schema","operationId":"get_v1_dataset_schemaTPL_default__template_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Template Id"},"name":"template_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/bids-validate":{"post":{"tags":["Dataset Validate","Dataset Validate"],"summary":"verify a bids dataset.","operationId":"post_v1_dataset_bids_validate_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/dataset/bids-validate/{dataset_code}":{"get":{"tags":["Dataset Validate","Dataset Validate"],"summary":"get bids validate result","operationId":"get_v1_dataset_bids_validate__dataset_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Code"},"name":"dataset_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/publish":{"post":{"tags":["Dataset Version","Dataset Version"],"summary":"Publish a new dataset version","operationId":"post_v1_dataset__dataset_id__publish_post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/publish/status":{"get":{"tags":["Dataset Version","Dataset Version"],"summary":"Get status of publish","operationId":"get_v1_dataset__dataset_id__publish_status_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/download/pre":{"get":{"tags":["Dataset Version","Dataset Version"],"summary":"pre-download for dataset","operationId":"get_v1_dataset__dataset_id__download_pre_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/dataset/{dataset_id}/versions":{"get":{"tags":["Dataset Version","Dataset Version"],"summary":"Get dataset versions","operationId":"get_v1_dataset__dataset_id__versions_get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v2/download/pre":{"post":{"tags":["Download","Download"],"summary":"Start a file or folder download","operationId":"post_v2_download_pre_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v2/dataset/download/pre":{"post":{"tags":["Download","Download"],"summary":"Start a file or folder download in a dataset","operationId":"post_v2_dataset_download_pre_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/task-stream":{"delete":{"tags":["Task stream","Task stream"],"summary":"Delete a user's old file status events","description":"Delete a user's old file status events.","operationId":"call_delete_task_stream_v1_task_stream_delete","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/email":{"post":{"tags":["Email","Email"],"summary":"Send notification email to platform users","description":"Send notification email to platform users.","operationId":"post_v1_email_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/actions/tasks":{"get":{"tags":["File Ops","File Ops"],"summary":"Get task information","operationId":"get_v1_files_actions_tasks_get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["File Ops","File Ops"],"summary":"Delete tasks","operationId":"delete_v1_files_actions_tasks_delete","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/actions":{"post":{"tags":["File Ops","File Ops"],"summary":"invoke an async file operation job","operationId":"post_v1_files_actions_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/files/bulk/detail":{"post":{"tags":["File Meta","File Meta"],"summary":"Bulk get files from list of ids","operationId":"post_v1_files_bulk_detail_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/file/delete":{"delete":{"tags":["File Meta","File Meta"],"summary":"Delete single file","description":"Proxy for entity info file DELETE API, handles permission checks.","operationId":"delete_v1_file_delete_delete","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/delete":{"get":{"tags":["File Meta","File Meta"],"summary":"Get files marked for deletion in bulk","description":"Proxy for entity info file DELETE API, handles permission checks.","operationId":"get_v1_files_delete_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["File Meta","File Meta"],"summary":"Mark files for deletion in bulk","description":"Proxy for entity info file DELETE API, handles permission checks.","operationId":"delete_v1_files_delete_delete","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/restore":{"put":{"tags":["File Meta","File Meta"],"summary":"Restore file","description":"Proxy for entity info file RESTORE API, handles permission checks.","operationId":"put_v1_files_restore_put","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/bin/restore":{"patch":{"tags":["File Meta","File Meta"],"summary":"Restore file from bin","description":"Proxy for entity info file RESTORE API, handles permission checks.","operationId":"patch_v1_files_bin_restore_patch","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/files/meta":{"get":{"tags":["File Meta","File Meta"],"summary":"List files in project or folder","description":"Proxy for entity info file META API, handles permission checks.","operationId":"get_v1_files_meta_get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections/{collection_id}/files":{"get":{"tags":["Collections","Collections"],"summary":"get items from vfolder","description":"Get items from vfolder.","operationId":"get_v1_collections__collection_id__files_get","parameters":[{"required":true,"schema":{"type":"string","title":"Collection Id"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Collections","Collections"],"summary":"Get items from vfolder","description":"Add items to vfolder.","operationId":"post_v1_collections__collection_id__files_post","parameters":[{"required":true,"schema":{"type":"string","title":"Collection Id"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Collections","Collections"],"summary":"Remove items from vfolder","description":"Delete items from vfolder.","operationId":"delete_v1_collections__collection_id__files_delete","parameters":[{"required":true,"schema":{"type":"string","title":"Collection Id"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections":{"get":{"tags":["Collections","Collections"],"summary":"Get collections","operationId":"get_v1_collections_get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Collections","Collections"],"summary":"Create collection","operationId":"post_v1_collections_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/collections/{collection_id}":{"delete":{"tags":["Collections","Collections"],"summary":"delete collection","operationId":"delete_v1_collections__collection_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Collection Id"},"name":"collection_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/spaces":{"get":{"tags":["Knowledge Graph"],"summary":"List KG spaces","description":"List spaces for user.","operationId":"list_spaces_v1_kg_spaces_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Knowledge Graph"],"summary":"Check a list of spaces","description":"List spaces for user.","operationId":"check_spaces_v1_kg_spaces_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/spaces/{space}":{"get":{"tags":["Knowledge Graph"],"summary":"Get space information","description":"Get space information.","operationId":"get_space_v1_kg_spaces__space__get","parameters":[{"required":true,"schema":{"type":"string","title":"Space"},"name":"space","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/spaces/create":{"post":{"tags":["Knowledge Graph"],"summary":"Create new KG space","description":"Create new KG space with any given name.","operationId":"create_space_v1_kg_spaces_create_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/kg/spaces/create/project/{project_code}":{"post":{"tags":["Knowledge Graph"],"summary":"Create new KG space for project","description":"Create new KG space for project with project code as a name.","operationId":"create_space_for_project_v1_kg_spaces_create_project__project_code__post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/spaces/create/dataset/{dataset_code}":{"post":{"tags":["Knowledge Graph"],"summary":"Create new KG space for dataset","description":"Create new KG space for dataset with dataset code as a name.","operationId":"create_space_for_dataset_v1_kg_spaces_create_dataset__dataset_code__post","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Code"},"name":"dataset_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata":{"get":{"tags":["Knowledge Graph"],"summary":"List metadata","description":"List metadata.","operationId":"list_metadata_v1_kg_metadata_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"post":{"tags":["Knowledge Graph"],"summary":"Check a list of metadata","description":"Check a list of metadata.","operationId":"check_metadata_v1_kg_metadata_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/{metadata_id}":{"get":{"tags":["Knowledge Graph"],"summary":"Get metadata information","description":"Get metadata information.","operationId":"get_metadata_v1_kg_metadata__metadata_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Metadata Id"},"name":"metadata_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/upload":{"post":{"tags":["Knowledge Graph"],"summary":"Upload new metadata to KG","description":"Upload new metadata to KG space.","operationId":"upload_metadata_v1_kg_metadata_upload_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/upload/{kg_instance_id}/{dataset_id}":{"get":{"tags":["Knowledge Graph"],"summary":"Upload new metadata to dataset from KG","operationId":"upload_metadata_from_kg_v1_kg_metadata_upload__kg_instance_id___dataset_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Kg Instance Id"},"name":"kg_instance_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/refresh/{metadata_id}":{"get":{"tags":["Knowledge Graph"],"summary":"Refresh metadata from KG","operationId":"refresh_metadata_from_kg_v1_kg_metadata_refresh__metadata_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Metadata Id"},"name":"metadata_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/refresh/dataset/{dataset_id}":{"get":{"tags":["Knowledge Graph"],"summary":"Refresh metadata from KG","operationId":"bulk_refresh_metadata_from_kg_v1_kg_metadata_refresh_dataset__dataset_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/update/{metadata_id}":{"put":{"tags":["Knowledge Graph"],"summary":"Update existing metadata on KG","description":"Update existing metadata or upload a new instance to KG.","operationId":"update_metadata_v1_kg_metadata_update__metadata_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Metadata Id"},"name":"metadata_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/update/dataset/{dataset_id}":{"put":{"tags":["Knowledge Graph"],"summary":"Bulk update existing metadata on KG","description":"Update existing metadata or upload a new instance to KG.","operationId":"bulk_update_metadata_v1_kg_metadata_update_dataset__dataset_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Dataset Id"},"name":"dataset_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/metadata/delete/{metadata_id}":{"delete":{"tags":["Knowledge Graph"],"summary":"Delete existing metadata in KG","description":"Delete existing metadata in KG.","operationId":"delete_metadata_v1_kg_metadata_delete__metadata_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Metadata Id"},"name":"metadata_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/users/{space}":{"get":{"tags":["Knowledge Graph"],"summary":"List space users","description":"List space's users.","operationId":"list_users_v1_kg_users__space__get","parameters":[{"required":true,"schema":{"type":"string","title":"Space"},"name":"space","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/kg/users/{project_id}/{username}":{"put":{"tags":["Knowledge Graph"],"summary":"Update user role in all the projects datasets","description":"Update user role in all the projects datasets.","operationId":"update_user_v1_kg_users__project_id___username__put","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Knowledge Graph"],"summary":"Add user to all the projects datasets","description":"Add new user to all the projects datasets.","operationId":"add_user_v1_kg_users__project_id___username__post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Knowledge Graph"],"summary":"Remove user from all the projects datasets","description":"Remove user from all the projects datasets.","operationId":"remove_user_v1_kg_users__project_id___username__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vm/user":{"get":{"tags":["VM account management"],"summary":"Find user by username","operationId":"find_user_v1_vm_user_get","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/vm/user/reset":{"post":{"tags":["VM account management"],"summary":"Reset VM user password","operationId":"reset_password_v1_vm_user_reset_post","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/user-notifications":{"get":{"tags":["Notifications"],"summary":"List notifications for the current user","description":"List notifications for the current user.","operationId":"get_current_user_notifications_v1_user_notifications_get","parameters":[{"required":false,"schema":{"type":"integer","title":"Page"},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size"},"name":"page_size","in":"query"},{"required":false,"schema":{"type":"string","title":"Sort By"},"name":"sort_by","in":"query"},{"required":false,"schema":{"type":"string","title":"Sort Order"},"name":"sort_order","in":"query"},{"required":false,"schema":{"$ref":"#/components/schemas/NotificationType"},"name":"type","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/{file_id}/preview/":{"get":{"tags":["Preview","Preview"],"summary":"Preview a file","operationId":"get_v1__file_id__preview__get","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/{file_id}/preview/stream":{"get":{"tags":["Preview","Preview"],"summary":"Preview a file with streaming response","operationId":"get_v1__file_id__preview_stream_get","parameters":[{"required":true,"schema":{"type":"string","title":"File Id"},"name":"file_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_id}":{"get":{"tags":["Project","Project"],"summary":"Get project by id","operationId":"get_v1_project__project_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/code/{project_code}":{"get":{"tags":["Project","Project"],"summary":"Get project by code","operationId":"get_v1_project_code__project_code__get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_id}/collections":{"put":{"tags":["Project","Project"],"summary":"Update project collections","operationId":"put_v1_project__project_id__collections_put","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/activity-logs/{project_id}":{"get":{"tags":["Project","Project"],"summary":"Fetch activity logs of a project from the search service","description":"Fetch activity logs of a project.","operationId":"get_v1_project_activity_logs__project_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/projects":{"post":{"tags":["Project","Project"],"summary":"Create a project","description":"This method allow to create a new project in platform.\n\nNotice that top-level container could only be created by site admin.","operationId":"post_v1_projects_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/lineage":{"get":{"tags":["Provenance","Provenance"],"summary":"Lineage","operationId":"get_v1_lineage_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v2/entity/tags":{"post":{"tags":["Tags","Tags"],"summary":"Bulk add or remove tags","operationId":"post_v2_entity_tags_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v2/{entity_id}/tags":{"post":{"tags":["Tags","Tags"],"summary":"Bulk add or remove tags","operationId":"post_v2__entity_id__tags_post","parameters":[{"required":true,"schema":{"type":"string","title":"Entity Id"},"name":"entity_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/user/events":{"get":{"tags":["User Event","User Event"],"summary":"List user events","description":"List user events.","operationId":"get_v1_user_events_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/users/{username}":{"get":{"tags":["Users","Users"],"summary":"Get user by username","operationId":"get_v1_users__username__get","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Users","Users"],"summary":"Update user by username","operationId":"put_v1_users__username__put","parameters":[{"required":true,"schema":{"type":"string","title":"Username"},"name":"username","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/{project_id}/workbench":{"get":{"tags":["Workbench","Workbench"],"summary":"List workbench entries","operationId":"get_v1__project_id__workbench_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Workbench","Workbench"],"summary":"create a workbench entry","operationId":"post_v1__project_id__workbench_post","parameters":[{"required":true,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/resource-request/{request_id}/":{"get":{"tags":["Resource Request","Resource Request"],"summary":"Get a single resource request","description":"Get a single resource request.","operationId":"get_v1_resource_request__request_id___get","parameters":[{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Resource Request","Resource Request"],"summary":"Delete a single resource request","operationId":"delete_v1_resource_request__request_id___delete","parameters":[{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Resource Request","Resource Request"],"summary":"Update a single resource request","operationId":"patch_v1_resource_request__request_id___patch","parameters":[{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateResourceRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/resource-request/{request_id}/complete":{"put":{"tags":["Resource Request","Resource Request"],"summary":"Update an existing resource request as complete","description":"Update an existing resource request as complete.","operationId":"put_v1_resource_request__request_id__complete_put","parameters":[{"required":true,"schema":{"type":"string","title":"Request Id"},"name":"request_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/resource-requests/query":{"post":{"tags":["Resource Request","Resource Request"],"summary":"List resource requests","description":"List resource requests.","operationId":"post_v1_resource_requests_query_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/resource-requests":{"post":{"tags":["Resource Request","Resource Request"],"summary":"Create a new resource request, send email notification","description":"Create a new resource request, send email notification.","operationId":"post_v1_resource_requests_post","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateResourceRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/health":{"get":{"tags":["Health","Health"],"summary":"Health check","operationId":"get_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/project-files/{project_code}/search":{"get":{"tags":["Project Files"],"summary":"Search through project files.","description":"Search through project files.","operationId":"search_v1_project_files__project_code__search_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/size":{"get":{"tags":["Project Files"],"summary":"Get project storage usage.","description":"Get project storage usage.","operationId":"size_v1_project_files__project_code__size_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/statistics":{"get":{"tags":["Project Files"],"summary":"Get project statistics on files and transfer activity limited to user.","description":"Get project statistics on files and transfer activity limited to user.","operationId":"statistics_v1_project_files__project_code__statistics_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project-files/{project_code}/activity":{"get":{"tags":["Project Files"],"summary":"Get project file activity statistic limited to role.","description":"Get project file activity statistic limited to role.","operationId":"activity_v1_project_files__project_code__activity_get","parameters":[{"required":true,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"path"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/favourites":{"get":{"tags":["Favourites","Favourites"],"summary":"Get all favourites for a user","operationId":"get_user_favourites_v1_favourites_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["Favourites","Favourites"],"summary":"Remove many existing favourites","operationId":"delete_favourites_v1_favourites_delete","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"patch":{"tags":["Favourites","Favourites"],"summary":"Pin or unpin many existing favourites","operationId":"pin_unpin_favourites_v1_favourites_patch","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/favourite":{"post":{"tags":["Favourites","Favourites"],"summary":"Favourite an entity","operationId":"create_favourite_v1_favourite_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"delete":{"tags":["Favourites","Favourites"],"summary":"Remove an existing favourite","operationId":"delete_favourite_v1_favourite_delete","parameters":[{"required":true,"schema":{"type":"string","title":"Id"},"name":"id","in":"query"},{"required":true,"schema":{"type":"string","title":"Type"},"name":"type","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Favourites","Favourites"],"summary":"Pin or unpin an existing favourite","operationId":"pin_unpin_favourite_v1_favourite_patch","parameters":[{"required":true,"schema":{"type":"boolean","title":"Pinned"},"name":"pinned","in":"query"},{"required":true,"schema":{"type":"string","title":"Id"},"name":"id","in":"query"},{"required":true,"schema":{"type":"string","title":"Type"},"name":"type","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/visits":{"get":{"tags":["Bridge","Bridge"],"summary":"get JWT user last visits","operationId":"get_visit_v1_visits_get","parameters":[{"required":true,"schema":{"$ref":"#/components/schemas/Entities"},"name":"entity","in":"query"},{"required":true,"schema":{"type":"integer","title":"Last"},"name":"last","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Bridge","Bridge"],"summary":"Compute one visit to the user from JWT","operationId":"add_visit_v1_visits_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVisits"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddVisitsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/guacamole/connection":{"get":{"tags":["Workbench","Workbench"],"summary":"List guacamole connections","operationId":"get_v1_guacamole_connection_get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_code}/files":{"post":{"tags":["V1 Files"],"summary":"proxy to upload service to pre upload file to the target zone","description":"PRE upload and check existence of file in project.","operationId":"project_file_preupload_v1_project__project_code__files_post","parameters":[{"required":true,"schema":{"title":"Project Code"},"name":"project_code","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/POSTProjectFile"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_code}/files/chunks/presigned":{"get":{"tags":["V1 Files"],"summary":"proxy to upload service to generate presigned chunk url","description":"Summary:\n    The api will proxy to upload service and generate presigned url\n    for chunk uploading chunks\n    Path Parameter:\n        - project_code(str): unique identifier of project\n    Parameter:\n        - key(str): file path\n        - upload_id(str): the unique identifier of upload process\n        - chunk_number(int): the number of chunk\nreturn:\n    - result(str): presigned url","operationId":"generate_presigned_url_chunks_v1_project__project_code__files_chunks_presigned_get","parameters":[{"required":true,"schema":{"title":"Project Code"},"name":"project_code","in":"path"},{"required":true,"schema":{"type":"string","title":"Key"},"name":"key","in":"query"},{"required":true,"schema":{"type":"string","title":"Upload Id"},"name":"upload_id","in":"query"},{"required":true,"schema":{"type":"integer","title":"Chunk Number"},"name":"chunk_number","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/project/{project_code}/files/resumable":{"get":{"tags":["V1 Files"],"summary":"list all registered file of specific user","description":"Summary:\n    the api to list ALL registered file in the database. The registered\n    file means the upload process is not finished(either in progress or stop\n    in middle)\nParameter:\n    - project_code: the unique identifier of project\nreturn:\n    - result(list of item entity)","operationId":"project_file_resumable_list_v1_project__project_code__files_resumable_get","parameters":[{"required":true,"schema":{"title":"Project Code"},"name":"project_code","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 Files"],"summary":"resumable upload check","description":"Summary:\n    the api to check the uploaded chunk in the object\n    storage. Afterwards, client will resume the previous\n    upload.\nPayload:\n    - object_infos(List[ObjectInfo]): the list of pairs contains following:\n        - object_path(str): the unique path in object storage\n        - resumable_id(str): the unique identifier for resumable upload\nreturn:\n    - result(list):\n        - object_path(str): the unique path in object storage\n        - resumable_id(str): the unique identifier for resumable upload\n        - chunks_info(dict[str: str]): the pair of chunk_number: etag","operationId":"project_file_resumable_v1_project__project_code__files_resumable_post","parameters":[{"required":true,"schema":{"title":"Project Code"},"name":"project_code","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumableUploadPOST"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResumableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/permissions/metadata":{"get":{"tags":["Permissions","Permissions"],"summary":"Get permission metadata proxy","operationId":"list_metadata_v1_permissions_metadata_get","parameters":[{"required":false,"schema":{"type":"string","title":"Project Code"},"name":"project_code","in":"query"},{"required":false,"schema":{"type":"string","title":"Project Id"},"name":"project_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/lineage/{item_id}/":{"get":{"tags":["Lineage & provenance","Lineage & provenance"],"summary":"Get lineage and provenance for an item","description":"Get lineage and provenance for an item.","operationId":"get_lineage_provenance_v1_lineage__item_id___get","parameters":[{"required":true,"schema":{"type":"string","title":"Item Id"},"name":"item_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AddVisits":{"properties":{"code":{"type":"string","title":"Code"},"entity":{"$ref":"#/components/schemas/Entities"}},"type":"object","required":["code","entity"],"title":"AddVisits"},"AddVisitsResponse":{"properties":{"result":{"type":"string","title":"Result"},"code":{"type":"integer","title":"Code"}},"type":"object","required":["result","code"],"title":"AddVisitsResponse"},"CreateDatasetVersionSharingRequestBody":{"properties":{"version_id":{"type":"string","format":"uuid","title":"Version Id"},"project_code":{"type":"string","title":"Project Code"}},"type":"object","required":["version_id","project_code"],"title":"CreateDatasetVersionSharingRequestBody"},"CreateResourceRequest":{"properties":{"project_id":{"type":"string","title":"Project Id"},"request_for":{"type":"string","title":"Request For"},"message":{"type":"string","title":"Message"}},"type":"object","required":["project_id","request_for","message"],"title":"CreateResourceRequest"},"Entities":{"type":"string","enum":["dataset","project"],"title":"Entities","description":"An enumeration."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InitFileUploadSchema":{"properties":{"file_id":{"type":"string","format":"uuid","title":"File Id"},"session_id":{"type":"string","title":"Session Id"}},"type":"object","required":["file_id","session_id"],"title":"InitFileUploadSchema"},"NotificationType":{"type":"string","enum":["pipeline","copy-request","role-change","project","maintenance"],"title":"NotificationType","description":"Available notification types."},"ObjectInfo":{"properties":{"object_path":{"type":"string","title":"Object Path"},"item_id":{"type":"string","title":"Item Id"},"resumable_id":{"type":"string","title":"Resumable Id"}},"type":"object","required":["object_path","item_id","resumable_id"],"title":"ObjectInfo"},"POSTProjectFile":{"properties":{"operator":{"type":"string","title":"Operator"},"job_type":{"type":"string","title":"Job Type"},"current_folder_node":{"type":"string","title":"Current Folder Node"},"parent_folder_id":{"type":"string","title":"Parent Folder Id"},"data":{"items":{},"type":"array","title":"Data"},"folder_tags":{"items":{"type":"string"},"type":"array","title":"Folder Tags","default":[]}},"type":"object","required":["operator","job_type","current_folder_node","parent_folder_id","data"],"title":"POSTProjectFile"},"ProjectAnnouncementCreateSchema":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"ProjectAnnouncementCreateSchema","description":"Schema for project announcement creation."},"RegisterPOST":{"properties":{"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"first_name":{"type":"string","title":"First Name"},"last_name":{"type":"string","title":"Last Name"}},"type":"object","required":["username","password","first_name","last_name"],"title":"RegisterPOST"},"ResumableResponse":{"properties":{"result":{"type":"object","title":"Result"}},"type":"object","required":["result"],"title":"ResumableResponse"},"ResumableUploadPOST":{"properties":{"object_infos":{"items":{"$ref":"#/components/schemas/ObjectInfo"},"type":"array","title":"Object Infos"}},"type":"object","required":["object_infos"],"title":"ResumableUploadPOST","description":"Pre upload payload model."},"UpdateDatasetVersionSharingRequestBody":{"properties":{"status":{"type":"string","enum":["accepted","declined"],"title":"Status"}},"type":"object","required":["status"],"title":"UpdateDatasetVersionSharingRequestBody"},"UpdateResourceRequest":{"properties":{"connections":{"items":{},"type":"array","title":"Connections"},"container_code":{"type":"string","title":"Container Code"}},"type":"object","required":["connections","container_code"],"title":"UpdateResourceRequest"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}