{"openapi":"3.1.0","info":{"title":"KG Integration Service","description":"Service for performing KG requests.","version":"1.3.34"},"paths":{"/v1/health":{"get":{"summary":"Healthcheck if all service dependencies are online.","description":"Return response that represents status of the database and kafka connections.","operationId":"get_db_status_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/spaces/":{"get":{"tags":["Knowledge Graph spaces"],"summary":"List all available to user KG spaces.","operationId":"list_spaces_v1_spaces__get","parameters":[{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceListResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Knowledge Graph spaces"],"summary":"Check a list of spaces if they exist.","operationId":"check_spaces_v1_spaces__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceListResponseSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceListSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/spaces/{space}":{"get":{"tags":["Knowledge Graph spaces"],"summary":"Get space details by space name.","operationId":"get_space_v1_spaces__space__get","parameters":[{"name":"space","in":"path","required":true,"schema":{"type":"string","title":"Space"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/spaces/create":{"post":{"tags":["Knowledge Graph spaces"],"summary":"Create a KG space.","operationId":"create_space_v1_spaces_create_post","parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Name of the space to be created","title":"Name"},"description":"Name of the space to be created"},{"name":"username","in":"query","required":true,"schema":{"type":"string","description":"Name of the creator","title":"Username"},"description":"Name of the creator"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/spaces/create/project/{project_code}":{"post":{"tags":["Knowledge Graph spaces"],"summary":"Create a KG space for an HDC project.","operationId":"create_space_for_project_v1_spaces_create_project__project_code__post","parameters":[{"name":"project_code","in":"path","required":true,"schema":{"type":"string","title":"Project Code"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/spaces/create/dataset/{dataset_code}":{"post":{"tags":["Knowledge Graph spaces"],"summary":"Create a KG space for a dataset.","operationId":"create_space_for_dataset_v1_spaces_create_dataset__dataset_code__post","parameters":[{"name":"dataset_code","in":"path","required":true,"schema":{"type":"string","title":"Dataset Code"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/":{"get":{"tags":["Knowledge Graph metadata"],"summary":"List uploaded instances for given parameters.","operationId":"get_metadata_v1_metadata__get","parameters":[{"name":"space","in":"query","required":true,"schema":{"type":"string","title":"Space"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","title":"Type"}},{"name":"stage","in":"query","required":true,"schema":{"type":"string","enum":["IN_PROGRESS","RELEASED"],"title":"Stage"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataKGResponseListSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Knowledge Graph metadata"],"summary":"Check a list of metadata if they were uploaded.","operationId":"check_metadata_v1_metadata__post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataQueryListSchema"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataListSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/{metadata_id}":{"get":{"tags":["Knowledge Graph metadata"],"summary":"Get metadata by ID.","operationId":"get_metadata_by_id_v1_metadata__metadata_id__get","parameters":[{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Metadata Id"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/upload/{kg_instance_id}/{dataset_id}":{"get":{"tags":["Knowledge Graph metadata"],"summary":"Download metadata from KG by ID to specified dataset.","operationId":"download_metadata_by_id_v1_metadata_upload__kg_instance_id___dataset_id__get","parameters":[{"name":"kg_instance_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Kg Instance Id"}},{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}},{"name":"uploader","in":"query","required":true,"schema":{"type":"string","title":"Uploader"}},{"name":"filename","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/refresh/{metadata_id}":{"get":{"tags":["Knowledge Graph metadata"],"summary":"Refresh metadata from KG.","operationId":"update_metadata_from_kg_to_hdc_v1_metadata_refresh__metadata_id__get","parameters":[{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Metadata Id"}},{"name":"username","in":"query","required":true,"schema":{"type":"string","title":"Username"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/refresh/dataset/{dataset_id}":{"get":{"tags":["Knowledge Graph metadata"],"summary":"Bulk refresh metadata from KG for whole dataset.","operationId":"bulk_update_metadata_from_kg_to_hdc_v1_metadata_refresh_dataset__dataset_id__get","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}},{"name":"username","in":"query","required":true,"schema":{"type":"string","title":"Username"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/upload":{"post":{"tags":["Knowledge Graph metadata"],"summary":"Upload metadata to given KG space.","operationId":"upload_metadata_v1_metadata_upload_post","parameters":[{"name":"space","in":"query","required":true,"schema":{"type":"string","title":"Space"}},{"name":"metadata_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Metadata Id"}},{"name":"dataset_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}},{"name":"uploader","in":"query","required":true,"schema":{"type":"string","title":"Uploader"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Metadata"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataKGResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/update/{metadata_id}":{"put":{"tags":["Knowledge Graph metadata"],"summary":"Update metadata upload with given ID.","operationId":"update_metadata_from_hdc_to_kg_v1_metadata_update__metadata_id__put","parameters":[{"name":"metadata_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Metadata Id"}},{"name":"space","in":"query","required":true,"schema":{"type":"string","title":"Space"}},{"name":"filename","in":"query","required":true,"schema":{"type":"string","title":"Filename"}},{"name":"dataset_id","in":"query","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}},{"name":"uploader","in":"query","required":true,"schema":{"type":"string","title":"Uploader"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Metadata"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataKGResponseSchema"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/update/dataset/{dataset_id}":{"put":{"tags":["Knowledge Graph metadata"],"summary":"Update metadata uploads for the whole dataset","operationId":"bulk_update_metadata_from_hdc_to_kg_v1_metadata_update_dataset__dataset_id__put","parameters":[{"name":"dataset_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Dataset Id"}},{"name":"username","in":"query","required":true,"schema":{"type":"string","title":"Username"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/metadata/{kg_instance_id}":{"delete":{"tags":["Knowledge Graph metadata"],"summary":"Delete metadata with given ID.","operationId":"delete_metadata_v1_metadata__kg_instance_id__delete","parameters":[{"name":"kg_instance_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Kg Instance Id"}},{"name":"username","in":"query","required":true,"schema":{"type":"string","title":"Username"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{space}":{"get":{"tags":["Knowledge Graph users"],"summary":"Get users on the given space","operationId":"get_user_list_v1_users__space__get","parameters":[{"name":"space","in":"path","required":true,"schema":{"type":"string","title":"Space"}},{"name":"role","in":"query","required":true,"schema":{"type":"string","enum":["administrator","editor","viewer"],"title":"Role"}},{"name":"token","in":"query","required":false,"schema":{"type":"string","description":"Authentication bearer token from HDC Keycloak","title":"Token"},"description":"Authentication bearer token from HDC Keycloak"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/users/{project_id}/{username}":{"post":{"tags":["Knowledge Graph users"],"summary":"Invite user to all project datasets","operationId":"invite_user_v1_users__project_id___username__post","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Project Id"}},{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"role","in":"query","required":true,"schema":{"type":"string","enum":["administrator","editor","viewer"],"title":"Role"}}],"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 users"],"summary":"Remove user from all project datasets","operationId":"remove_user_v1_users__project_id___username__delete","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Project Id"}},{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"role","in":"query","required":true,"schema":{"type":"string","enum":["administrator","editor","viewer"],"title":"Role"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Knowledge Graph users"],"summary":"Update user permissions","operationId":"update_user_v1_users__project_id___username__put","parameters":[{"name":"project_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Project Id"}},{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}},{"name":"current_role","in":"query","required":true,"schema":{"type":"string","enum":["administrator","editor","viewer"],"title":"Current Role"}},{"name":"new_role","in":"query","required":true,"schema":{"type":"string","enum":["administrator","editor","viewer"],"title":"New Role"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/":{"get":{"summary":"Root","description":"For testing if service's up.","operationId":"root_v1__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MetadataKGResponseListSchema":{"properties":{"result":{"items":{},"type":"array","title":"Result"}},"type":"object","required":["result"],"title":"MetadataKGResponseListSchema"},"MetadataKGResponseSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"creator":{"type":"string","format":"uuid","title":"Creator"},"type":{"items":{"type":"string"},"type":"array","title":"Type"},"space":{"type":"string","title":"Space"},"revision":{"type":"string","title":"Revision"},"data":{"additionalProperties":true,"type":"object","title":"Data"}},"type":"object","required":["id","creator","type","space","revision","data"],"title":"MetadataKGResponseSchema"},"MetadataListSchema":{"properties":{"metadata":{"items":{"$ref":"#/components/schemas/MetadataSchema"},"type":"array","title":"Metadata"}},"type":"object","required":["metadata"],"title":"MetadataListSchema"},"MetadataQueryListSchema":{"properties":{"metadata":{"items":{"$ref":"#/components/schemas/MetadataQuerySchema"},"type":"array","title":"Metadata"}},"type":"object","required":["metadata"],"title":"MetadataQueryListSchema"},"MetadataQuerySchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"}},"type":"object","required":["id"],"title":"MetadataQuerySchema"},"MetadataSchema":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"metadata_id":{"type":"string","format":"uuid","title":"Metadata Id"},"kg_instance_id":{"type":"string","format":"uuid","title":"Kg Instance Id"},"dataset_id":{"type":"string","format":"uuid","title":"Dataset Id"},"direction":{"type":"string","title":"Direction"},"uploaded_at":{"type":"string","format":"date-time","title":"Uploaded At"}},"type":"object","required":["id","metadata_id","kg_instance_id","dataset_id","direction","uploaded_at"],"title":"MetadataSchema"},"SpaceListResponseSchema":{"properties":{"spaces":{"items":{"$ref":"#/components/schemas/SpaceResponseSchema"},"type":"array","title":"Spaces"}},"type":"object","required":["spaces"],"title":"SpaceListResponseSchema","description":"Default schema for multiple announcements in response."},"SpaceListSchema":{"properties":{"spaces":{"items":{"$ref":"#/components/schemas/SpaceSchema"},"type":"array","title":"Spaces"}},"type":"object","required":["spaces"],"title":"SpaceListSchema"},"SpaceResponseSchema":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"SpaceResponseSchema","description":"Response schema for requests."},"SpaceSchema":{"properties":{"name":{"type":"string","title":"Name"},"creator":{"type":"string","title":"Creator"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["name","creator","created_at"],"title":"SpaceSchema"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}