From 0e18573db53433238adf5c07a08fbeb44db4f771 Mon Sep 17 00:00:00 2001 From: Michele Dolfi Date: Mon, 25 Sep 2023 13:00:03 +0200 Subject: [PATCH] SW api update with DS v7.10.0 Signed-off-by: Michele Dolfi --- deepsearch/cps/apis/public/__init__.py | 3 +- deepsearch/cps/apis/public/api/__init__.py | 2 +- .../cps/apis/public/api/annotate_api.py | 139 ------- ...tion_api.py => document_inspection_api.py} | 268 +++++++++++- deepsearch/cps/apis/public/api/project_api.py | 387 ++++++++++++++++++ deepsearch/cps/apis/public/models/__init__.py | 1 + .../models/ingest_document_qa_request.py | 121 ++++++ docs/apis/public/AnnotateApi.md | 88 ---- ...otationApi.md => DocumentInspectionApi.md} | 194 ++++++++- docs/apis/public/IngestDocumentQARequest.md | 10 + docs/apis/public/ProjectApi.md | 242 +++++++++++ .../swagger-client-generator/swagger-cps.json | 2 +- 12 files changed, 1213 insertions(+), 244 deletions(-) rename deepsearch/cps/apis/public/api/{document_annotation_api.py => document_inspection_api.py} (66%) create mode 100644 deepsearch/cps/apis/public/models/ingest_document_qa_request.py rename docs/apis/public/{DocumentAnnotationApi.md => DocumentInspectionApi.md} (59%) create mode 100644 docs/apis/public/IngestDocumentQARequest.md diff --git a/deepsearch/cps/apis/public/__init__.py b/deepsearch/cps/apis/public/__init__.py index c299653e..3c786324 100644 --- a/deepsearch/cps/apis/public/__init__.py +++ b/deepsearch/cps/apis/public/__init__.py @@ -22,7 +22,7 @@ from deepsearch.cps.apis.public.api.data_flows_api import DataFlowsApi from deepsearch.cps.apis.public.api.data_indices_api import DataIndicesApi from deepsearch.cps.apis.public.api.dictionaries_api import DictionariesApi -from deepsearch.cps.apis.public.api.document_annotation_api import DocumentAnnotationApi +from deepsearch.cps.apis.public.api.document_inspection_api import DocumentInspectionApi from deepsearch.cps.apis.public.api.elastic_api import ElasticApi from deepsearch.cps.apis.public.api.knowledge_graphs_api import KnowledgeGraphsApi from deepsearch.cps.apis.public.api.model_configurations_api import ModelConfigurationsApi @@ -163,6 +163,7 @@ from deepsearch.cps.apis.public.models.import_to_data_catalog_collection_options import ImportToDataCatalogCollectionOptions from deepsearch.cps.apis.public.models.import_to_data_catalog_options import ImportToDataCatalogOptions from deepsearch.cps.apis.public.models.infer_project_data_catalog_category_schema import InferProjectDataCatalogCategorySchema +from deepsearch.cps.apis.public.models.ingest_document_qa_request import IngestDocumentQARequest from deepsearch.cps.apis.public.models.inline_object import InlineObject from deepsearch.cps.apis.public.models.inline_object1 import InlineObject1 from deepsearch.cps.apis.public.models.inline_object2 import InlineObject2 diff --git a/deepsearch/cps/apis/public/api/__init__.py b/deepsearch/cps/apis/public/api/__init__.py index fa73a842..483f42f5 100644 --- a/deepsearch/cps/apis/public/api/__init__.py +++ b/deepsearch/cps/apis/public/api/__init__.py @@ -8,7 +8,7 @@ from deepsearch.cps.apis.public.api.data_flows_api import DataFlowsApi from deepsearch.cps.apis.public.api.data_indices_api import DataIndicesApi from deepsearch.cps.apis.public.api.dictionaries_api import DictionariesApi -from deepsearch.cps.apis.public.api.document_annotation_api import DocumentAnnotationApi +from deepsearch.cps.apis.public.api.document_inspection_api import DocumentInspectionApi from deepsearch.cps.apis.public.api.elastic_api import ElasticApi from deepsearch.cps.apis.public.api.knowledge_graphs_api import KnowledgeGraphsApi from deepsearch.cps.apis.public.api.model_configurations_api import ModelConfigurationsApi diff --git a/deepsearch/cps/apis/public/api/annotate_api.py b/deepsearch/cps/apis/public/api/annotate_api.py index 0a236f52..de06c6ca 100644 --- a/deepsearch/cps/apis/public/api/annotate_api.py +++ b/deepsearch/cps/apis/public/api/annotate_api.py @@ -543,142 +543,3 @@ def get_project_annotator_supported_annotations_with_http_info(self, proj_key, o _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) - - def list_project_inspection_report(self, proj_key, **kwargs): # noqa: E501 - """list_project_inspection_report # noqa: E501 - - Get paginated list of inspection reports for a project # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_project_inspection_report(proj_key, async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param str proj_key: (required) - :param int page: page of the result list - :param int items_per_page: items on one page of the result list - :param str search_string: search keyword - :param int begin_date: begin date of the search date interval - :param int end_date: end date of the search date interval - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: list[InspectionReport] - If the method is called asynchronously, - returns the request thread. - """ - kwargs['_return_http_data_only'] = True - return self.list_project_inspection_report_with_http_info(proj_key, **kwargs) # noqa: E501 - - def list_project_inspection_report_with_http_info(self, proj_key, **kwargs): # noqa: E501 - """list_project_inspection_report # noqa: E501 - - Get paginated list of inspection reports for a project # noqa: E501 - This method makes a synchronous HTTP request by default. To make an - asynchronous HTTP request, please pass async_req=True - >>> thread = api.list_project_inspection_report_with_http_info(proj_key, async_req=True) - >>> result = thread.get() - - :param async_req bool: execute request asynchronously - :param str proj_key: (required) - :param int page: page of the result list - :param int items_per_page: items on one page of the result list - :param str search_string: search keyword - :param int begin_date: begin date of the search date interval - :param int end_date: end date of the search date interval - :param _return_http_data_only: response data without head status code - and headers - :param _preload_content: if False, the urllib3.HTTPResponse object will - be returned without reading/decoding response - data. Default is True. - :param _request_timeout: timeout setting for this request. If one - number provided, it will be total request - timeout. It can also be a pair (tuple) of - (connection, read) timeouts. - :return: tuple(list[InspectionReport], status_code(int), headers(HTTPHeaderDict)) - If the method is called asynchronously, - returns the request thread. - """ - - local_var_params = locals() - - all_params = [ - 'proj_key', - 'page', - 'items_per_page', - 'search_string', - 'begin_date', - 'end_date' - ] - all_params.extend( - [ - 'async_req', - '_return_http_data_only', - '_preload_content', - '_request_timeout' - ] - ) - - for key, val in six.iteritems(local_var_params['kwargs']): - if key not in all_params: - raise ApiTypeError( - "Got an unexpected keyword argument '%s'" - " to method list_project_inspection_report" % key - ) - local_var_params[key] = val - del local_var_params['kwargs'] - # verify the required parameter 'proj_key' is set - if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 - local_var_params['proj_key'] is None): # noqa: E501 - raise ApiValueError("Missing the required parameter `proj_key` when calling `list_project_inspection_report`") # noqa: E501 - - collection_formats = {} - - path_params = {} - if 'proj_key' in local_var_params: - path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 - - query_params = [] - if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 - query_params.append(('page', local_var_params['page'])) # noqa: E501 - if 'items_per_page' in local_var_params and local_var_params['items_per_page'] is not None: # noqa: E501 - query_params.append(('items_per_page', local_var_params['items_per_page'])) # noqa: E501 - if 'search_string' in local_var_params and local_var_params['search_string'] is not None: # noqa: E501 - query_params.append(('search_string', local_var_params['search_string'])) # noqa: E501 - if 'begin_date' in local_var_params and local_var_params['begin_date'] is not None: # noqa: E501 - query_params.append(('begin_date', local_var_params['begin_date'])) # noqa: E501 - if 'end_date' in local_var_params and local_var_params['end_date'] is not None: # noqa: E501 - query_params.append(('end_date', local_var_params['end_date'])) # noqa: E501 - - header_params = {} - - form_params = [] - local_var_files = {} - - body_params = None - # HTTP header `Accept` - header_params['Accept'] = self.api_client.select_header_accept( - ['application/json']) # noqa: E501 - - # Authentication setting - auth_settings = ['Bearer'] # noqa: E501 - - return self.api_client.call_api( - '/project/{proj_key}/annotate/inspection_report', 'GET', - path_params, - query_params, - header_params, - body=body_params, - post_params=form_params, - files=local_var_files, - response_type='list[InspectionReport]', # noqa: E501 - auth_settings=auth_settings, - async_req=local_var_params.get('async_req'), - _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 - _preload_content=local_var_params.get('_preload_content', True), - _request_timeout=local_var_params.get('_request_timeout'), - collection_formats=collection_formats) diff --git a/deepsearch/cps/apis/public/api/document_annotation_api.py b/deepsearch/cps/apis/public/api/document_inspection_api.py similarity index 66% rename from deepsearch/cps/apis/public/api/document_annotation_api.py rename to deepsearch/cps/apis/public/api/document_inspection_api.py index fbd93181..fd30f235 100644 --- a/deepsearch/cps/apis/public/api/document_annotation_api.py +++ b/deepsearch/cps/apis/public/api/document_inspection_api.py @@ -24,7 +24,7 @@ ) -class DocumentAnnotationApi(object): +class DocumentInspectionApi(object): """NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -418,6 +418,272 @@ def get_annotate_document_result_with_http_info(self, proj_key, task_id, **kwarg _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + def ingest_documentqa(self, proj_key, body, **kwargs): # noqa: E501 + """ingest_documentqa # noqa: E501 + + Ingest a document for QA # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.ingest_documentqa(proj_key, body, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param IngestDocumentQARequest body: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: Task + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.ingest_documentqa_with_http_info(proj_key, body, **kwargs) # noqa: E501 + + def ingest_documentqa_with_http_info(self, proj_key, body, **kwargs): # noqa: E501 + """ingest_documentqa # noqa: E501 + + Ingest a document for QA # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.ingest_documentqa_with_http_info(proj_key, body, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param IngestDocumentQARequest body: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(Task, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'proj_key', + 'body' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method ingest_documentqa" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'proj_key' is set + if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 + local_var_params['proj_key'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `proj_key` when calling `ingest_documentqa`") # noqa: E501 + # verify the required parameter 'body' is set + if self.api_client.client_side_validation and ('body' not in local_var_params or # noqa: E501 + local_var_params['body'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `body` when calling `ingest_documentqa`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'proj_key' in local_var_params: + path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'body' in local_var_params: + body_params = local_var_params['body'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/project/{proj_key}/ingest/documentqa', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='Task', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + + def list_project_inspection_report(self, proj_key, **kwargs): # noqa: E501 + """list_project_inspection_report # noqa: E501 + + Get paginated list of inspection reports for a project # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_project_inspection_report(proj_key, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param int page: page of the result list + :param int items_per_page: items on one page of the result list + :param str search_string: search keyword + :param int begin_date: begin date of the search date interval + :param int end_date: end date of the search date interval + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: list[InspectionReport] + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.list_project_inspection_report_with_http_info(proj_key, **kwargs) # noqa: E501 + + def list_project_inspection_report_with_http_info(self, proj_key, **kwargs): # noqa: E501 + """list_project_inspection_report # noqa: E501 + + Get paginated list of inspection reports for a project # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.list_project_inspection_report_with_http_info(proj_key, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param int page: page of the result list + :param int items_per_page: items on one page of the result list + :param str search_string: search keyword + :param int begin_date: begin date of the search date interval + :param int end_date: end date of the search date interval + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(list[InspectionReport], status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'proj_key', + 'page', + 'items_per_page', + 'search_string', + 'begin_date', + 'end_date' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method list_project_inspection_report" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'proj_key' is set + if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 + local_var_params['proj_key'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `proj_key` when calling `list_project_inspection_report`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'proj_key' in local_var_params: + path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 + + query_params = [] + if 'page' in local_var_params and local_var_params['page'] is not None: # noqa: E501 + query_params.append(('page', local_var_params['page'])) # noqa: E501 + if 'items_per_page' in local_var_params and local_var_params['items_per_page'] is not None: # noqa: E501 + query_params.append(('items_per_page', local_var_params['items_per_page'])) # noqa: E501 + if 'search_string' in local_var_params and local_var_params['search_string'] is not None: # noqa: E501 + query_params.append(('search_string', local_var_params['search_string'])) # noqa: E501 + if 'begin_date' in local_var_params and local_var_params['begin_date'] is not None: # noqa: E501 + query_params.append(('begin_date', local_var_params['begin_date'])) # noqa: E501 + if 'end_date' in local_var_params and local_var_params['end_date'] is not None: # noqa: E501 + query_params.append(('end_date', local_var_params['end_date'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/project/{proj_key}/annotate/inspection_report', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='list[InspectionReport]', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def report_inspected_document(self, proj_key, body, **kwargs): # noqa: E501 """report_inspected_document # noqa: E501 diff --git a/deepsearch/cps/apis/public/api/project_api.py b/deepsearch/cps/apis/public/api/project_api.py index 0b8e967c..da923792 100644 --- a/deepsearch/cps/apis/public/api/project_api.py +++ b/deepsearch/cps/apis/public/api/project_api.py @@ -36,6 +36,129 @@ def __init__(self, api_client=None): api_client = ApiClient() self.api_client = api_client + def delete_project_integration_config(self, proj_key, integration_name, **kwargs): # noqa: E501 + """delete_project_integration_config # noqa: E501 + + Delete the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_project_integration_config(proj_key, integration_name, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.delete_project_integration_config_with_http_info(proj_key, integration_name, **kwargs) # noqa: E501 + + def delete_project_integration_config_with_http_info(self, proj_key, integration_name, **kwargs): # noqa: E501 + """delete_project_integration_config # noqa: E501 + + Delete the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.delete_project_integration_config_with_http_info(proj_key, integration_name, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'proj_key', + 'integration_name' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method delete_project_integration_config" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'proj_key' is set + if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 + local_var_params['proj_key'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `proj_key` when calling `delete_project_integration_config`") # noqa: E501 + # verify the required parameter 'integration_name' is set + if self.api_client.client_side_validation and ('integration_name' not in local_var_params or # noqa: E501 + local_var_params['integration_name'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `integration_name` when calling `delete_project_integration_config`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'proj_key' in local_var_params: + path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 + if 'integration_name' in local_var_params: + path_params['integration_name'] = local_var_params['integration_name'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/project/{proj_key}/integrations/{integration_name}', 'DELETE', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def get_project_default_values(self, proj_key, **kwargs): # noqa: E501 """get_project_default_values # noqa: E501 @@ -150,6 +273,134 @@ def get_project_default_values_with_http_info(self, proj_key, **kwargs): # noqa _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + def get_project_integration_config(self, proj_key, integration_name, **kwargs): # noqa: E501 + """get_project_integration_config # noqa: E501 + + Get the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_project_integration_config(proj_key, integration_name, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param bool decode_secrets: Project owners can retrieve decoded secrets + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: object + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.get_project_integration_config_with_http_info(proj_key, integration_name, **kwargs) # noqa: E501 + + def get_project_integration_config_with_http_info(self, proj_key, integration_name, **kwargs): # noqa: E501 + """get_project_integration_config # noqa: E501 + + Get the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.get_project_integration_config_with_http_info(proj_key, integration_name, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param bool decode_secrets: Project owners can retrieve decoded secrets + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: tuple(object, status_code(int), headers(HTTPHeaderDict)) + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'proj_key', + 'integration_name', + 'decode_secrets' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method get_project_integration_config" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'proj_key' is set + if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 + local_var_params['proj_key'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `proj_key` when calling `get_project_integration_config`") # noqa: E501 + # verify the required parameter 'integration_name' is set + if self.api_client.client_side_validation and ('integration_name' not in local_var_params or # noqa: E501 + local_var_params['integration_name'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `integration_name` when calling `get_project_integration_config`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'proj_key' in local_var_params: + path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 + if 'integration_name' in local_var_params: + path_params['integration_name'] = local_var_params['integration_name'] # noqa: E501 + + query_params = [] + if 'decode_secrets' in local_var_params and local_var_params['decode_secrets'] is not None: # noqa: E501 + query_params.append(('decode_secrets', local_var_params['decode_secrets'])) # noqa: E501 + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/project/{proj_key}/integrations/{integration_name}', 'GET', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type='object', # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) + def provision_project_packages(self, proj_key, **kwargs): # noqa: E501 """provision_project_packages # noqa: E501 @@ -399,3 +650,139 @@ def update_project_default_values_with_http_info(self, proj_key, default_values, _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats) + + def update_project_integration_config(self, proj_key, integration_name, config, **kwargs): # noqa: E501 + """update_project_integration_config # noqa: E501 + + Update the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_project_integration_config(proj_key, integration_name, config, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param object config: (required) + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + kwargs['_return_http_data_only'] = True + return self.update_project_integration_config_with_http_info(proj_key, integration_name, config, **kwargs) # noqa: E501 + + def update_project_integration_config_with_http_info(self, proj_key, integration_name, config, **kwargs): # noqa: E501 + """update_project_integration_config # noqa: E501 + + Update the config for a given project integration # noqa: E501 + This method makes a synchronous HTTP request by default. To make an + asynchronous HTTP request, please pass async_req=True + >>> thread = api.update_project_integration_config_with_http_info(proj_key, integration_name, config, async_req=True) + >>> result = thread.get() + + :param async_req bool: execute request asynchronously + :param str proj_key: (required) + :param str integration_name: (required) + :param object config: (required) + :param _return_http_data_only: response data without head status code + and headers + :param _preload_content: if False, the urllib3.HTTPResponse object will + be returned without reading/decoding response + data. Default is True. + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :return: None + If the method is called asynchronously, + returns the request thread. + """ + + local_var_params = locals() + + all_params = [ + 'proj_key', + 'integration_name', + 'config' + ] + all_params.extend( + [ + 'async_req', + '_return_http_data_only', + '_preload_content', + '_request_timeout' + ] + ) + + for key, val in six.iteritems(local_var_params['kwargs']): + if key not in all_params: + raise ApiTypeError( + "Got an unexpected keyword argument '%s'" + " to method update_project_integration_config" % key + ) + local_var_params[key] = val + del local_var_params['kwargs'] + # verify the required parameter 'proj_key' is set + if self.api_client.client_side_validation and ('proj_key' not in local_var_params or # noqa: E501 + local_var_params['proj_key'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `proj_key` when calling `update_project_integration_config`") # noqa: E501 + # verify the required parameter 'integration_name' is set + if self.api_client.client_side_validation and ('integration_name' not in local_var_params or # noqa: E501 + local_var_params['integration_name'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `integration_name` when calling `update_project_integration_config`") # noqa: E501 + # verify the required parameter 'config' is set + if self.api_client.client_side_validation and ('config' not in local_var_params or # noqa: E501 + local_var_params['config'] is None): # noqa: E501 + raise ApiValueError("Missing the required parameter `config` when calling `update_project_integration_config`") # noqa: E501 + + collection_formats = {} + + path_params = {} + if 'proj_key' in local_var_params: + path_params['proj_key'] = local_var_params['proj_key'] # noqa: E501 + if 'integration_name' in local_var_params: + path_params['integration_name'] = local_var_params['integration_name'] # noqa: E501 + + query_params = [] + + header_params = {} + + form_params = [] + local_var_files = {} + + body_params = None + if 'config' in local_var_params: + body_params = local_var_params['config'] + # HTTP header `Accept` + header_params['Accept'] = self.api_client.select_header_accept( + ['application/json']) # noqa: E501 + + # HTTP header `Content-Type` + header_params['Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 + ['application/json']) # noqa: E501 + + # Authentication setting + auth_settings = ['Bearer'] # noqa: E501 + + return self.api_client.call_api( + '/project/{proj_key}/integrations/{integration_name}', 'POST', + path_params, + query_params, + header_params, + body=body_params, + post_params=form_params, + files=local_var_files, + response_type=None, # noqa: E501 + auth_settings=auth_settings, + async_req=local_var_params.get('async_req'), + _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 + _preload_content=local_var_params.get('_preload_content', True), + _request_timeout=local_var_params.get('_request_timeout'), + collection_formats=collection_formats) diff --git a/deepsearch/cps/apis/public/models/__init__.py b/deepsearch/cps/apis/public/models/__init__.py index 08f34743..d60d1071 100644 --- a/deepsearch/cps/apis/public/models/__init__.py +++ b/deepsearch/cps/apis/public/models/__init__.py @@ -136,6 +136,7 @@ from deepsearch.cps.apis.public.models.import_to_data_catalog_collection_options import ImportToDataCatalogCollectionOptions from deepsearch.cps.apis.public.models.import_to_data_catalog_options import ImportToDataCatalogOptions from deepsearch.cps.apis.public.models.infer_project_data_catalog_category_schema import InferProjectDataCatalogCategorySchema +from deepsearch.cps.apis.public.models.ingest_document_qa_request import IngestDocumentQARequest from deepsearch.cps.apis.public.models.inline_object import InlineObject from deepsearch.cps.apis.public.models.inline_object1 import InlineObject1 from deepsearch.cps.apis.public.models.inline_object2 import InlineObject2 diff --git a/deepsearch/cps/apis/public/models/ingest_document_qa_request.py b/deepsearch/cps/apis/public/models/ingest_document_qa_request.py new file mode 100644 index 00000000..7012328e --- /dev/null +++ b/deepsearch/cps/apis/public/models/ingest_document_qa_request.py @@ -0,0 +1,121 @@ +# coding: utf-8 + +""" + Corpus Processing Service (CPS) API + + No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) # noqa: E501 + + The version of the OpenAPI document: 2.0.0 + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from deepsearch.cps.apis.public.configuration import Configuration + + +class IngestDocumentQARequest(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'source': 'object' + } + + attribute_map = { + 'source': 'source' + } + + def __init__(self, source=None, local_vars_configuration=None): # noqa: E501 + """IngestDocumentQARequest - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._source = None + self.discriminator = None + + self.source = source + + @property + def source(self): + """Gets the source of this IngestDocumentQARequest. # noqa: E501 + + + :return: The source of this IngestDocumentQARequest. # noqa: E501 + :rtype: object + """ + return self._source + + @source.setter + def source(self, source): + """Sets the source of this IngestDocumentQARequest. + + + :param source: The source of this IngestDocumentQARequest. # noqa: E501 + :type: object + """ + if self.local_vars_configuration.client_side_validation and source is None: # noqa: E501 + raise ValueError("Invalid value for `source`, must not be `None`") # noqa: E501 + + self._source = source + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, IngestDocumentQARequest): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, IngestDocumentQARequest): + return True + + return self.to_dict() != other.to_dict() diff --git a/docs/apis/public/AnnotateApi.md b/docs/apis/public/AnnotateApi.md index 63fa80a8..03683bd2 100644 --- a/docs/apis/public/AnnotateApi.md +++ b/docs/apis/public/AnnotateApi.md @@ -8,7 +8,6 @@ Method | HTTP request | Description [**generate_project_object_annotations_async**](AnnotateApi.md#generate_project_object_annotations_async) | **POST** /project/{proj_key}/object_annotations_async | [**get_cached_annotator_metadata**](AnnotateApi.md#get_cached_annotator_metadata) | **POST** /project/{proj_key}/annotator/metadata | [**get_project_annotator_supported_annotations**](AnnotateApi.md#get_project_annotator_supported_annotations) | **POST** /project/{proj_key}/annotate/supported_annotations | -[**list_project_inspection_report**](AnnotateApi.md#list_project_inspection_report) | **GET** /project/{proj_key}/annotate/inspection_report | # **generate_project_object_annotations** @@ -327,90 +326,3 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) -# **list_project_inspection_report** -> list[InspectionReport] list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - - - -Get paginated list of inspection reports for a project - -### Example - -* Api Key Authentication (Bearer): -```python -from __future__ import print_function -import time -import deepsearch.cps.apis.public -from deepsearch.cps.apis.public.rest import ApiException -from pprint import pprint -# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 -# See configuration.py for a list of all supported configuration parameters. -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1" -) - -# The client must configure the authentication and authorization parameters -# in accordance with the API server security policy. -# Examples for each auth method are provided below, use the example that -# satisfies your auth use case. - -# Configure API key authorization: Bearer -configuration = deepsearch.cps.apis.public.Configuration( - host = "http://localhost/api/cps/public/v1", - api_key = { - 'Authorization': 'YOUR_API_KEY' - } -) -# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed -# configuration.api_key_prefix['Authorization'] = 'Bearer' - -# Enter a context with an instance of the API client -with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: - # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.AnnotateApi(api_client) - proj_key = 'proj_key_example' # str | -page = 56 # int | page of the result list (optional) -items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) -search_string = 'search_string_example' # str | search keyword (optional) -begin_date = 56 # int | begin date of the search date interval (optional) -end_date = 56 # int | end date of the search date interval (optional) - - try: - api_response = api_instance.list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) - pprint(api_response) - except ApiException as e: - print("Exception when calling AnnotateApi->list_project_inspection_report: %s\n" % e) -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **proj_key** | **str**| | - **page** | **int**| page of the result list | [optional] - **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] - **search_string** | **str**| search keyword | [optional] - **begin_date** | **int**| begin date of the search date interval | [optional] - **end_date** | **int**| end date of the search date interval | [optional] - -### Return type - -[**list[InspectionReport]**](InspectionReport.md) - -### Authorization - -[Bearer](../README.md#Bearer) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -**200** | Reports | - | -**0** | Unexpected error. | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/apis/public/DocumentAnnotationApi.md b/docs/apis/public/DocumentInspectionApi.md similarity index 59% rename from docs/apis/public/DocumentAnnotationApi.md rename to docs/apis/public/DocumentInspectionApi.md index 15f1e3e5..a3de2385 100644 --- a/docs/apis/public/DocumentAnnotationApi.md +++ b/docs/apis/public/DocumentInspectionApi.md @@ -1,13 +1,15 @@ -# deepsearch.cps.apis.public.DocumentAnnotationApi +# deepsearch.cps.apis.public.DocumentInspectionApi All URIs are relative to *http://localhost/api/cps/public/v1* Method | HTTP request | Description ------------- | ------------- | ------------- -[**annotate_document**](DocumentAnnotationApi.md#annotate_document) | **POST** /project/{proj_key}/annotate/document | -[**delete_document_annotation_result**](DocumentAnnotationApi.md#delete_document_annotation_result) | **DELETE** /project/{proj_key}/annotate/document/results/{document_hash} | -[**get_annotate_document_result**](DocumentAnnotationApi.md#get_annotate_document_result) | **GET** /project/{proj_key}/annotate/document/tasks/{task_id} | -[**report_inspected_document**](DocumentAnnotationApi.md#report_inspected_document) | **POST** /project/{proj_key}/annotate/document/report | +[**annotate_document**](DocumentInspectionApi.md#annotate_document) | **POST** /project/{proj_key}/annotate/document | +[**delete_document_annotation_result**](DocumentInspectionApi.md#delete_document_annotation_result) | **DELETE** /project/{proj_key}/annotate/document/results/{document_hash} | +[**get_annotate_document_result**](DocumentInspectionApi.md#get_annotate_document_result) | **GET** /project/{proj_key}/annotate/document/tasks/{task_id} | +[**ingest_documentqa**](DocumentInspectionApi.md#ingest_documentqa) | **POST** /project/{proj_key}/ingest/documentqa | +[**list_project_inspection_report**](DocumentInspectionApi.md#list_project_inspection_report) | **GET** /project/{proj_key}/annotate/inspection_report | +[**report_inspected_document**](DocumentInspectionApi.md#report_inspected_document) | **POST** /project/{proj_key}/annotate/document/report | # **annotate_document** @@ -50,7 +52,7 @@ configuration = deepsearch.cps.apis.public.Configuration( # Enter a context with an instance of the API client with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentAnnotationApi(api_client) + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) proj_key = 'proj_key_example' # str | body = deepsearch.cps.apis.public.AnnotateDocumentRequest() # AnnotateDocumentRequest | @@ -58,7 +60,7 @@ body = deepsearch.cps.apis.public.AnnotateDocumentRequest() # AnnotateDocumentRe api_response = api_instance.annotate_document(proj_key, body) pprint(api_response) except ApiException as e: - print("Exception when calling DocumentAnnotationApi->annotate_document: %s\n" % e) + print("Exception when calling DocumentInspectionApi->annotate_document: %s\n" % e) ``` ### Parameters @@ -129,14 +131,14 @@ configuration = deepsearch.cps.apis.public.Configuration( # Enter a context with an instance of the API client with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentAnnotationApi(api_client) + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) proj_key = 'proj_key_example' # str | document_hash = 'document_hash_example' # str | try: api_instance.delete_document_annotation_result(proj_key, document_hash) except ApiException as e: - print("Exception when calling DocumentAnnotationApi->delete_document_annotation_result: %s\n" % e) + print("Exception when calling DocumentInspectionApi->delete_document_annotation_result: %s\n" % e) ``` ### Parameters @@ -207,7 +209,7 @@ configuration = deepsearch.cps.apis.public.Configuration( # Enter a context with an instance of the API client with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentAnnotationApi(api_client) + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) proj_key = 'proj_key_example' # str | task_id = 'task_id_example' # str | wait = 3.4 # float | Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling. (optional) @@ -216,7 +218,7 @@ wait = 3.4 # float | Allow the response to be delayed for a few seconds to wait api_response = api_instance.get_annotate_document_result(proj_key, task_id, wait=wait) pprint(api_response) except ApiException as e: - print("Exception when calling DocumentAnnotationApi->get_annotate_document_result: %s\n" % e) + print("Exception when calling DocumentInspectionApi->get_annotate_document_result: %s\n" % e) ``` ### Parameters @@ -248,6 +250,172 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **ingest_documentqa** +> Task ingest_documentqa(proj_key, body) + + + +Ingest a document for QA + +### Example + +* Api Key Authentication (Bearer): +```python +from __future__ import print_function +import time +import deepsearch.cps.apis.public +from deepsearch.cps.apis.public.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) + proj_key = 'proj_key_example' # str | +body = deepsearch.cps.apis.public.IngestDocumentQARequest() # IngestDocumentQARequest | + + try: + api_response = api_instance.ingest_documentqa(proj_key, body) + pprint(api_response) + except ApiException as e: + print("Exception when calling DocumentInspectionApi->ingest_documentqa: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **body** | [**IngestDocumentQARequest**](IngestDocumentQARequest.md)| | + +### Return type + +[**Task**](Task.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**0** | Unexpected error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **list_project_inspection_report** +> list[InspectionReport] list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) + + + +Get paginated list of inspection reports for a project + +### Example + +* Api Key Authentication (Bearer): +```python +from __future__ import print_function +import time +import deepsearch.cps.apis.public +from deepsearch.cps.apis.public.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) + proj_key = 'proj_key_example' # str | +page = 56 # int | page of the result list (optional) +items_per_page = 20 # int | items on one page of the result list (optional) (default to 20) +search_string = 'search_string_example' # str | search keyword (optional) +begin_date = 56 # int | begin date of the search date interval (optional) +end_date = 56 # int | end date of the search date interval (optional) + + try: + api_response = api_instance.list_project_inspection_report(proj_key, page=page, items_per_page=items_per_page, search_string=search_string, begin_date=begin_date, end_date=end_date) + pprint(api_response) + except ApiException as e: + print("Exception when calling DocumentInspectionApi->list_project_inspection_report: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **page** | **int**| page of the result list | [optional] + **items_per_page** | **int**| items on one page of the result list | [optional] [default to 20] + **search_string** | **str**| search keyword | [optional] + **begin_date** | **int**| begin date of the search date interval | [optional] + **end_date** | **int**| end date of the search date interval | [optional] + +### Return type + +[**list[InspectionReport]**](InspectionReport.md) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Reports | - | +**0** | Unexpected error. | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **report_inspected_document** > Task report_inspected_document(proj_key, body) @@ -288,7 +456,7 @@ configuration = deepsearch.cps.apis.public.Configuration( # Enter a context with an instance of the API client with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: # Create an instance of the API class - api_instance = deepsearch.cps.apis.public.DocumentAnnotationApi(api_client) + api_instance = deepsearch.cps.apis.public.DocumentInspectionApi(api_client) proj_key = 'proj_key_example' # str | body = deepsearch.cps.apis.public.AnnotatedDocumentReport() # AnnotatedDocumentReport | @@ -296,7 +464,7 @@ body = deepsearch.cps.apis.public.AnnotatedDocumentReport() # AnnotatedDocumentR api_response = api_instance.report_inspected_document(proj_key, body) pprint(api_response) except ApiException as e: - print("Exception when calling DocumentAnnotationApi->report_inspected_document: %s\n" % e) + print("Exception when calling DocumentInspectionApi->report_inspected_document: %s\n" % e) ``` ### Parameters diff --git a/docs/apis/public/IngestDocumentQARequest.md b/docs/apis/public/IngestDocumentQARequest.md new file mode 100644 index 00000000..041b9cda --- /dev/null +++ b/docs/apis/public/IngestDocumentQARequest.md @@ -0,0 +1,10 @@ +# IngestDocumentQARequest + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**source** | [**object**](.md) | | + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/apis/public/ProjectApi.md b/docs/apis/public/ProjectApi.md index 482dec5c..f994827c 100644 --- a/docs/apis/public/ProjectApi.md +++ b/docs/apis/public/ProjectApi.md @@ -4,11 +4,92 @@ All URIs are relative to *http://localhost/api/cps/public/v1* Method | HTTP request | Description ------------- | ------------- | ------------- +[**delete_project_integration_config**](ProjectApi.md#delete_project_integration_config) | **DELETE** /project/{proj_key}/integrations/{integration_name} | [**get_project_default_values**](ProjectApi.md#get_project_default_values) | **GET** /project/{proj_key}/default_values | +[**get_project_integration_config**](ProjectApi.md#get_project_integration_config) | **GET** /project/{proj_key}/integrations/{integration_name} | [**provision_project_packages**](ProjectApi.md#provision_project_packages) | **POST** /project/{proj_key}/packages | [**update_project_default_values**](ProjectApi.md#update_project_default_values) | **POST** /project/{proj_key}/default_values | +[**update_project_integration_config**](ProjectApi.md#update_project_integration_config) | **POST** /project/{proj_key}/integrations/{integration_name} | +# **delete_project_integration_config** +> delete_project_integration_config(proj_key, integration_name) + + + +Delete the config for a given project integration + +### Example + +* Api Key Authentication (Bearer): +```python +from __future__ import print_function +import time +import deepsearch.cps.apis.public +from deepsearch.cps.apis.public.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) + proj_key = 'proj_key_example' # str | +integration_name = 'integration_name_example' # str | + + try: + api_instance.delete_project_integration_config(proj_key, integration_name) + except ApiException as e: + print("Exception when calling ProjectApi->delete_project_integration_config: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **integration_name** | **str**| | + +### Return type + +void (empty response body) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**500** | Error occured on the server | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **get_project_default_values** > ProjectDefaultValues get_project_default_values(proj_key) @@ -86,6 +167,87 @@ Name | Type | Description | Notes [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **get_project_integration_config** +> object get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) + + + +Get the config for a given project integration + +### Example + +* Api Key Authentication (Bearer): +```python +from __future__ import print_function +import time +import deepsearch.cps.apis.public +from deepsearch.cps.apis.public.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) + proj_key = 'proj_key_example' # str | +integration_name = 'integration_name_example' # str | +decode_secrets = False # bool | Project owners can retrieve decoded secrets (optional) (default to False) + + try: + api_response = api_instance.get_project_integration_config(proj_key, integration_name, decode_secrets=decode_secrets) + pprint(api_response) + except ApiException as e: + print("Exception when calling ProjectApi->get_project_integration_config: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **integration_name** | **str**| | + **decode_secrets** | **bool**| Project owners can retrieve decoded secrets | [optional] [default to False] + +### Return type + +**object** + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**500** | Error occured on the server | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + # **provision_project_packages** > Task provision_project_packages(proj_key, body=body) @@ -244,3 +406,83 @@ void (empty response body) [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +# **update_project_integration_config** +> update_project_integration_config(proj_key, integration_name, config) + + + +Update the config for a given project integration + +### Example + +* Api Key Authentication (Bearer): +```python +from __future__ import print_function +import time +import deepsearch.cps.apis.public +from deepsearch.cps.apis.public.rest import ApiException +from pprint import pprint +# Defining the host is optional and defaults to http://localhost/api/cps/public/v1 +# See configuration.py for a list of all supported configuration parameters. +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1" +) + +# The client must configure the authentication and authorization parameters +# in accordance with the API server security policy. +# Examples for each auth method are provided below, use the example that +# satisfies your auth use case. + +# Configure API key authorization: Bearer +configuration = deepsearch.cps.apis.public.Configuration( + host = "http://localhost/api/cps/public/v1", + api_key = { + 'Authorization': 'YOUR_API_KEY' + } +) +# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed +# configuration.api_key_prefix['Authorization'] = 'Bearer' + +# Enter a context with an instance of the API client +with deepsearch.cps.apis.public.ApiClient(configuration) as api_client: + # Create an instance of the API class + api_instance = deepsearch.cps.apis.public.ProjectApi(api_client) + proj_key = 'proj_key_example' # str | +integration_name = 'integration_name_example' # str | +config = None # object | + + try: + api_instance.update_project_integration_config(proj_key, integration_name, config) + except ApiException as e: + print("Exception when calling ProjectApi->update_project_integration_config: %s\n" % e) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **proj_key** | **str**| | + **integration_name** | **str**| | + **config** | **object**| | + +### Return type + +void (empty response body) + +### Authorization + +[Bearer](../README.md#Bearer) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | OK | - | +**500** | Error occured on the server | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/tools/swagger-client-generator/swagger-cps.json b/tools/swagger-client-generator/swagger-cps.json index bf1b4abc..d00d635e 100644 --- a/tools/swagger-client-generator/swagger-cps.json +++ b/tools/swagger-client-generator/swagger-cps.json @@ -1 +1 @@ -{"basePath":"/api/cps/public/v1","consumes":["application/json"],"definitions":{"AnnotatedImage":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedObject":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"type":"object"},"AnnotatedTable":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedText":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["text","entities","relationships","properties"],"type":"object"},"AnnotatorParametersOrRef":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"type":"string"}},"type":"object"},"AnnotatorSupportedAnnotationsParameters":{"properties":{"annotator":{"type":"string"},"annotator_settings":{"type":"object"}},"required":["annotator"],"type":"object"},"Bag":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"},"token":{"type":"string"}},"required":["proj_key","bag_key","name","slug","timestamp","bag_domain","flavour","bag_url","public","_svc_endpoint","token"],"type":"object"},"BagBackendAware":{"properties":{"backend":{"properties":{"kg_amqp":{"properties":{"flavour":{"type":"string"}},"title":"BagAmqpBackend","type":"object"},"kg_legacy_api":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"token":{"type":"string"}},"title":"BagKgLegacyApiBackend","type":"object"}},"title":"BagBackends","type":"object"},"bag_key":{"type":"string"},"description":{"type":"string"},"last_coords_resolution":{"type":"number"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"required":["proj_key","bag_key","name","description","slug","timestamp","backend","public"],"type":"object"},"BagCallback":{"properties":{"callback_url":{"type":"string"}},"type":"object"},"BagComponentStatus":{"properties":{"start_time":{"format":"double","type":"number","x-nullable":true},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","start_time"],"type":"object"},"BagComponentStatusEnum":{"enum":["LAUNCHING","READY","BUSY","SUSPENDED","SUSPENDING","ERROR","PROVISIONING","PROVISIONING_FAILED","UNKNOWN","CHECKING","PENDING_RESOURCES","IDLE"],"type":"string"},"BagFlavour":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"type":"object"},"BagFlavourDefaultQuota":{"properties":{"default_quota":{"type":"number"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name"],"title":"BagFlavourDefaultQuota","type":"object"},"BagFlavourFullData":{"properties":{"backend":{"type":"string"},"config":{"type":"object"},"default_quota":{"type":"integer"},"description":{"type":"string"},"display_name":{"type":"string"},"is_from_deployment":{"type":"boolean"},"name":{"type":"string"},"order":{"type":"number"},"project_specific":{"type":"boolean"}},"required":["display_name","description","project_specific","backend","config"],"type":"object"},"BagStatus":{"properties":{"components":{"properties":{"erlenmeyer_api":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer API for this Graph"},"erlenmeyer_ui":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer UI for this Graph"},"kg":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Knowledge Graph and its API"}},"required":["kg","erlenmeyer_api","erlenmeyer_ui"],"type":"object"},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","components"],"type":"object"},"BagStatusBackendAware":{"properties":{"kg_amqp":{"properties":{"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status"],"type":"object"},"kg_legacy_api":{"$ref":"#/definitions/BagStatus"},"overall_status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["overall_status"],"type":"object"},"CatalogReference":{"properties":{"collection_name":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["dc_key","collection_name"],"type":"object"},"CcsCollectionReference":{"properties":{"collection_name":{"type":"string"},"language":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","collection_name"],"type":"object"},"CcsTask":{"properties":{"ccs_collection_name":{"type":"string"},"ccs_project_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","ccs_project_key","ccs_collection_name"],"title":"CcsTask","type":"object"},"CloneDataCatalogResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"data_catalogue":{"$ref":"#/definitions/DataCatalogue"}},"required":["data_catalogue","clone_task"],"type":"object"},"CollectionListCoordinates":{"properties":{"collections":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CpsModelReference":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},"CpsPackage":{"properties":{"dependencies":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"name":{"type":"string"},"package_id":{"type":"string"},"type":{"enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"type":"string"}},"required":["name","package_id","description","type","dependencies"],"type":"object"},"CpsTask":{"properties":{"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_status","task_type"],"title":"CpsTask","type":"object"},"DataCatalogCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DataCatalogImportResult":{"properties":{"data_catalogue":{"$ref":"#/definitions/DataCatalogue"},"import_task":{"$ref":"#/definitions/Task"}},"required":["data_catalogue","import_task"],"type":"object"},"DataCatalogSchema":{"properties":{"name":{"type":"string"},"schema":{"type":"string"}},"type":"object"},"DataCatalogTopology":{"properties":{"categories":{"items":{"$ref":"#/definitions/DataCatalogTopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/DataCatalogTopologyEdge"},"type":"array"}},"required":["categories","edges"]},"DataCatalogTopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"source_field":{"type":"string"},"target":{"items":{"type":"string"},"type":"array"},"target_field":{"type":"string"}},"required":["name","source","target","source_field","target_field"],"type":"object"},"DataCatalogTopologyNode":{"properties":{"data-fields":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"}},"required":["name","data-fields"]},"DataCatalogue":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"dc_key":{"type":"string"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"proj_key":{"type":"string"},"provenance_logs":{"items":{"properties":{"collection_name":{"type":"string","x-nullable":true},"source":{"properties":{"ccs":{},"clone":{},"elastic":{},"file":{},"mongo_s3":{},"url":{}},"title":"DataCatalogProvenanceLogSource","type":"object","x-nullable":true},"timestamp":{"type":"number"},"user":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"user_key":{"type":"string"}},"required":["user_key","name","email"],"title":"DataCatalogProvenanceLogUser","type":"object"}},"required":["user","timestamp","collection_name","source"],"title":"DataCatalogProvenanceLog","type":"object"},"type":"array"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"required":["name","description","dc_key","proj_key","created_by","created_at","copy_of","public","topology","category_schemas","collections_data_flows","provenance_logs"],"type":"object"},"DataCollection":{"properties":{"documents":{"type":"number"},"health":{"type":"string"},"metadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"created":{"format":"datetime","type":"string"},"description":{"type":"string"},"domain":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"storage":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["aliases","created","description","source","version","type","domain"],"type":"object"},"name":{"type":"string"},"source":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["index_key"],"type":"object"},"status":{"type":"string"}},"required":["name","documents","health","status","metadata"],"type":"object"},"DataFlow":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"template":{"type":"object"},"updated_at":{"format":"double","type":"number"},"variables":{"additionalProperties":{"type":"object"},"type":"object"}},"type":"object"},"DataFlowTemplate":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"DataFlowTemplateListItem":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"updated_at":{"format":"double","type":"number"}},"type":"object"},"DataFlowTemplateVariable":{"enum":["string","boolean","number","integer","DataCatalogId","DictionaryId","KnowledgeGraphId","ModelConfigurationId","file","SecretString","ElasticId","DataCatalogCollection","DictionaryCollection","KnowledgeGraphCollection","CcsCollection","DocumentSources"],"type":"string"},"Dictionary":{"properties":{"collections":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"dict_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","dict_key","proj_key","created_by","created_at","copy_of","public"],"type":"object"},"DictionaryCloneResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"dictionary":{"$ref":"#/definitions/Dictionary"}},"type":"object"},"DictionaryCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DictionaryCollectionCsvData":{"properties":{"body":{"type":"string"},"header":{"type":"string"}},"required":["header","body"],"title":"DictionaryCollectionCsvData","type":"object"},"DictionaryCollectionObjectData":{"items":{"allOf":[{"$ref":"#/definitions/DictionaryEntry"}],"properties":{"_id":{"type":"string"}},"required":["_id"],"title":"DictionaryEntryWithId"},"title":"DictionaryCollectionObjectData","type":"array"},"DictionaryCollectionPatch":{"properties":{"op":{"enum":["add","replace","remove"],"type":"string"},"path":{"description":"A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations).","pattern":"^/(?:-|[a-zA-Z0-9]{24})$","type":"string"},"value":{"$ref":"#/definitions/DictionaryEntry"}},"required":["op","path"],"type":"object"},"DictionaryEntry":{"additionalProperties":{},"properties":{"_name":{"type":"string"},"_synonyms":{"items":{"type":"string"},"type":"array"}},"required":["_name","_synonyms"],"type":"object"},"ElasticCoordinates":{"properties":{"ca_certificate_base64":{"type":"string"},"dangerously_disable_ssl_validation":{"type":"boolean"},"hosts":{"items":{"type":"string"},"type":"array"}},"required":["hosts"],"type":"object"},"ElasticIndexProperties":{"type":"object"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"aggs":{"type":"object"},"from":{"minimum":0,"type":"number"},"query":{"additionalProperties":{},"type":"object"},"size":{"maximum":10000,"minimum":0,"type":"number"},"sort":{"items":{"type":"object"},"type":"array"}},"type":"object"},"EntityAnnotation":{"properties":{"match":{"type":"string"},"range":{"description":"2-Tuple representing the low and high indexes of the matching substring","items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"subtype":{"type":"string"},"type":{"type":"string"}},"required":["match","range","type"],"type":"object"},"EntityMapping":{"additionalProperties":{"type":"string"},"type":"object"},"FlavoursQuota":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"},"quota":{"type":"integer"}},"required":["name","display_name"],"title":"FlavoursQuota","type":"object"},"KgSnapshot":{"properties":{"data_flow":{"type":"object","x-nullable":true},"is_current":{"type":"boolean"},"name":{"type":"string"},"project_task_id":{"type":"string"},"task_type":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"type":"object"},"KgcDataInput":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"additionalProperties":{},"properties":{"config":{"additionalProperties":{},"properties":{"coordinates":{"additionalProperties":{},"properties":{"source":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"},"target":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"}},"type":"object"}},"required":["coordinates"],"type":"object"}},"required":["config"],"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"KibanaSavedQueriesResult":{"properties":{"description":{"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"query":{"type":"string"},"title":{"type":"string"}},"type":"object"},"LoadKgcDataInput":{"properties":{"dataflow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"type":"object"},"target":{"properties":{"bag_key":{"type":"string"},"save":{"type":"object"}},"required":["bag_key","save"],"type":"object"}},"required":["dataflow","target"],"type":"object"},"ModelConfiguration":{"properties":{"configurations":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"supported_annotations":{"type":"object"}},"required":["name","description","model_config_key","proj_key","created_by","created_at","public"],"type":"object"},"ModelSupportedAnnotationsParameters":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["model_config_key","proj_key","public"],"type":"object"},"MongoCoordinates":{"properties":{"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database"],"type":"object"},"MongoS3Coordinates":{"properties":{"mongo":{"$ref":"#/definitions/MongoCoordinates"},"s3":{"$ref":"#/definitions/S3Coordinates"}},"type":"object"},"MongoS3CoordinatesWithCollectionList":{"allOf":[{"$ref":"#/definitions/MongoS3Coordinates"},{"$ref":"#/definitions/CollectionListCoordinates"}]},"ObjectPropertyMap":{"type":"object"},"Problem":{"additionalProperties":{},"example":{"detail":"A descriptive message.","may_have_extra_fields":true,"status":500,"title":"An example title","type":"ExampleError"},"properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ProcessingModel":{"properties":{"dataflow":{"$ref":"#/definitions/ProcessingModelDataFlow"},"variables":{"additionalProperties":{"properties":{"type":{"type":"string"}},"required":["type"],"title":"DataFlowVariableDefinition","type":"object"},"type":"object"}},"required":["dataflow"],"type":"object"},"ProcessingModelDataFlow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"ProcessingModelDescription":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name","description"],"type":"object"},"ProjectDataIndexConversionSettings":{"description":"Specify the conversion settings to use.","properties":{"assemble":{"properties":{"include_incomplete_documents":{"title":"Include Incomplete Documents","type":"boolean"},"mode":{"properties":{"page_elements":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Page Elements","type":"array"},"tables":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Tables","type":"array"}},"required":["page_elements","tables"],"type":"object"}},"required":["mode","include_incomplete_documents"],"title":"Assemble Settings","type":"object"},"metadata":{"properties":{"description":{"title":"Description","type":"string"},"display_name":{"title":"Display Name","type":"string"},"licence":{"title":"Licence","type":"string"},"source":{"title":"Source","type":"string"},"version":{"title":"Version","type":"string"}},"title":"Collection Metadata Settings","type":"object"},"model_pipeline":{"properties":{"clusters":{"title":"Clusters","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"normalization":{"title":"Normalization","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"page":{"title":"Page","x-oneOf":[{"description":"Reference to a model configuration","properties":{"description":{"title":"Description","type":"string"},"model_config_key":{"title":"Model Config Key","type":"string"},"name":{"title":"Name","type":"string"},"proj_key":{"title":"Proj Key","type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},{"description":"Direct configuration of a model","properties":{"config":{"title":"Config","type":"string"},"type":{"title":"Type","type":"string"}},"required":["type","config"],"type":"object"}]},"tables":{"title":"Tables","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}},"required":["clusters","page","tables","normalization"],"title":"Model Pipeline Settings","type":"object"},"ocr":{"properties":{"backend":{"title":"Backend","type":"string"},"backend_settings":{"title":"Backend Settings","type":"object"},"enabled":{"default":false,"title":"Enabled","type":"boolean"},"merge_mode":{"title":"Merge Mode","type":"string"}},"title":"OCR Settings","type":"object"},"page_labels":{"title":"Page Labels","type":"object"},"type":{"default":"direct","enum":["direct"],"title":"Type","type":"string"}},"title":"ProjectDataIndexConversionSettings","type":"object"},"ProjectDataIndexNonView":{"description":"Object to create a project data index","properties":{"description":{"description":"Description of the Index","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index","maxLength":64,"minLength":1,"type":"string"},"schema_key":{"default":"generic","description":"Schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"maxLength":64,"minLength":1,"type":"string"}},"required":["name"],"title":"ProjectDataIndexNonView","type":"object"},"ProjectDataIndexS3Coordinates":{"description":"Coordinates to COS","properties":{"access_key":{"title":"access_key","type":"string"},"bucket":{"title":"bucket","type":"string"},"host":{"title":"host","type":"string"},"key_prefix":{"title":"key_prefix","type":"string"},"location":{"title":"location","type":"string"},"port":{"title":"port","type":"number"},"secret_key":{"title":"secret_key","type":"string"},"ssl":{"title":"ssl","type":"boolean"},"verify_ssl":{"title":"verify_ssl","type":"boolean"}},"required":["host","port","ssl","verify_ssl","access_key","secret_key","bucket","location"],"title":"ProjectDataIndexCOSCoordinates","type":"object"},"ProjectDataIndexView":{"description":"Object to create a project data index view","properties":{"description":{"description":"Description of the index view","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index view","maxLength":64,"minLength":1,"type":"string"},"view_of":{"properties":{"index_key":{"description":"Data index key","maxLength":64,"minLength":1,"type":"string"},"instance_id":{"description":"Instance id key, if the source is a data asset","maxLength":64,"minLength":1,"type":"string"},"proj_key":{"description":"Project id key, if the source is a project data index","maxLength":64,"minLength":1,"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"title":"ProjectDataIndexViewOf","type":"object"}},"required":["name","view_of"],"title":"ProjectDataIndexView","type":"object"},"ProjectDataIndexWithStatus":{"description":"Project data index with elastic status","properties":{"creation_date":{"type":"string"},"description":{"type":"string"},"documents":{"type":"number"},"health":{"type":"string"},"name":{"type":"string"},"record_properties":{"$ref":"#/definitions/ElasticIndexProperties"},"schema_key":{"description":"Index's schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"type":"string"},"source":{"properties":{"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","index_key"],"title":"ProjectDataIndexSource","type":"object"},"status":{"type":"string"},"type":{"description":"Index type, user friendly format","enum":["View","Document","DB Record","Generic","Experiment"],"type":"string"},"view_of":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"type":"object"}},"required":["source","name","description","type","documents","health","status","creation_date"],"title":"ProjectDataIndexWithStatus","type":"object"},"ProjectDefaultValues":{"properties":{"ccs_project":{"properties":{"collection_name":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name"],"type":"object"},"dataflow":{"properties":{"df_tpl_key":{"type":"string"},"name":{"type":"string"}},"required":["df_tpl_key","name"],"type":"object"}},"type":"object"},"ProjectTask":{"properties":{"completed_at":{"format":"double","type":"number","x-nullable":true},"created_at":{"format":"double","type":"number"},"meta":{"type":"object"},"progress":{"format":"double","type":"number"},"proj_key":{"type":"string"},"started_at":{"format":"double","type":"number","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"user_key":{"type":"string"}},"type":"object"},"ProjectsFlavours":{"properties":{"flavours":{"items":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name","flavours"],"type":"object"},"ProjectsFlavoursQuota":{"properties":{"name":{"type":"string"},"proj_key":{"type":"string"},"quotas":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"required":["proj_key","name","quotas"],"title":"ProjectsFlavoursQuota","type":"object"},"RelationshipAnnotation":{"type":"object"},"S3Coordinates":{"description":"If provided, the S3 data will be copied","properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location","key_prefix"],"type":"object"},"S3CoordinatesWithBackupKey":{"properties":{"access-key":{"type":"string"},"backup_key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"presigned":{"properties":{"fields":{"additionalProperties":{},"type":"object"},"url":{"type":"string"}},"required":["url","fields"],"type":"object"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["bucket","backup_key"],"type":"object"},"StorageSummaryDC":{"properties":{"dc_key":{"type":"string"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["dc_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3"],"type":"object"},"StorageSummaryKG":{"properties":{"bag_key":{"type":"string"},"categories_fraction":{"items":{"properties":{"color":{"type":"string"},"name":{"type":"string"},"percentage":{"type":"number"},"size_bytes_db":{"type":"number"},"size_converted_db":{"type":"string"}},"required":["name","percentage","size_bytes_db","size_converted_db"],"type":"object"},"type":"array"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["bag_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3","categories_fraction"],"type":"object"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string"},"kg_key":{"type":"string"},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","proj_key","kind"],"type":"object"},"SystemInfo":{"properties":{"allow_non_admins_to_make_resources_public":{"type":"boolean"},"api":{"properties":{"build_date":{"type":"integer"},"commit_hash":{"type":"string"},"version":{"type":"string"}},"type":"object"},"deployment":{"properties":{"disable_kg_actions":{"type":"boolean"},"disclaimer":{"type":"string"},"linked_ccs_api":{"properties":{"project_sync":{"type":"boolean"},"uri":{"type":"string"}},"type":"object"},"name":{"type":"string"},"should_show_warning":{"type":"boolean"}},"type":"object"},"toolkit":{"properties":{"cli_command":{"type":"string"},"host":{"type":"string"},"name":{"type":"string"},"required_version":{"type":"string","x-nullable":true},"verify_ssl":{"type":"boolean"}},"type":"object"}},"type":"object"},"SystemModulesConfiguration":{"properties":{"df_template_variables":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["description","id","type"],"title":"WellKnownDfTemplateVariable","type":"object"},"type":"array"},"linked_ccs_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedCcsInstances","type":"object"},"type":"array"},"linked_elastic_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedElasticInstances","type":"object"},"type":"array"}},"required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"type":"object"},"SystemModulesTasks":{"properties":{"tasks":{"additionalProperties":{"properties":{"schema":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"TakeSnapshotSettings":{"properties":{"flavour":{"type":"string"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["flavour"],"type":"object"},"TakeSnapshotSettingsBackendAware":{"properties":{"backend_flavours":{"properties":{"kg_amqp":{"type":"string"},"kg_legacy_api":{"type":"string"}},"title":"BackendFlavour","type":"object"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["backend_flavours"],"type":"object"},"Task":{"properties":{"error_reason":{"type":"string","x-nullable":true},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"related_tasks":{"items":{"properties":{"task_id":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type"],"title":"RelatedTask","type":"object"},"type":"array"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type","task_status","proj_key","error_reason","kind"],"type":"object"},"TokenResponse":{"properties":{"token":{"type":"string"}},"required":["token"],"type":"object"},"Topology":{"properties":{"categories":{"items":{"$ref":"#/definitions/TopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/TopologyEdge"},"type":"array"}},"required":["categories","edges"],"type":"object"},"TopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"target":{"items":{"type":"string"},"type":"array"}},"required":["name","source","target"],"type":"object"},"TopologyNode":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"WorkFlow":{"type":"object"},"error_response":{"properties":{"error_code":{"type":"string","x-nullable":true},"error_message":{"type":"string"}},"required":["error_message"],"type":"object"}},"info":{"title":"Corpus Processing Service (CPS) API","version":"2.0.0"},"paths":{"/backend/project/{proj_key}/bags":{"get":{"description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/BagBackendAware"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create new BAG, backend-aware","operationId":"backend_create_project_kg","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavours":{"description":"Flavours names of the bag. Determines its available resources","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavours","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/BagBackendAware"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"description":"Update the metadata of a Knowledge graph, backend-aware","operationId":"backend_update_project_kg_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/BagBackendAware"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/status":{"get":{"description":"Get the status of a Knowledge Graph, backend-aware","operationId":"backend_get_project_kg_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatusBackendAware"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"post":{"consumes":["application/json"],"description":"Assemble a data flow on a Knowledge Graph, backend-aware","operationId":"backend_assemble_project_kg_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware","operationId":"backend_create_project_kg_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/deployment/info":{"get":{"description":"Get deployment version report","operationId":"get_version_report","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication failed, management api token is invalid or doesn't match","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"ManagementKey":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/elastic/domains":{"get":{"description":"List system elastic domains.","operationId":"get_elastic_domains","produces":["application/json"],"responses":{"200":{"description":"List of Elastic Domains.","schema":{"items":{"type":"string"},"type":"array"}},"404":{"description":"Domains not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/indices/{index_type}/{index_domain}":{"get":{"description":"List of indices for elastic instance.","operationId":"list_indices_from_elastic_instance","parameters":[{"default":"all","in":"path","name":"index_type","required":true,"type":"string"},{"default":"all","in":"path","name":"index_domain","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Elastic Instance Indices","schema":{"items":{"$ref":"#/definitions/DataCollection"},"type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/query_max_size":{"get":{"description":"Get the system maximum workable elastic query size.","operationId":"get_elastic_query_max_size","produces":["application/json"],"responses":{"200":{"description":"Maximum elastic query size.","schema":{"properties":{"elastic_query_max_size":{"type":"number"}},"type":"object"}},"404":{"description":"No maximum workable elastic query size found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/properties":{"get":{"description":"Get the property schema of the given index.","operationId":"get_index_properties","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Property schema","schema":{"$ref":"#/definitions/ElasticIndexProperties"}},"404":{"description":"Instance index not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/saved_queries":{"get":{"description":"List Kibana saved queries.","operationId":"get_kibana_saved_queries","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Kibana saved queries","schema":{"items":{"$ref":"#/definitions/KibanaSavedQueriesResult"},"title":"KibanaSavedQueriesResult","type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/processing_models":{"get":{"description":"List the available processing models.","operationId":"get_processing_models","produces":["application/json"],"responses":{"200":{"description":"List of processing models and their description","schema":{"properties":{"processing_models":{"items":{"$ref":"#/definitions/ProcessingModelDescription"},"type":"array"}},"required":["processing_models"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/processing_models/docs_graph_with_databases":{"post":{"consumes":["application/json"],"description":"Create a Data Flow from a list of CCS Collections and CPS Models.","operationId":"create_data_flow_from_df_wizard","parameters":[{"in":"body","name":"body","required":true,"schema":{"properties":{"access_token":{"type":"string"},"catalog_document_collections":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"ccs_document_collections":{"items":{"$ref":"#/definitions/CcsCollectionReference"},"type":"array"},"data_catalogs":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"entity_mappings":{"$ref":"#/definitions/EntityMapping"},"models":{"items":{"$ref":"#/definitions/CpsModelReference"},"type":"array"}},"required":["ccs_document_collections","catalog_document_collections","models","access_token"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Processing model generated successfully","schema":{"$ref":"#/definitions/ProcessingModel"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/project/data_cataloges/known_schemas":{"get":{"description":"List System Known Data Catalog Schemas.","operationId":"list_known_data_catalog_schemas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of Known Data Catalog Schemas.","schema":{"items":{"$ref":"#/definitions/DataCatalogSchema"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/data_catalogues/with_schema":{"post":{"description":"List data catalogues with specific schema","operationId":"list_data_catalogs_and_collections_from_schema","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"body","name":"schema","required":true,"schema":{"additionalProperties":{},"type":"object"},"x-body-name":"schema"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/bags":{"get":{"description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/data_catalogues":{"get":{"description":"List public data catalogues","operationId":"list_public_data_catalogs","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}":{"get":{"description":"Get a single data catalogue that was made public","operationId":"get_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public data catalogue","operationId":"clone_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting data catalogue","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_public_data_catalog_collections","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/dictionaries":{"get":{"description":"List public dictionaries","operationId":"list_public_dictionaries","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}":{"get":{"description":"Get a single dictionary that was made public","operationId":"get_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public dictionary","operationId":"clone_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting dictionary","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_public_dictionary_collections","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/kgc/dataflow_templates":{"get":{"description":"List public data flow templates","operationId":"list_public_data_flow_templates","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}":{"get":{"description":"Get a single data flow template","operationId":"get_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single public data flow template","operationId":"export_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/model_configs":{"get":{"description":"List public Model Configurations","operationId":"list_public_model_configs","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of public Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/public/model_configs/{model_config_key}":{"get":{"description":"Get a single Model Configuration that was made public","operationId":"read_public_model_config","parameters":[{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model configuration not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/annotate/document":{"post":{"description":"Run an annotator on a document","operationId":"annotate_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"type":"object"},"image_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"table_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"text_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"use_cache":{"default":true,"type":"boolean"}},"required":["document","text_annotators","image_annotators","table_annotators"],"title":"AnnotateDocumentRequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Annotation"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotate/document/report":{"post":{"description":"Submit a report on an inspected document","operationId":"report_inspected_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"properties":{"input_scratch_id":{"type":"string"},"output_scratch_id":{"type":"string"}},"required":["input_scratch_id","output_scratch_id"],"type":"object"},"document_annotation_parameters":{"type":"object"},"document_conversion_parameters":{"type":"object"},"report":{"properties":{"description":{"type":"string"},"review_consent":{"type":"boolean"}},"required":["review_consent"],"type":"object"}},"required":["document","report"],"title":"AnnotatedDocumentReport","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Annotation"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotate/document/results/{document_hash}":{"delete":{"description":"Delete annotation results for a document","operationId":"delete_document_annotation_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"document_hash","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Annotation"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotate/document/tasks/{task_id}":{"get":{"description":"Get the result of a previous document annotation","operationId":"get_annotate_document_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"description":"Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling.","in":"query","maximum":10,"minimum":0,"name":"wait","required":false,"type":"number"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"properties":{"done":{"type":"boolean"},"result":{"type":"object","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result","done"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Annotation"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotate/inspection_report":{"get":{"description":"Get paginated list of inspection reports for a project","operationId":"list_project_inspection_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Reports","schema":{"items":{"properties":{"document":{"type":"string"},"id":{"description":"ID of the inpection report.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","timestamp","document"],"title":"InspectionReport","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotate/supported_annotations":{"post":{"description":"Get supported annotations for an annotator","operationId":"get_project_annotator_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"entities":{"items":{"properties":{"data_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description"],"title":"EntityAnnotationDescriptor","type":"object"},"type":"array"},"relationships":{"items":{"properties":{"columns":{"items":{"properties":{"entities":{"items":{"type":"string"},"type":"array"},"key":{"type":"string"}},"required":["key","entities"],"title":"RelationshipAnnotationColumn","type":"object"},"type":"array"},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description","columns"],"title":"RelationshipAnnotationDescriptor","type":"object"},"type":"array"},"supported_object_types":{"items":{"type":"string"},"type":"array"}},"required":["entities","relationships"],"title":"SupportedAnnotatorAnnotations","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotator/metadata":{"post":{"description":"Get annotator's metadata","operationId":"get_cached_annotator_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"author":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"required":["name","version","url","author","description"],"title":"AnnotatorMetadata","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/bags":{"get":{"deprecated":true,"description":"List all bags in the project","operationId":"list_project_knowledge_graphs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"deprecated":true,"description":"Create new BAG","operationId":"create_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavour":{"description":"\"Flavour\" of the BAG, determines its available resources.","type":"string"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavour","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Bag"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}":{"delete":{"description":"Delete a BAG","operationId":"delete_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"BAG deleted."},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"patch":{"description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/Bag"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_callback":{"get":{"description":"Final step of redirection for authentication on a BAG.","operationId":"get_project_knowledge_graph_authentication_callback","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"bag_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth redirect URL.","schema":{"properties":{"callback_url":{"type":"string"}},"title":"KnowledgeGraphAuthenticationCallback","type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_token":{"get":{"description":"Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.","operationId":"create_project_knowledge_graph_authentication_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a BAG.","operationId":"create_project_knowledge_graph_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots":{"get":{"description":"List snapshots for a knowledge graph from assembled data flows.","operationId":"list_project_knowledge_graph_snapshots","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshots","schema":{"items":{"$ref":"#/definitions/KgSnapshot"},"type":"array"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a snapshot of a Knowledge Graph, with its current state.","operationId":"create_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"name":{"pattern":"^(?:\\w| |-)+$","type":"string"}},"required":["name"],"title":"KnowledgeGraphSnapshotOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}":{"delete":{"description":"Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.","operationId":"delete_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"OK"},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load":{"post":{"description":"Load a snapshot resulting from an assembled data flow","operationId":"load_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshot is being loaded.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/status":{"get":{"deprecated":true,"description":"Get the status of a Knowledge Graph","operationId":"get_project_knowledge_graph_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatus"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"get":{"deprecated":true,"description":"List assemble tasks for a Knowledge Graph.","operationId":"list_project_knowledge_graph_assemble_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowAssembleIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"deprecated":true,"description":"Assemble a data flow on a Knowledge Graph","operationId":"assemble_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"deprecated":true,"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task.","operationId":"create_project_knowledge_graph_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/backup":{"post":{"description":"Back up a Knowledge Graph","operationId":"create_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"backup_s3":{"default":true,"type":"boolean"},"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"BackupKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export":{"post":{"description":"Download a Knowledge Graph","operationId":"download_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export_dataset":{"post":{"description":"Export dataset from a Knowledge Graph","operationId":"export_dataset","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"info":{"properties":{"collection_key":{"type":"string"},"coords":{"properties":{"databases":{"additionalProperties":true,"type":"object"},"node_collection":{"properties":{"collection":{"type":"string"},"collection_name_prefix":{"type":"string"},"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database","collection_name_prefix","collection"],"type":"object"}},"required":["databases","node_collection"],"type":"object"},"include_s3_data":{"default":false,"type":"boolean"},"node_list":{"example":[{"_db":"db1-hash","_id":"node-id"},{"_db":"db2-hash","_id":"node-id"}],"items":{"properties":{"_db":{"type":"string"},"_id":{"type":"string"}},"required":["_db","_id"],"type":"object"},"minLength":1,"type":"array"},"projection":{"description":"A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}).","example":{"projection":{}},"type":"object"}},"required":["coords"],"type":"object"}},"required":["info"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow":{"get":{"description":"List load tasks for a Knowledge Graph","operationId":"list_project_knowledge_graph_load_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"save":{"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowLoadIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"description":"Load a data flow onto a Knowledge Graph.","operationId":"load_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"save":{"type":"object"}},"required":["save","render","data_flow"],"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment":{"post":{"consumes":["application/json"],"description":"(Re)create the deployment for a Knowledge Graph","operationId":"recreate_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"force":{"type":"boolean"}},"required":["force"],"title":"KnowledgeGraphDeploymentRecreationOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Deployment upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Refused to recreate the deployment since it already exists and the `force` flag is not `true`.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/restore":{"post":{"description":"Restore a back up of a Knowledge Graph","operationId":"restore_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"RestoreKnowledgeGraphBackupOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/resume":{"post":{"consumes":["application/json"],"description":"Resume a Knowledge Graph","operationId":"resume_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"reset":{"type":"boolean"},"snapshot_to_restore_id":{"type":"string"}},"title":"ResumeKnowledgeGraphOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/suspend":{"post":{"consumes":["application/json"],"description":"Suspend a Knowledge Graph","operationId":"suspend_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"force":{"description":"If true, the KG will be suspended even if it's busy","type":"boolean"},"snapshot":{"properties":{"name":{"type":"string"}},"type":"object"}},"required":["force"],"title":"SuspendKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/upgrade":{"post":{"consumes":["application/json"],"description":"Upgrade the deployment chart of a Knowledge Graph","operationId":"upgrade_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"chart":{"type":"string"}},"title":"KnowledgeGraphChartUpgradeOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Chart upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/usage_stats":{"get":{"description":"Get the usage stats of a Knowledge Graph","operationId":"get_project_knowledge_graph_usage_stats","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph usage stats.","schema":{"properties":{"bag_key":{"type":"string"},"last_command":{"type":"string"},"proj_key":{"type":"string"}},"title":"UsageStats","type":"object"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"properties":{"result":{"x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result"],"title":"CeleryTaskPromise","type":"object"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/data_catalogues":{"get":{"description":"List data catalogues for a project","operationId":"list_project_data_catalogs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"consumes":["application/json"],"description":"Create an empty data catalog","operationId":"create_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"topology:data_flows":{"items":{"$ref":"#/definitions/DataCatalogTopology","properties":{"data_flows":{"additionalProperties":{},"type":"object"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"}},"required":["name","description","public"],"title":"CreateDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog created.","schema":{"$ref":"#/definitions/DataCatalogue"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a mongo database","operationId":"import_project_data_catalog_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_url":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a URL to a file","operationId":"import_project_data_catalog_from_url","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogUrlImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}":{"delete":{"description":"Delete a single data catalog","operationId":"delete_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data catalog deleted."},"404":{"description":"Data catalog doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"get":{"description":"Get a single data catalogue","operationId":"get_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"patch":{"consumes":["application/json"],"description":"Update the metadata of a data catalog.","operationId":"patch_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"title":"PatchDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog updated.","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalog not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing data catalogue","operationId":"clone_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/export":{"post":{"description":"Export the contents of a data catalog.","operationId":"export_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Data catalog contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog. The collections will be created if they don't exist.","operationId":"import_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"},"url":{"type":"string"}},"title":"ImportToDataCatalogOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_project_data_catalog_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"description":"Create a collection in a data catalog","operationId":"create_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":24,"minLength":4,"pattern":"^(?:\\w|-)+$","type":"string"}},"required":["collection_name"],"title":"CreateDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}":{"delete":{"description":"Delete a single data catalog's collection","operationId":"delete_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a data catalog's collection","operationId":"export_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/zip","application/json","application/x-jsonlines"],"responses":{"200":{"description":"Data catalog collection contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"import_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"ccs":{"properties":{"auth_token":{"type":"string"},"export_package_mongo_options":{"properties":{"assemble_options":{"properties":{"mode":{"properties":{"page_elements":{"description":"Which type of annotations to filter for the page elements: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"},"tables":{"description":"Which type of annotations to filter for the tables: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"required":["page_elements","tables"],"type":"object"},"options":{"properties":{"include_incomplete_documents":{"description":"Include documents with missing pages? (e.g. no annotations for some pages)","type":"boolean"}},"required":["include_incomplete_documents"],"type":"object"}},"required":["mode","options"],"type":"object"},"incremental":{"type":"boolean"},"inputs":{"properties":{"document_hashes":{"default":[],"items":{"type":"string"},"type":"array"}},"required":["document_hashes"],"type":"object"},"package_options":{"properties":{"match_mode":{"default":"document_hash","enum":["use_fuzzy_search","document_hash"],"type":"string"},"redirect_keys_to_s3":{"default":[],"items":{"type":"string"},"type":"array"}},"type":"object"}},"required":["assemble_options","incremental","package_options"],"type":"object"},"proj_key":{"type":"string"},"source_collection_name":{"type":"string"},"url":{"type":"string"}},"required":["proj_key"],"type":"object"},"elastic":{"properties":{"coordinates":{"$ref":"#/definitions/ElasticCoordinates"},"elastic_id":{"type":"string"},"parameters":{"properties":{"import_s3_data":{"type":"boolean"},"index":{"type":"string"},"page_size":{"default":100,"type":"number"},"query_options":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"query":{"additionalProperties":{},"type":"object"},"size":{"minimum":0,"type":"number"}},"type":"object"},"s3":{"properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","key_prefix","location"],"title":"ImportFromElasticToDataCatalogS3Coords","type":"object"}},"required":["index","query_options"],"type":"object"}},"required":["parameters"],"title":"ImportFromElasticToDataCatalogOptions","type":"object"},"url":{"type":"string"}},"title":"ImportToDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema":{"post":{"description":"Infer the schema for a data catalog's collection.","operationId":"infer_project_data_catalog_category_schema","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"sample_size":{"maximum":1000,"minimum":1,"type":"integer"}},"title":"InferProjectDataCatalogCategorySchema","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"upload_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data":{"get":{"description":"Get Data Catalog Collection data.","operationId":"get_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Get Data Catalog Collection data."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data catalog.","operationId":"create_project_data_catalog_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_indices":{"get":{"description":"Get project data indices","operationId":"get_project_data_indices","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data indices.","schema":{"items":{"$ref":"#/definitions/ProjectDataIndexWithStatus"},"type":"array"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"post":{"description":"Create a project data index","operationId":"create_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}":{"delete":{"description":"Delete a project index data","operationId":"delete_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"description":"The delete confirmation token","in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deleted successfully."},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"get":{"description":"Get project data index","operationId":"get_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"patch":{"description":"Update a project data index","operationId":"update_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Updated project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"description":"Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)","operationId":"ccs_convert_upload_file_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"conversion_settings":{"$ref":"#/definitions/ProjectDataIndexConversionSettings","description":"Specify conversion settings (OCR, Assemble, ML Models) directly"},"file_url":{"description":"List of File's URL to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"},"s3_source":{"description":"Coordinates to object store to get files to convert. Can specify which files with object keys.","properties":{"coordinates":{"$ref":"#/definitions/ProjectDataIndexS3Coordinates","description":"Coordinates to object store to get files to convert"},"object_keys":{"description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"type":"object"},"scratch_files_id":{"description":"List of CCS's scratch files id to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"title":"DataIndexUploadFileSource","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"description":"Upload a file to a project data index","operationId":"upload_project_data_index_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"file_url":{"type":"string"}},"required":["file_url"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"description":"Notify upload completion of an attachment to a project data index","operationId":"register_attachment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"attachment_key":{"type":"string"},"attachment_path":{"type":"string"}},"required":["attachment_path"],"type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Attachment notify successfull"},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"description":"Get url and path to upload an attachment to a project data index","operationId":"get_attachment_upload_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Attachment upload url and path","schema":{"properties":{"attachment_path":{"description":"Attachment path.","type":"string"},"upload_data":{"description":"Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html","properties":{"fields":{"description":"fields to use in request body.","type":"object"},"url":{"description":"url of the host.","type":"string"}},"type":"object"}},"required":["attachment_path","upload_data"],"title":"AttachmentUploadData","type":"object"}},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/dataset_assembles/{task_id}/report":{"post":{"description":"Create a report for a data flow task assemble.","operationId":"create_project_knowledge_graph_assemble_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"event_log_level":{"default":"error","enum":["debug","info","warning","error","critical"],"type":"string"},"max_errors":{"default":50,"maximum":100,"minimum":0,"type":"integer"}},"title":"DataFlowAssembleReportOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Report.","schema":{"properties":{"dataflow_tasks":{"additionalProperties":{"properties":{"chunks":{"properties":{"completed":{"type":"integer"},"failure":{"type":"integer"},"spawned":{"type":"integer"},"success":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"errors":{"items":{"properties":{"cause":{"properties":{"type":{"type":"string"},"value":{}},"type":"object"},"timestamp":{"type":"number"}},"type":"object"},"type":"array"},"progress":{"type":"number"},"status":{"type":"string"},"task_type":{"type":"string"}},"title":"DataFlowAssembleReportSingleTask","type":"object"},"type":"object"},"task_id":{"type":"string"}},"title":"DataFlowAssembleReport","type":"object"}},"404":{"description":"Task not found, or is not a data flow assemble.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/default_values":{"get":{"description":"List project's default values","operationId":"get_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProjectDefaultValues"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"List project's default values","operationId":"update_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"default_values","required":true,"schema":{"$ref":"#/definitions/ProjectDefaultValues"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/dictionaries":{"get":{"description":"List dictionaries for a project","operationId":"list_project_dictionaries","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"consumes":["application/json"],"description":"Create an empty dictionary","operationId":"create_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CreateDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created.","schema":{"$ref":"#/definitions/Dictionary"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a dictionary from a mongo database","operationId":"import_project_dictionary_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DictionaryImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created, and data is being imported.","schema":{"properties":{"dictionary":{"$ref":"#/definitions/Dictionary"},"import_task":{"$ref":"#/definitions/Task"}},"title":"DictionaryImportResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}":{"delete":{"description":"Delete a single dictionary","operationId":"delete_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Dictionary deleted."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"get":{"description":"Get a single dictionary","operationId":"get_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the metadata of a dictionary","operationId":"update_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"title":"PatchDictionaryOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary updated.","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing dictionary","operationId":"clone_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/export":{"post":{"description":"Export the contents of a dictionary.","operationId":"export_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Dictionary contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_project_dictionary_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"description":"Create a collection in a dictionary","operationId":"create_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":50,"minLength":4,"pattern":"^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$","type":"string"}},"required":["collection_name"],"title":"CreateCollectionInDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}":{"delete":{"description":"Delete a single dictionary's collection","operationId":"delete_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a dictionary's collection","operationId":"export_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"file_format","required":false,"type":"string"}],"produces":["application/zip","application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary collection. The collection will be created if it doesn't exist.","operationId":"upload_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data":{"get":{"description":"Get a preview of the data in a dictionary","operationId":"get_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","pattern":"[a-zA-Z0-9]{24}","required":false,"type":"string"},{"default":1000,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":"object","in":"query","name":"response_format","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"x-oneOf":[{"$ref":"#/definitions/DictionaryCollectionObjectData"},{"$ref":"#/definitions/DictionaryCollectionCsvData"}]}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the data in a dictionary's collection","operationId":"update_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"description":"A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n","in":"body","name":"body","required":true,"schema":{"items":{"$ref":"#/definitions/DictionaryCollectionPatch"},"type":"array"}}],"produces":["application/json"],"responses":{"204":{"description":"Data updated."},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a dictionary.","operationId":"create_project_dictionary_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/kgc/dataflow_templates":{"get":{"description":"List a data flow templates","operationId":"list_project_data_flow_templates","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a data flow template","operationId":"create_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"maxLength":50,"minLength":1,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template","description"],"title":"CreateDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/from_json":{"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n","operationId":"upload_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"name","required":false,"type":"string"},{"in":"formData","name":"description","required":false,"type":"string"},{"in":"formData","name":"public","required":false,"type":"boolean"},{"in":"formData","name":"contents","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}":{"delete":{"description":"Delete a single data flow template","operationId":"delete_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data flow deleted."},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"get":{"description":"Get a single data flow template","operationId":"get_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow template.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"put":{"description":"Update a data flow template","operationId":"update_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template"],"title":"UpdateDataFlowOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow updated.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.","operationId":"load_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"render":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"type":"object"},"target":{"properties":{"save":{"type":"object"}},"required":["save"],"type":"object"}},"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values.","operationId":"render_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"title":"RenderDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag_key":{"type":"string"},"variables":{"additionalProperties":{},"type":"object"}},"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data flow template.","operationId":"create_project_data_flow_template_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single data flow template","operationId":"export_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.","operationId":"get_project_data_flow_template_topology","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"title":"DataFlowTopologyOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow topology.","schema":{"$ref":"#/definitions/Topology"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/load":{"post":{"description":"Load a dataflow into a KG","operationId":"load_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"$ref":"#/definitions/LoadKgcDataInput"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/run":{"post":{"description":"Run a dataflow","operationId":"assemble_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/validate":{"post":{"description":"Validate a dataflow","operationId":"validate_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Validation successful."},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/raw_dataflow_templates/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_raw_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"template":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["template","variables"],"type":"object"},"log_task":{"default":true,"type":"boolean"},"variable_values":{"additionalProperties":{},"type":"object"}},"required":["data_flow","variable_values","log_task"],"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}":{"post":{"consumes":["application/json"],"description":"(Debug) get the fully rendered data flow, with all the coordinates set.","operationId":"debug_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"title":"FullyRenderedDataFlow","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow.","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/model_configs":{"get":{"description":"List Model Configurations for a project","operationId":"list_project_model_configs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"post":{"consumes":["application/json"],"description":"Create a Model Configuration","operationId":"create_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"CreateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration created.","schema":{"$ref":"#/definitions/ModelConfiguration"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/model_configs/{model_config_key}":{"delete":{"description":"Delete a single Model Configuration","operationId":"delete_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration deleted."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"get":{"description":"Get a single Model Configuration","operationId":"read_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model Configuration not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"patch":{"description":"Update a single Model Configuration","operationId":"update_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"UpdateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration updated."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/models":{"get":{"description":"List models with the supported annotations for a project","operationId":"get_project_models_with_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Models with the supported annotations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/object_annotations":{"post":{"deprecated":true,"description":"Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n","operationId":"generate_project_object_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"title":"AnnotatedObject","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/object_annotations_async":{"post":{"description":"Run an annotator on an object, using resources from the project.","operationId":"generate_project_object_annotations_async","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"model_config_key":{"type":"string"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/packages":{"post":{"description":"Install packages on a project","operationId":"provision_project_packages","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","schema":{"properties":{"packages":{"items":{"properties":{"overrides":{"type":"object"},"package_id":{"type":"string"}},"required":["package_id"],"type":"object"},"type":"array","uniqueItems":true}},"required":["packages"],"title":"ProjectPackageInstalationManifest","type":"object"}}],"responses":{"200":{"description":"Task started. It can be found in the tasks endpoint for the project.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Package not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/project/{proj_key}/scratch/files":{"get":{"description":"Get temporary files uploaded to a project","operationId":"list_project_scratch_files","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"scratch_ids","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Upload a file to temporary storage","operationId":"upload_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"File uploaded","schema":{"properties":{"id":{"description":"ID of the temporary file.","type":"string"},"url":{"description":"URL to get the temporary file form.","type":"string"}},"required":["id","url"],"title":"UploadedFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"consumes":["application/json"],"description":"Create file pointers for temporary storage","operationId":"create_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Temporary file details","schema":{"properties":{"download":{"description":"URL to get the temporary file.","properties":{"url":{"type":"string"}},"type":"object"},"download_private":{"description":"URL to get the temporary file. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"id":{"description":"ID of the temporary file.","type":"string"},"metadata":{"description":"URL to metadata of the temporary file using the HEAD HTTP method.","properties":{"url":{"type":"string"}},"type":"object"},"metadata_private":{"description":"URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"upload":{"description":"URL to upload the temporary file.","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"},"upload_private":{"description":"URL to upload the temporary file. (private URL, usable within the infrastracture)","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"}},"required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files_paginated":{"get":{"description":"Get paginated list of temporary files uploaded to a project","operationId":"list_project_scratch_files_paginated","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks":{"get":{"description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_type","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"},{"in":"query","name":"sort_by","required":false,"type":"string"},{"default":"asc","enum":["asc","desc"],"in":"query","name":"sort_order","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"$ref":"#/definitions/ProjectTask"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}":{"get":{"description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"description":"Abort a task.","operationId":"abort_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Task aborted."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"description":"Get dc storage summary","operationId":"system_get_dc_storage_summary_async","parameters":[{"description":"Data catalog key","in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"DC storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"description":"Delete flavour from db","operationId":"delete_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Deleted flavour successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_all_dcs":{"get":{"description":"Get all data catalogs (only dc_key) for admin use","operationId":"system_get_all_dcs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all dcs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_all_kgs":{"get":{"description":"Get all kgs (only bag_key) for admin use","operationId":"system_get_all_kgs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all kgs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_flavour/{flavour_name}":{"get":{"description":"Get flavour from db","operationId":"get_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Get flavour successful","schema":{"$ref":"#/definitions/BagFlavourFullData"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_flavours_default_quota":{"get":{"description":"Get flavours default values","operationId":"get_flavours_default_quotas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours default values","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"description":"Gets kg total number by proj_key and flavour_key","operationId":"get_project_flavour_total_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours total kg number","schema":{"properties":{"flavour_name":{"type":"string"},"proj_key":{"type":"string"},"total_kgs":{"type":"integer"}},"required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"description":"Get project assignment flavours","operationId":"list_flavours_by_project","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"properties":{"flavours":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"},"proj_key":{"type":"string"}},"required":["proj_key","flavours"],"title":"ProjectFlavours","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"description":"Get project flavours quota","operationId":"get_project_flavours_quota","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours quota","schema":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_projects_flavours_quota":{"get":{"description":"Get projects flavours quotas","operationId":"get_projects_flavours_quota","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Projects flavours quotas","schema":{"items":{"$ref":"#/definitions/ProjectsFlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"description":"Get kg storage summary","operationId":"system_get_kg_storage_summary_async","parameters":[{"description":"Knowledge graph key","in":"path","name":"kg_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Kg storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/list_all_flavours":{"get":{"description":"Get all KG flavours storage on db","operationId":"list_all_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/list_projects_flavours":{"get":{"description":"Get all projects and their flavours","operationId":"list_projects_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/ProjectsFlavours"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavour":{"put":{"description":"Save flavour on db","operationId":"save_flavour","parameters":[{"in":"query","name":"new_flavour","required":true,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/BagFlavourFullData"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavour successful"},"409":{"description":"Flavour name already taken"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavours_default_quota":{"put":{"description":"Save flavours default quota","operationId":"save_flavours_default_quotas","parameters":[{"in":"body","name":"flavours","required":true,"schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavours default quotas successful","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours":{"put":{"description":"Save project flavours assignment on db","operationId":"save_project_flavours","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavours"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours_quota":{"put":{"description":"Save project flavours quota","operationId":"save_project_flavours_quota","parameters":[{"in":"body","name":"projects_flavours_quotas","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavoursQuota"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours quota successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/summary":{"get":{"description":"Get cps summary data.","operationId":"system_get_cps_summary","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Cps summary","schema":{"items":{"properties":{"availCpuSlots":{"type":"integer"},"availMemSlots":{"type":"integer"},"availSlots":{"type":"integer"},"name":{"type":"string"},"numNodes":{"type":"integer"},"numberKgs":{"type":"integer"},"runningKgs":{"type":"integer"},"workersPool":{"type":"string"}},"type":"object"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/failure":{"get":{"description":"Get celery tasks that failed.","operationId":"list_failure_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"failures":{"items":{"properties":{"logs":{"additionalProperties":{},"type":"object"},"meta":{"additionalProperties":{},"type":"object"},"task_id":{"type":"string"},"worker_name":{"type":"string"}},"type":"object"},"type":"array"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["proj_key","task_id","failures"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/status":{"get":{"description":"Get the status of Celery tasks.","operationId":"list_system_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"project_task_id","required":false,"type":"string"},{"description":"If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set.","in":"query","name":"started_since","required":false,"type":"number"},{"format":"double","in":"query","name":"task_status","required":false,"type":"number"},{"default":50,"in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"completed_at":{"type":"number"},"created_at":{"type":"number"},"meta":{"additionalProperties":{},"type":"object"},"metrics":{"type":"object"},"proj_key":{"type":"string"},"project_task_id":{"type":"string"},"project_task_type":{"type":"string","x-nullable":true},"started_at":{"type":"number"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"worker_name":{"type":"string"}},"required":["task_id","project_task_id","proj_key","task_type","created_at","started_at","completed_at","task_status","worker_name","meta"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/info":{"get":{"description":"Get system info","operationId":"get_system_information","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/SystemInfo"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/kgs":{"get":{"description":"List all Knowledge Graphs in the system","operationId":"list_system_knowledge_graphs","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"properties":{"backend":{"additionalProperties":{"properties":{"deployment":{"properties":{"chart":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"resources":{"additionalProperties":{"properties":{"limits":{"type":"object"},"requests":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"flavour":{"type":"string"}},"type":"object"},"type":"object"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"project_name":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"title":"KnowledgeGraphSystemInformation","type":"object"},"type":"array"}},"default":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.admin_kg_controller"}},"/system/modules/configuration":{"get":{"description":"Get modules configuration","operationId":"get_system_modules_configuration","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules configuration","schema":{"$ref":"#/definitions/SystemModulesConfiguration"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/modules/tasks":{"get":{"description":"Get modules tasks","operationId":"get_system_modules_tasks","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules tasks","schema":{"$ref":"#/definitions/SystemModulesTasks"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/packages":{"get":{"description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Packages available to this CPS installation","schema":{"items":{"$ref":"#/definitions/CpsPackage"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}}},"produces":["application/json"],"schemes":["http","https"],"securityDefinitions":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"oidc_user_mngt.utils.connexion_auth.api_key_info"},"KGAuth":{"description":"API endpoints called by the KG application are authenticated by a valid JWT\ntoken which must contain the correct project resources which is needed.\nThe token must be passed in the 'X-CPS-KG-Authorization' header.\n\nA valid JWT token can be obtained by the CPS API or UI.\n\nThe following syntax must be used in the 'Authorization' header :\n KGToken xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"X-CPS-KG-Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.kg_auth_info"},"ManagementKey":{"description":"For accessing the API using a valid management token, it must be passed in all the queries in\nthe 'Authorization' header.\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.api_mngt_token_info"}},"swagger":"2.0"} +{"basePath":"/api/cps/public/v1","consumes":["application/json"],"definitions":{"AnnotatedImage":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedObject":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"type":"object"},"AnnotatedTable":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["entities","relationships","properties"],"type":"object"},"AnnotatedText":{"properties":{"entities":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"properties":{"$ref":"#/definitions/ObjectPropertyMap"},"relationships":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"text":{"type":"string"}},"required":["text","entities","relationships","properties"],"type":"object"},"AnnotatorParametersOrRef":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"type":"string"}},"type":"object"},"AnnotatorSupportedAnnotationsParameters":{"properties":{"annotator":{"type":"string"},"annotator_settings":{"type":"object"}},"required":["annotator"],"type":"object"},"Bag":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"},"token":{"type":"string"}},"required":["proj_key","bag_key","name","slug","timestamp","bag_domain","flavour","bag_url","public","_svc_endpoint","token"],"type":"object"},"BagBackendAware":{"properties":{"backend":{"properties":{"kg_amqp":{"properties":{"flavour":{"type":"string"}},"title":"BagAmqpBackend","type":"object"},"kg_legacy_api":{"properties":{"_svc_endpoint":{"type":"string"},"bag_domain":{"type":"string"},"bag_url":{"type":"string"},"flavour":{"type":"string"},"token":{"type":"string"}},"title":"BagKgLegacyApiBackend","type":"object"}},"title":"BagBackends","type":"object"},"bag_key":{"type":"string"},"description":{"type":"string"},"last_coords_resolution":{"type":"number"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"required":["proj_key","bag_key","name","description","slug","timestamp","backend","public"],"type":"object"},"BagCallback":{"properties":{"callback_url":{"type":"string"}},"type":"object"},"BagComponentStatus":{"properties":{"start_time":{"format":"double","type":"number","x-nullable":true},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","start_time"],"type":"object"},"BagComponentStatusEnum":{"enum":["LAUNCHING","READY","BUSY","SUSPENDED","SUSPENDING","ERROR","PROVISIONING","PROVISIONING_FAILED","UNKNOWN","CHECKING","PENDING_RESOURCES","IDLE"],"type":"string"},"BagFlavour":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"type":"object"},"BagFlavourDefaultQuota":{"properties":{"default_quota":{"type":"number"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name"],"title":"BagFlavourDefaultQuota","type":"object"},"BagFlavourFullData":{"properties":{"backend":{"type":"string"},"config":{"type":"object"},"default_quota":{"type":"integer"},"description":{"type":"string"},"display_name":{"type":"string"},"is_from_deployment":{"type":"boolean"},"name":{"type":"string"},"order":{"type":"number"},"project_specific":{"type":"boolean"}},"required":["display_name","description","project_specific","backend","config"],"type":"object"},"BagStatus":{"properties":{"components":{"properties":{"erlenmeyer_api":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer API for this Graph"},"erlenmeyer_ui":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Erlenmeyer UI for this Graph"},"kg":{"allOf":[{"$ref":"#/definitions/BagComponentStatus"}],"description":"Status of the Knowledge Graph and its API"}},"required":["kg","erlenmeyer_api","erlenmeyer_ui"],"type":"object"},"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status","components"],"type":"object"},"BagStatusBackendAware":{"properties":{"kg_amqp":{"properties":{"status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["status"],"type":"object"},"kg_legacy_api":{"$ref":"#/definitions/BagStatus"},"overall_status":{"$ref":"#/definitions/BagComponentStatusEnum"}},"required":["overall_status"],"type":"object"},"CatalogReference":{"properties":{"collection_name":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["dc_key","collection_name"],"type":"object"},"CcsCollectionReference":{"properties":{"collection_name":{"type":"string"},"language":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","collection_name"],"type":"object"},"CcsTask":{"properties":{"ccs_collection_name":{"type":"string"},"ccs_project_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","ccs_project_key","ccs_collection_name"],"title":"CcsTask","type":"object"},"CloneDataCatalogResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"data_catalogue":{"$ref":"#/definitions/DataCatalogue"}},"required":["data_catalogue","clone_task"],"type":"object"},"CollectionListCoordinates":{"properties":{"collections":{"items":{"type":"string"},"type":"array"}},"type":"object"},"CpsModelReference":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},"CpsPackage":{"properties":{"dependencies":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"name":{"type":"string"},"package_id":{"type":"string"},"type":{"enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"type":"string"}},"required":["name","package_id","description","type","dependencies"],"type":"object"},"CpsTask":{"properties":{"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_status","task_type"],"title":"CpsTask","type":"object"},"DataCatalogCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DataCatalogImportResult":{"properties":{"data_catalogue":{"$ref":"#/definitions/DataCatalogue"},"import_task":{"$ref":"#/definitions/Task"}},"required":["data_catalogue","import_task"],"type":"object"},"DataCatalogSchema":{"properties":{"name":{"type":"string"},"schema":{"type":"string"}},"type":"object"},"DataCatalogTopology":{"properties":{"categories":{"items":{"$ref":"#/definitions/DataCatalogTopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/DataCatalogTopologyEdge"},"type":"array"}},"required":["categories","edges"]},"DataCatalogTopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"source_field":{"type":"string"},"target":{"items":{"type":"string"},"type":"array"},"target_field":{"type":"string"}},"required":["name","source","target","source_field","target_field"],"type":"object"},"DataCatalogTopologyNode":{"properties":{"data-fields":{"items":{"type":"string"},"type":"array"},"name":{"type":"string"}},"required":["name","data-fields"]},"DataCatalogue":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"dc_key":{"type":"string"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"proj_key":{"type":"string"},"provenance_logs":{"items":{"properties":{"collection_name":{"type":"string","x-nullable":true},"source":{"properties":{"ccs":{},"clone":{},"elastic":{},"file":{},"mongo_s3":{},"url":{}},"title":"DataCatalogProvenanceLogSource","type":"object","x-nullable":true},"timestamp":{"type":"number"},"user":{"properties":{"email":{"type":"string"},"name":{"type":"string"},"user_key":{"type":"string"}},"required":["user_key","name","email"],"title":"DataCatalogProvenanceLogUser","type":"object"}},"required":["user","timestamp","collection_name","source"],"title":"DataCatalogProvenanceLog","type":"object"},"type":"array"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"required":["name","description","dc_key","proj_key","created_by","created_at","copy_of","public","topology","category_schemas","collections_data_flows","provenance_logs"],"type":"object"},"DataCollection":{"properties":{"documents":{"type":"number"},"health":{"type":"string"},"metadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array"},"created":{"format":"datetime","type":"string"},"description":{"type":"string"},"domain":{"items":{"type":"string"},"type":"array"},"source":{"type":"string"},"storage":{"type":"string"},"type":{"type":"string"},"version":{"type":"string"}},"required":["aliases","created","description","source","version","type","domain"],"type":"object"},"name":{"type":"string"},"source":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["index_key"],"type":"object"},"status":{"type":"string"}},"required":["name","documents","health","status","metadata"],"type":"object"},"DataFlow":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"template":{"type":"object"},"updated_at":{"format":"double","type":"number"},"variables":{"additionalProperties":{"type":"object"},"type":"object"}},"type":"object"},"DataFlowTemplate":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"DataFlowTemplateListItem":{"properties":{"created_at":{"format":"double","type":"number"},"description":{"type":"string"},"df_tpl_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"updated_at":{"format":"double","type":"number"}},"type":"object"},"DataFlowTemplateVariable":{"enum":["string","boolean","number","integer","DataCatalogId","DictionaryId","KnowledgeGraphId","ModelConfigurationId","file","SecretString","ElasticId","DataCatalogCollection","DictionaryCollection","KnowledgeGraphCollection","CcsCollection","DocumentSources"],"type":"string"},"Dictionary":{"properties":{"collections":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"},"copy_of":{"type":"string","x-nullable":true},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"dict_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","dict_key","proj_key","created_by","created_at","copy_of","public"],"type":"object"},"DictionaryCloneResult":{"properties":{"clone_task":{"$ref":"#/definitions/Task"},"dictionary":{"$ref":"#/definitions/Dictionary"}},"type":"object"},"DictionaryCollection":{"properties":{"item_count":{"type":"integer"},"name":{"type":"string"}},"required":["name","item_count"],"type":"object"},"DictionaryCollectionCsvData":{"properties":{"body":{"type":"string"},"header":{"type":"string"}},"required":["header","body"],"title":"DictionaryCollectionCsvData","type":"object"},"DictionaryCollectionObjectData":{"items":{"allOf":[{"$ref":"#/definitions/DictionaryEntry"}],"properties":{"_id":{"type":"string"}},"required":["_id"],"title":"DictionaryEntryWithId"},"title":"DictionaryCollectionObjectData","type":"array"},"DictionaryCollectionPatch":{"properties":{"op":{"enum":["add","replace","remove"],"type":"string"},"path":{"description":"A path (see JSON patch specification) in the format `/{objectid}` for existing objects, or `/-` for new objects (`add` operations).","pattern":"^/(?:-|[a-zA-Z0-9]{24})$","type":"string"},"value":{"$ref":"#/definitions/DictionaryEntry"}},"required":["op","path"],"type":"object"},"DictionaryEntry":{"additionalProperties":{},"properties":{"_name":{"type":"string"},"_synonyms":{"items":{"type":"string"},"type":"array"}},"required":["_name","_synonyms"],"type":"object"},"ElasticCoordinates":{"properties":{"ca_certificate_base64":{"type":"string"},"dangerously_disable_ssl_validation":{"type":"boolean"},"hosts":{"items":{"type":"string"},"type":"array"}},"required":["hosts"],"type":"object"},"ElasticIndexProperties":{"type":"object"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"aggs":{"type":"object"},"from":{"minimum":0,"type":"number"},"query":{"additionalProperties":{},"type":"object"},"size":{"maximum":10000,"minimum":0,"type":"number"},"sort":{"items":{"type":"object"},"type":"array"}},"type":"object"},"EntityAnnotation":{"properties":{"match":{"type":"string"},"range":{"description":"2-Tuple representing the low and high indexes of the matching substring","items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"subtype":{"type":"string"},"type":{"type":"string"}},"required":["match","range","type"],"type":"object"},"EntityMapping":{"additionalProperties":{"type":"string"},"type":"object"},"FlavoursQuota":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"},"quota":{"type":"integer"}},"required":["name","display_name"],"title":"FlavoursQuota","type":"object"},"KgSnapshot":{"properties":{"data_flow":{"type":"object","x-nullable":true},"is_current":{"type":"boolean"},"name":{"type":"string"},"project_task_id":{"type":"string"},"task_type":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"type":"object"},"KgcDataInput":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"additionalProperties":{},"properties":{"config":{"additionalProperties":{},"properties":{"coordinates":{"additionalProperties":{},"properties":{"source":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"},"target":{"additionalProperties":{},"properties":{"bag_key":{"type":"string"},"collection":{"type":"string"},"dc_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"type":{"default":"bag","enum":["raw","bag","catalogue"],"type":"string"}},"type":"object"}},"type":"object"}},"required":["coordinates"],"type":"object"}},"required":["config"],"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"KibanaSavedQueriesResult":{"properties":{"description":{"type":"string"},"fields":{"items":{"type":"string"},"type":"array"},"query":{"type":"string"},"title":{"type":"string"}},"type":"object"},"LoadKgcDataInput":{"properties":{"dataflow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"type":"object"},"target":{"properties":{"bag_key":{"type":"string"},"save":{"type":"object"}},"required":["bag_key","save"],"type":"object"}},"required":["dataflow","target"],"type":"object"},"ModelConfiguration":{"properties":{"configurations":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"created_at":{"format":"double","type":"number"},"created_by":{"type":"string"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"},"supported_annotations":{"type":"object"}},"required":["name","description","model_config_key","proj_key","created_by","created_at","public"],"type":"object"},"ModelSupportedAnnotationsParameters":{"properties":{"model_config_key":{"type":"string"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["model_config_key","proj_key","public"],"type":"object"},"MongoCoordinates":{"properties":{"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database"],"type":"object"},"MongoS3Coordinates":{"properties":{"mongo":{"$ref":"#/definitions/MongoCoordinates"},"s3":{"$ref":"#/definitions/S3Coordinates"}},"type":"object"},"MongoS3CoordinatesWithCollectionList":{"allOf":[{"$ref":"#/definitions/MongoS3Coordinates"},{"$ref":"#/definitions/CollectionListCoordinates"}]},"ObjectPropertyMap":{"type":"object"},"Problem":{"additionalProperties":{},"example":{"detail":"A descriptive message.","may_have_extra_fields":true,"status":500,"title":"An example title","type":"ExampleError"},"properties":{"detail":{"type":"string"},"status":{"type":"integer"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"ProcessingModel":{"properties":{"dataflow":{"$ref":"#/definitions/ProcessingModelDataFlow"},"variables":{"additionalProperties":{"properties":{"type":{"type":"string"}},"required":["type"],"title":"DataFlowVariableDefinition","type":"object"},"type":"object"}},"required":["dataflow"],"type":"object"},"ProcessingModelDataFlow":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"ProcessingModelDescription":{"properties":{"description":{"type":"string"},"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name","display_name","description"],"type":"object"},"ProjectDataIndexConversionSettings":{"description":"Specify the conversion settings to use.","properties":{"assemble":{"properties":{"include_incomplete_documents":{"title":"Include Incomplete Documents","type":"boolean"},"mode":{"properties":{"page_elements":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Page Elements","type":"array"},"tables":{"items":{"enum":["H","M","None"],"type":"string"},"title":"Tables","type":"array"}},"required":["page_elements","tables"],"type":"object"}},"required":["mode","include_incomplete_documents"],"title":"Assemble Settings","type":"object"},"metadata":{"properties":{"description":{"title":"Description","type":"string"},"display_name":{"title":"Display Name","type":"string"},"licence":{"title":"Licence","type":"string"},"source":{"title":"Source","type":"string"},"version":{"title":"Version","type":"string"}},"title":"Collection Metadata Settings","type":"object"},"model_pipeline":{"properties":{"clusters":{"title":"Clusters","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"normalization":{"title":"Normalization","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]},"page":{"title":"Page","x-oneOf":[{"description":"Reference to a model configuration","properties":{"description":{"title":"Description","type":"string"},"model_config_key":{"title":"Model Config Key","type":"string"},"name":{"title":"Name","type":"string"},"proj_key":{"title":"Proj Key","type":"string"}},"required":["model_config_key","proj_key"],"type":"object"},{"description":"Direct configuration of a model","properties":{"config":{"title":"Config","type":"string"},"type":{"title":"Type","type":"string"}},"required":["type","config"],"type":"object"}]},"tables":{"title":"Tables","x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/0"},{"$ref":"#/definitions/ProjectDataIndexConversionSettings/properties/model_pipeline/properties/page/x-oneOf/1"}]}},"required":["clusters","page","tables","normalization"],"title":"Model Pipeline Settings","type":"object"},"ocr":{"properties":{"backend":{"title":"Backend","type":"string"},"backend_settings":{"title":"Backend Settings","type":"object"},"enabled":{"default":false,"title":"Enabled","type":"boolean"},"merge_mode":{"title":"Merge Mode","type":"string"}},"title":"OCR Settings","type":"object"},"page_labels":{"title":"Page Labels","type":"object"},"type":{"default":"direct","enum":["direct"],"title":"Type","type":"string"}},"title":"ProjectDataIndexConversionSettings","type":"object"},"ProjectDataIndexNonView":{"description":"Object to create a project data index","properties":{"description":{"description":"Description of the Index","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index","maxLength":64,"minLength":1,"type":"string"},"schema_key":{"default":"generic","description":"Schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"maxLength":64,"minLength":1,"type":"string"}},"required":["name"],"title":"ProjectDataIndexNonView","type":"object"},"ProjectDataIndexS3Coordinates":{"description":"Coordinates to COS","properties":{"access_key":{"title":"access_key","type":"string"},"bucket":{"title":"bucket","type":"string"},"host":{"title":"host","type":"string"},"key_prefix":{"title":"key_prefix","type":"string"},"location":{"title":"location","type":"string"},"port":{"title":"port","type":"number"},"secret_key":{"title":"secret_key","type":"string"},"ssl":{"title":"ssl","type":"boolean"},"verify_ssl":{"title":"verify_ssl","type":"boolean"}},"required":["host","port","ssl","verify_ssl","access_key","secret_key","bucket","location"],"title":"ProjectDataIndexCOSCoordinates","type":"object"},"ProjectDataIndexView":{"description":"Object to create a project data index view","properties":{"description":{"description":"Description of the index view","maxLength":254,"minLength":1,"type":"string"},"name":{"description":"Name of the data index view","maxLength":64,"minLength":1,"type":"string"},"view_of":{"properties":{"index_key":{"description":"Data index key","maxLength":64,"minLength":1,"type":"string"},"instance_id":{"description":"Instance id key, if the source is a data asset","maxLength":64,"minLength":1,"type":"string"},"proj_key":{"description":"Project id key, if the source is a project data index","maxLength":64,"minLength":1,"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"title":"ProjectDataIndexViewOf","type":"object"}},"required":["name","view_of"],"title":"ProjectDataIndexView","type":"object"},"ProjectDataIndexWithStatus":{"description":"Project data index with elastic status","properties":{"creation_date":{"type":"string"},"description":{"type":"string"},"documents":{"type":"number"},"health":{"type":"string"},"name":{"type":"string"},"record_properties":{"$ref":"#/definitions/ElasticIndexProperties"},"schema_key":{"description":"Index's schema key","enum":["deepsearch-doc","deepsearch-db","generic"],"type":"string"},"source":{"properties":{"index_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","index_key"],"title":"ProjectDataIndexSource","type":"object"},"status":{"type":"string"},"type":{"description":"Index type, user friendly format","enum":["View","Document","DB Record","Generic","Experiment"],"type":"string"},"view_of":{"properties":{"elastic_id":{"type":"string"},"index_key":{"type":"string"},"proj_key":{"type":"string"},"query_options":{"$ref":"#/definitions/ElasticIndexSearchQueryOptions"}},"required":["index_key","query_options"],"type":"object"}},"required":["source","name","description","type","documents","health","status","creation_date"],"title":"ProjectDataIndexWithStatus","type":"object"},"ProjectDefaultValues":{"properties":{"ccs_project":{"properties":{"collection_name":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name"],"type":"object"},"dataflow":{"properties":{"df_tpl_key":{"type":"string"},"name":{"type":"string"}},"required":["df_tpl_key","name"],"type":"object"}},"type":"object"},"ProjectIntegrations":{"x-anyOf":[{"title":"Genai","x-anyOf":[{"description":"GenAI integration for watsonx settings","properties":{"config":{"description":"Config for watsonx","properties":{"GENAI_API":{"title":"Endpoint","type":"string"},"GENAI_KEY":{"format":"password","title":"Apikey","type":"string","writeOnly":true},"GENAI_PROJECT_ID":{"title":"Project Id","type":"string"}},"required":["endpoint","project_id","apikey"],"title":"GenAIWatsonxConfig","type":"object"},"kind":{"const":"watsonx","default":"watsonx","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIWatsonx","type":"object"},{"description":"GenAI integration for BAM settings","properties":{"config":{"description":"Config for BAM","properties":{"GENAI_API":{"title":"Endpoint","type":"string"},"GENAI_KEY":{"format":"password","title":"Apikey","type":"string","writeOnly":true}},"required":["endpoint","apikey"],"title":"GenAIBAMConfig","type":"object"},"kind":{"const":"bam","default":"bam","title":"Kind","type":"string"}},"required":["config"],"title":"GenAIBAM","type":"object"}]}]},"ProjectTask":{"properties":{"completed_at":{"format":"double","type":"number","x-nullable":true},"created_at":{"format":"double","type":"number"},"meta":{"type":"object"},"progress":{"format":"double","type":"number"},"proj_key":{"type":"string"},"started_at":{"format":"double","type":"number","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"user_key":{"type":"string"}},"type":"object"},"ProjectsFlavours":{"properties":{"flavours":{"items":{"properties":{"display_name":{"type":"string"},"name":{"type":"string"}},"required":["name"],"type":"object"},"type":"array"},"name":{"type":"string"},"proj_key":{"type":"string"}},"required":["proj_key","name","flavours"],"type":"object"},"ProjectsFlavoursQuota":{"properties":{"name":{"type":"string"},"proj_key":{"type":"string"},"quotas":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"required":["proj_key","name","quotas"],"title":"ProjectsFlavoursQuota","type":"object"},"RelationshipAnnotation":{"type":"object"},"S3Coordinates":{"description":"If provided, the S3 data will be copied","properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location","key_prefix"],"type":"object"},"S3CoordinatesWithBackupKey":{"properties":{"access-key":{"type":"string"},"backup_key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"presigned":{"properties":{"fields":{"additionalProperties":{},"type":"object"},"url":{"type":"string"}},"required":["url","fields"],"type":"object"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["bucket","backup_key"],"type":"object"},"StorageSummaryDC":{"properties":{"dc_key":{"type":"string"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["dc_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3"],"type":"object"},"StorageSummaryKG":{"properties":{"bag_key":{"type":"string"},"categories_fraction":{"items":{"properties":{"color":{"type":"string"},"name":{"type":"string"},"percentage":{"type":"number"},"size_bytes_db":{"type":"number"},"size_converted_db":{"type":"string"}},"required":["name","percentage","size_bytes_db","size_converted_db"],"type":"object"},"type":"array"},"name":{"type":"string"},"size_bytes_db":{"type":"number"},"size_bytes_s3":{"type":"number"},"size_converted_db":{"type":"string"},"size_converted_s3":{"type":"string"}},"required":["bag_key","name","size_bytes_db","size_converted_db","size_bytes_s3","size_converted_s3","categories_fraction"],"type":"object"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string"},"kg_key":{"type":"string"},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["task_id","proj_key","kind"],"type":"object"},"SystemInfo":{"properties":{"allow_non_admins_to_make_resources_public":{"type":"boolean"},"api":{"properties":{"build_date":{"type":"integer"},"commit_hash":{"type":"string"},"version":{"type":"string"}},"type":"object"},"deployment":{"properties":{"disable_kg_actions":{"type":"boolean"},"disclaimer":{"type":"string"},"linked_ccs_api":{"properties":{"project_sync":{"type":"boolean"},"uri":{"type":"string"}},"type":"object"},"name":{"type":"string"},"should_show_warning":{"type":"boolean"}},"type":"object"},"toolkit":{"properties":{"cli_command":{"type":"string"},"host":{"type":"string"},"name":{"type":"string"},"required_version":{"type":"string","x-nullable":true},"verify_ssl":{"type":"boolean"}},"type":"object"}},"type":"object"},"SystemModulesConfiguration":{"properties":{"df_template_variables":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["description","id","type"],"title":"WellKnownDfTemplateVariable","type":"object"},"type":"array"},"linked_ccs_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedCcsInstances","type":"object"},"type":"array"},"linked_elastic_instances":{"items":{"properties":{"description":{"type":"string"},"id":{"type":"string"}},"required":["description","id"],"title":"LinkedElasticInstances","type":"object"},"type":"array"}},"required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"type":"object"},"SystemModulesTasks":{"properties":{"tasks":{"additionalProperties":{"properties":{"schema":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"TakeSnapshotSettings":{"properties":{"flavour":{"type":"string"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["flavour"],"type":"object"},"TakeSnapshotSettingsBackendAware":{"properties":{"backend_flavours":{"properties":{"kg_amqp":{"type":"string"},"kg_legacy_api":{"type":"string"}},"title":"BackendFlavour","type":"object"},"load_into_kg_after_created":{"default":false,"type":"boolean"},"name":{"type":"string"}},"required":["backend_flavours"],"type":"object"},"Task":{"properties":{"error_reason":{"type":"string","x-nullable":true},"kind":{"enum":["project_task","celery_task"],"type":"string"},"proj_key":{"type":"string"},"related_tasks":{"items":{"properties":{"task_id":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type"],"title":"RelatedTask","type":"object"},"type":"array"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"}},"required":["task_id","task_type","task_status","proj_key","error_reason","kind"],"type":"object"},"TokenResponse":{"properties":{"token":{"type":"string"}},"required":["token"],"type":"object"},"Topology":{"properties":{"categories":{"items":{"$ref":"#/definitions/TopologyNode"},"type":"array"},"edges":{"items":{"$ref":"#/definitions/TopologyEdge"},"type":"array"}},"required":["categories","edges"],"type":"object"},"TopologyEdge":{"properties":{"name":{"type":"string"},"source":{"items":{"type":"string"},"type":"array"},"target":{"items":{"type":"string"},"type":"array"}},"required":["name","source","target"],"type":"object"},"TopologyNode":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"WorkFlow":{"type":"object"},"error_response":{"properties":{"error_code":{"type":"string","x-nullable":true},"error_message":{"type":"string"}},"required":["error_message"],"type":"object"}},"info":{"title":"Corpus Processing Service (CPS) API","version":"2.0.0"},"paths":{"/backend/project/{proj_key}/bags":{"get":{"description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/BagBackendAware"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create new BAG, backend-aware","operationId":"backend_create_project_kg","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavours":{"description":"Flavours names of the bag. Determines its available resources","items":{"type":"string"},"type":"array"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavours","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/BagBackendAware"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"description":"Update the metadata of a Knowledge graph, backend-aware","operationId":"backend_update_project_kg_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/BagBackendAware"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/status":{"get":{"description":"Get the status of a Knowledge Graph, backend-aware","operationId":"backend_get_project_kg_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatusBackendAware"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"post":{"consumes":["application/json"],"description":"Assemble a data flow on a Knowledge Graph, backend-aware","operationId":"backend_assemble_project_kg_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware","operationId":"backend_create_project_kg_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettingsBackendAware"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/deployment/info":{"get":{"description":"Get deployment version report","operationId":"get_version_report","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"OK"},"401":{"description":"Authentication failed, management api token is invalid or doesn't match","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"ManagementKey":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/elastic/domains":{"get":{"description":"List system elastic domains.","operationId":"get_elastic_domains","produces":["application/json"],"responses":{"200":{"description":"List of Elastic Domains.","schema":{"items":{"type":"string"},"type":"array"}},"404":{"description":"Domains not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/indices/{index_type}/{index_domain}":{"get":{"description":"List of indices for elastic instance.","operationId":"list_indices_from_elastic_instance","parameters":[{"default":"all","in":"path","name":"index_type","required":true,"type":"string"},{"default":"all","in":"path","name":"index_domain","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Elastic Instance Indices","schema":{"items":{"$ref":"#/definitions/DataCollection"},"type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/query_max_size":{"get":{"description":"Get the system maximum workable elastic query size.","operationId":"get_elastic_query_max_size","produces":["application/json"],"responses":{"200":{"description":"Maximum elastic query size.","schema":{"properties":{"elastic_query_max_size":{"type":"number"}},"type":"object"}},"404":{"description":"No maximum workable elastic query size found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/properties":{"get":{"description":"Get the property schema of the given index.","operationId":"get_index_properties","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Property schema","schema":{"$ref":"#/definitions/ElasticIndexProperties"}},"404":{"description":"Instance index not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/elastic/{elastic_instance}/{elastic_index}/saved_queries":{"get":{"description":"List Kibana saved queries.","operationId":"get_kibana_saved_queries","parameters":[{"in":"path","name":"elastic_instance","required":true,"type":"string"},{"in":"path","name":"elastic_index","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Kibana saved queries","schema":{"items":{"$ref":"#/definitions/KibanaSavedQueriesResult"},"title":"KibanaSavedQueriesResult","type":"array"}},"404":{"description":"Instance indices not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Elastic"],"x-swagger-router-controller":"api_server.controllers.elastic_controller"}},"/processing_models":{"get":{"description":"List the available processing models.","operationId":"get_processing_models","produces":["application/json"],"responses":{"200":{"description":"List of processing models and their description","schema":{"properties":{"processing_models":{"items":{"$ref":"#/definitions/ProcessingModelDescription"},"type":"array"}},"required":["processing_models"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/processing_models/docs_graph_with_databases":{"post":{"consumes":["application/json"],"description":"Create a Data Flow from a list of CCS Collections and CPS Models.","operationId":"create_data_flow_from_df_wizard","parameters":[{"in":"body","name":"body","required":true,"schema":{"properties":{"access_token":{"type":"string"},"catalog_document_collections":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"ccs_document_collections":{"items":{"$ref":"#/definitions/CcsCollectionReference"},"type":"array"},"data_catalogs":{"items":{"$ref":"#/definitions/CatalogReference"},"type":"array"},"entity_mappings":{"$ref":"#/definitions/EntityMapping"},"models":{"items":{"$ref":"#/definitions/CpsModelReference"},"type":"array"}},"required":["ccs_document_collections","catalog_document_collections","models","access_token"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Processing model generated successfully","schema":{"$ref":"#/definitions/ProcessingModel"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Processing Model"],"x-swagger-router-controller":"api_server.controllers.processing_model_controller"}},"/project/data_cataloges/known_schemas":{"get":{"description":"List System Known Data Catalog Schemas.","operationId":"list_known_data_catalog_schemas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of Known Data Catalog Schemas.","schema":{"items":{"$ref":"#/definitions/DataCatalogSchema"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/data_catalogues/with_schema":{"post":{"description":"List data catalogues with specific schema","operationId":"list_data_catalogs_and_collections_from_schema","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"body","name":"schema","required":true,"schema":{"additionalProperties":{},"type":"object"},"x-body-name":"schema"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/bags":{"get":{"description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/data_catalogues":{"get":{"description":"List public data catalogues","operationId":"list_public_data_catalogs","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}":{"get":{"description":"Get a single data catalogue that was made public","operationId":"get_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public data catalogue","operationId":"clone_public_data_catalog","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting data catalogue","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_public_data_catalog_collections","parameters":[{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/public/dictionaries":{"get":{"description":"List public dictionaries","operationId":"list_public_dictionaries","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of public dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}":{"get":{"description":"Get a single dictionary that was made public","operationId":"get_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing public dictionary","operationId":"clone_public_dictionary","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"type":"string","x-nullable":true},"proj_key":{"description":"The project key of the project to store the resulting dictionary","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","proj_key"],"title":"ClonePublicDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_public_dictionary_collections","parameters":[{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/public/kgc/dataflow_templates":{"get":{"description":"List public data flow templates","operationId":"list_public_data_flow_templates","parameters":[{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}":{"get":{"description":"Get a single data flow template","operationId":"get_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single public data flow template","operationId":"export_public_data_flow_template","parameters":[{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/public/model_configs":{"get":{"description":"List public Model Configurations","operationId":"list_public_model_configs","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"List of public Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/public/model_configs/{model_config_key}":{"get":{"description":"Get a single Model Configuration that was made public","operationId":"read_public_model_config","parameters":[{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model configuration not found or is not public","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/annotate/document":{"post":{"description":"Run an annotator on a document","operationId":"annotate_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"type":"object"},"image_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"table_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"text_annotators":{"items":{"$ref":"#/definitions/AnnotatorParametersOrRef"},"type":"array"},"use_cache":{"default":true,"type":"boolean"}},"required":["document","text_annotators","image_annotators","table_annotators"],"title":"AnnotateDocumentRequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/report":{"post":{"description":"Submit a report on an inspected document","operationId":"report_inspected_document","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"document":{"properties":{"input_scratch_id":{"type":"string"},"output_scratch_id":{"type":"string"}},"required":["input_scratch_id","output_scratch_id"],"type":"object"},"document_annotation_parameters":{"type":"object"},"document_conversion_parameters":{"type":"object"},"report":{"properties":{"description":{"type":"string"},"review_consent":{"type":"boolean"}},"required":["review_consent"],"type":"object"}},"required":["document","report"],"title":"AnnotatedDocumentReport","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/results/{document_hash}":{"delete":{"description":"Delete annotation results for a document","operationId":"delete_document_annotation_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"document_hash","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/document/tasks/{task_id}":{"get":{"description":"Get the result of a previous document annotation","operationId":"get_annotate_document_result","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"description":"Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling.","in":"query","maximum":10,"minimum":0,"name":"wait","required":false,"type":"number"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"properties":{"done":{"type":"boolean"},"result":{"type":"object","x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result","done"],"type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/inspection_report":{"get":{"description":"Get paginated list of inspection reports for a project","operationId":"list_project_inspection_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Reports","schema":{"items":{"properties":{"document":{"type":"string"},"id":{"description":"ID of the inpection report.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","timestamp","document"],"title":"InspectionReport","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/annotate/supported_annotations":{"post":{"description":"Get supported annotations for an annotator","operationId":"get_project_annotator_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"entities":{"items":{"properties":{"data_fields":{"items":{"type":"string"},"type":"array","uniqueItems":true},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description"],"title":"EntityAnnotationDescriptor","type":"object"},"type":"array"},"relationships":{"items":{"properties":{"columns":{"items":{"properties":{"entities":{"items":{"type":"string"},"type":"array"},"key":{"type":"string"}},"required":["key","entities"],"title":"RelationshipAnnotationColumn","type":"object"},"type":"array"},"description":{"type":"string"},"key":{"type":"string"}},"required":["key","description","columns"],"title":"RelationshipAnnotationDescriptor","type":"object"},"type":"array"},"supported_object_types":{"items":{"type":"string"},"type":"array"}},"required":["entities","relationships"],"title":"SupportedAnnotatorAnnotations","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/annotator/metadata":{"post":{"description":"Get annotator's metadata","operationId":"get_cached_annotator_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/AnnotatorSupportedAnnotationsParameters"},{"$ref":"#/definitions/ModelSupportedAnnotationsParameters"}]}}],"produces":["application/json","text/html"],"responses":{"200":{"description":"OK","schema":{"properties":{"author":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"url":{"type":"string"},"version":{"type":"string"}},"required":["name","version","url","author","description"],"title":"AnnotatorMetadata","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/bags":{"get":{"deprecated":true,"description":"List all bags in the project","operationId":"list_project_knowledge_graphs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"$ref":"#/definitions/Bag"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"deprecated":true,"description":"Create new BAG","operationId":"create_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"description":{"description":"Description of the BAG","type":"string","x-nullable":true},"flavour":{"description":"\"Flavour\" of the BAG, determines its available resources.","type":"string"},"name":{"description":"Name of the BAG","maxLength":32,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"description":"If true, the BAG will be publicly available","type":"boolean"}},"required":["name","flavour","public"],"title":"CreateKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Bag"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Create knowledge graphs is disabled.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Cannot create BAG because one already exists with that name.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}":{"delete":{"description":"Delete a BAG","operationId":"delete_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"BAG deleted."},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"patch":{"description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"PatchKnowledgeGraphOptions","type":"object"},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge graph metadata updated.","schema":{"$ref":"#/definitions/Bag"}},"404":{"description":"Knowledge graph not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_callback":{"get":{"description":"Final step of redirection for authentication on a BAG.","operationId":"get_project_knowledge_graph_authentication_callback","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"query","name":"bag_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth redirect URL.","schema":{"properties":{"callback_url":{"type":"string"}},"title":"KnowledgeGraphAuthenticationCallback","type":"object"}},"401":{"description":"Unauthorized.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/auth_token":{"get":{"description":"Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.","operationId":"create_project_knowledge_graph_authentication_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG auth token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a BAG.","operationId":"create_project_knowledge_graph_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"BAG deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots":{"get":{"description":"List snapshots for a knowledge graph from assembled data flows.","operationId":"list_project_knowledge_graph_snapshots","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshots","schema":{"items":{"$ref":"#/definitions/KgSnapshot"},"type":"array"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a snapshot of a Knowledge Graph, with its current state.","operationId":"create_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"name":{"pattern":"^(?:\\w| |-)+$","type":"string"}},"required":["name"],"title":"KnowledgeGraphSnapshotOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}":{"delete":{"description":"Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.","operationId":"delete_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"OK"},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load":{"post":{"description":"Load a snapshot resulting from an assembled data flow","operationId":"load_project_knowledge_graph_snapshot","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"path","name":"execution_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Snapshot is being loaded.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG/Snapshot not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/status":{"get":{"deprecated":true,"description":"Get the status of a Knowledge Graph","operationId":"get_project_knowledge_graph_status","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":false,"in":"query","name":"details","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph status.","schema":{"$ref":"#/definitions/BagStatus"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow":{"get":{"deprecated":true,"description":"List assemble tasks for a Knowledge Graph.","operationId":"list_project_knowledge_graph_assemble_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowAssembleIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"deprecated":true,"description":"Assemble a data flow on a Knowledge Graph","operationId":"assemble_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["render","data_flow"],"title":"AssembleDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots":{"post":{"deprecated":true,"description":"Create a snapshot of a Knowledge Graph from the last data flow assembly task.","operationId":"create_project_knowledge_graph_snapshot_from_data_flow_assembly","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"snapshot":{"$ref":"#/definitions/TakeSnapshotSettings"}},"required":["snapshot"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"KG/BAG/Data Flow Assembly not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/backup":{"post":{"description":"Back up a Knowledge Graph","operationId":"create_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"backup_s3":{"default":true,"type":"boolean"},"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"BackupKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export":{"post":{"description":"Download a Knowledge Graph","operationId":"download_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/export_dataset":{"post":{"description":"Export dataset from a Knowledge Graph","operationId":"export_dataset","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"properties":{"info":{"properties":{"collection_key":{"type":"string"},"coords":{"properties":{"databases":{"additionalProperties":true,"type":"object"},"node_collection":{"properties":{"collection":{"type":"string"},"collection_name_prefix":{"type":"string"},"database":{"type":"string"},"uri":{"type":"string"}},"required":["uri","database","collection_name_prefix","collection"],"type":"object"}},"required":["databases","node_collection"],"type":"object"},"include_s3_data":{"default":false,"type":"boolean"},"node_list":{"example":[{"_db":"db1-hash","_id":"node-id"},{"_db":"db2-hash","_id":"node-id"}],"items":{"properties":{"_db":{"type":"string"},"_id":{"type":"string"}},"required":["_db","_id"],"type":"object"},"minLength":1,"type":"array"},"projection":{"description":"A dict specifying the fields to include or exclude. Use a dict to exclude fields from the result (e.g. projection={'main-text': false}).","example":{"projection":{}},"type":"object"}},"required":["coords"],"type":"object"}},"required":["info"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.kg_controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow":{"get":{"description":"List load tasks for a Knowledge Graph","operationId":"list_project_knowledge_graph_load_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"properties":{"data_flow":{"properties":{"render_options":{"properties":{"target_bag":{"type":"object"},"variables":{"type":"object"}},"type":"object"},"template":{"type":"string"},"variables":{"type":"object"}},"type":"object"},"save":{"type":"object"},"timestamp":{"format":"double","type":"number"}},"title":"DataFlowLoadIntoKnowledgeGraphTask","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["application/json"],"description":"Load a data flow onto a Knowledge Graph.","operationId":"load_project_knowledge_graph_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"df_tpl_key":{"description":"If set, the data flow with this key will be used.","type":"string"},"proj_key":{"description":"If set, allows for cross-project data flows to be used.","type":"string"},"public":{"description":"Must be set if the data flow template is public","type":"boolean"},"raw_data_flow":{"description":"If this is set, the raw data flow contents will be used.","properties":{"template":{"description":"Must be valid JSON","type":"string"},"variables":{"type":"object"}},"required":["template","variables"],"type":"object"}},"type":"object"},"render":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"required":["variables"],"type":"object"},"save":{"type":"object"}},"required":["save","render","data_flow"],"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment":{"post":{"consumes":["application/json"],"description":"(Re)create the deployment for a Knowledge Graph","operationId":"recreate_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"force":{"type":"boolean"}},"required":["force"],"title":"KnowledgeGraphDeploymentRecreationOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Deployment upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"409":{"description":"Refused to recreate the deployment since it already exists and the `force` flag is not `true`.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/restore":{"post":{"description":"Restore a back up of a Knowledge Graph","operationId":"restore_project_knowledge_graph_backup","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"coordinates":{"$ref":"#/definitions/S3CoordinatesWithBackupKey"}},"title":"RestoreKnowledgeGraphBackupOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid parameters.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"KG/BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/resume":{"post":{"consumes":["application/json"],"description":"Resume a Knowledge Graph","operationId":"resume_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"reset":{"type":"boolean"},"snapshot_to_restore_id":{"type":"string"}},"title":"ResumeKnowledgeGraphOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"403":{"description":"Feature is disabled on this instance.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/suspend":{"post":{"consumes":["application/json"],"description":"Suspend a Knowledge Graph","operationId":"suspend_project_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"force":{"description":"If true, the KG will be suspended even if it's busy","type":"boolean"},"snapshot":{"properties":{"name":{"type":"string"}},"type":"object"}},"required":["force"],"title":"SuspendKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/tasks/upgrade":{"post":{"consumes":["application/json"],"description":"Upgrade the deployment chart of a Knowledge Graph","operationId":"upgrade_project_knowledge_graph_deployment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"chart":{"type":"string"}},"title":"KnowledgeGraphChartUpgradeOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Chart upgrading."},"404":{"description":"Knowledge Graph doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/bags/{bag_key}/usage_stats":{"get":{"description":"Get the usage stats of a Knowledge Graph","operationId":"get_project_knowledge_graph_usage_stats","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"bag_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Knowledge Graph usage stats.","schema":{"properties":{"bag_key":{"type":"string"},"last_command":{"type":"string"},"proj_key":{"type":"string"}},"title":"UsageStats","type":"object"}},"404":{"description":"BAG not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Knowledge Graphs"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"properties":{"result":{"x-nullable":true},"task_id":{"type":"string"},"task_status":{"type":"string"}},"required":["task_id","task_status","result"],"title":"CeleryTaskPromise","type":"object"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/data_catalogues":{"get":{"description":"List data catalogues for a project","operationId":"list_project_data_catalogs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data catalogues","schema":{"items":{"$ref":"#/definitions/DataCatalogue"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"consumes":["application/json"],"description":"Create an empty data catalog","operationId":"create_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"topology:data_flows":{"items":{"$ref":"#/definitions/DataCatalogTopology","properties":{"data_flows":{"additionalProperties":{},"type":"object"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"}},"required":["name","description","public"],"title":"CreateDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog created.","schema":{"$ref":"#/definitions/DataCatalogue"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a mongo database","operationId":"import_project_data_catalog_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/from_url":{"post":{"consumes":["application/json"],"description":"Create a data catalogue from a URL to a file","operationId":"import_project_data_catalog_from_url","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"url":{"type":"string"}},"required":["url"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DataCatalogUrlImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue created, and data is being imported.","schema":{"$ref":"#/definitions/DataCatalogImportResult"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}":{"delete":{"description":"Delete a single data catalog","operationId":"delete_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data catalog deleted."},"404":{"description":"Data catalog doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"get":{"description":"Get a single data catalogue","operationId":"get_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"patch":{"consumes":["application/json"],"description":"Update the metadata of a data catalog.","operationId":"patch_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"category_schemas":{"items":{"properties":{"key":{"type":"string"},"schema":{"additionalProperties":{},"type":"object"}},"required":["key","schema"],"title":"DataCatalogCategorySchema","type":"object"},"type":"array"},"collections_data_flows":{"items":{"properties":{"data_flows":{"items":{"type":"object"},"type":"array"},"key":{"type":"string"}},"required":["key","data_flows"],"title":"DataCatalogDataFlow","type":"object"},"type":"array"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"},"topology":{"$ref":"#/definitions/DataCatalogTopology"}},"title":"PatchDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog updated.","schema":{"$ref":"#/definitions/DataCatalogue"}},"404":{"description":"Data catalog not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing data catalogue","operationId":"clone_project_data_catalog","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the catalog's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDataCatalogOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalogue cloned, and data is being copied.","schema":{"$ref":"#/definitions/CloneDataCatalogResult"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/export":{"post":{"description":"Export the contents of a data catalog.","operationId":"export_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Data catalog contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog. The collections will be created if they don't exist.","operationId":"import_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"},"url":{"type":"string"}},"title":"ImportToDataCatalogOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_data_catalog_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections":{"get":{"description":"Get the collections of a data catalog.","operationId":"list_project_data_catalog_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog collections","schema":{"items":{"$ref":"#/definitions/DataCatalogCollection"},"type":"array"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"},"post":{"description":"Create a collection in a data catalog","operationId":"create_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":24,"minLength":4,"pattern":"^(?:\\w|-)+$","type":"string"}},"required":["collection_name"],"title":"CreateDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}":{"delete":{"description":"Delete a single data catalog's collection","operationId":"delete_project_data_catalog_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a data catalog's collection","operationId":"export_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/zip","application/json","application/x-jsonlines"],"responses":{"200":{"description":"Data catalog collection contents.","schema":{"type":"file"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import":{"post":{"consumes":["application/json"],"description":"Import data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"import_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"maxProperties":1,"minProperties":1,"properties":{"ccs":{"properties":{"auth_token":{"type":"string"},"export_package_mongo_options":{"properties":{"assemble_options":{"properties":{"mode":{"properties":{"page_elements":{"description":"Which type of annotations to filter for the page elements: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"},"tables":{"description":"Which type of annotations to filter for the tables: H (human annotations), M (model generated)","items":{"enum":["H","M"],"type":"string"},"maxItems":2,"minItems":2,"type":"array"}},"required":["page_elements","tables"],"type":"object"},"options":{"properties":{"include_incomplete_documents":{"description":"Include documents with missing pages? (e.g. no annotations for some pages)","type":"boolean"}},"required":["include_incomplete_documents"],"type":"object"}},"required":["mode","options"],"type":"object"},"incremental":{"type":"boolean"},"inputs":{"properties":{"document_hashes":{"default":[],"items":{"type":"string"},"type":"array"}},"required":["document_hashes"],"type":"object"},"package_options":{"properties":{"match_mode":{"default":"document_hash","enum":["use_fuzzy_search","document_hash"],"type":"string"},"redirect_keys_to_s3":{"default":[],"items":{"type":"string"},"type":"array"}},"type":"object"}},"required":["assemble_options","incremental","package_options"],"type":"object"},"proj_key":{"type":"string"},"source_collection_name":{"type":"string"},"url":{"type":"string"}},"required":["proj_key"],"type":"object"},"elastic":{"properties":{"coordinates":{"$ref":"#/definitions/ElasticCoordinates"},"elastic_id":{"type":"string"},"parameters":{"properties":{"import_s3_data":{"type":"boolean"},"index":{"type":"string"},"page_size":{"default":100,"type":"number"},"query_options":{"properties":{"_source":{"items":{"type":"string"},"type":"array"},"query":{"additionalProperties":{},"type":"object"},"size":{"minimum":0,"type":"number"}},"type":"object"},"s3":{"properties":{"access-key":{"type":"string"},"bucket":{"type":"string"},"host":{"type":"string"},"key_prefix":{"type":"string"},"location":{"type":"string"},"port":{"type":"integer"},"secret-key":{"type":"string"},"ssl":{"type":"boolean"},"verifySSL":{"type":"boolean"}},"required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","key_prefix","location"],"title":"ImportFromElasticToDataCatalogS3Coords","type":"object"}},"required":["index","query_options"],"type":"object"}},"required":["parameters"],"title":"ImportFromElasticToDataCatalogOptions","type":"object"},"url":{"type":"string"}},"title":"ImportToDataCatalogCollectionOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema":{"post":{"description":"Infer the schema for a data catalog's collection.","operationId":"infer_project_data_catalog_category_schema","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"sample_size":{"maximum":1000,"minimum":1,"type":"integer"}},"title":"InferProjectDataCatalogCategorySchema","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a data catalog collection. The collection will be created if it doesn't exist.","operationId":"upload_project_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Data catalogue not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data":{"get":{"description":"Get Data Catalog Collection data.","operationId":"get_data_catalog_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Get Data Catalog Collection data."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_catalogues/{dc_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data catalog.","operationId":"create_project_data_catalog_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data catalog deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Catalogs"],"x-swagger-router-controller":"api_server.controllers.catalogs_controller"}},"/project/{proj_key}/data_indices":{"get":{"description":"Get project data indices","operationId":"get_project_data_indices","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data indices.","schema":{"items":{"$ref":"#/definitions/ProjectDataIndexWithStatus"},"type":"array"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"post":{"description":"Create a project data index","operationId":"create_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}":{"delete":{"description":"Delete a project index data","operationId":"delete_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"description":"The delete confirmation token","in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deleted successfully."},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"get":{"description":"Get project data index","operationId":"get_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"},"patch":{"description":"Update a project data index","operationId":"update_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"data","required":true,"schema":{"x-oneOf":[{"$ref":"#/definitions/ProjectDataIndexNonView"},{"$ref":"#/definitions/ProjectDataIndexView"}]},"x-body-name":"data"}],"produces":["application/json"],"responses":{"200":{"description":"Updated project data index.","schema":{"$ref":"#/definitions/ProjectDataIndexWithStatus"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"description":"Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)","operationId":"ccs_convert_upload_file_project_data_index","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"conversion_settings":{"$ref":"#/definitions/ProjectDataIndexConversionSettings","description":"Specify conversion settings (OCR, Assemble, ML Models) directly"},"file_url":{"description":"List of File's URL to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"},"s3_source":{"description":"Coordinates to object store to get files to convert. Can specify which files with object keys.","properties":{"coordinates":{"$ref":"#/definitions/ProjectDataIndexS3Coordinates","description":"Coordinates to object store to get files to convert"},"object_keys":{"description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"type":"object"},"scratch_files_id":{"description":"List of CCS's scratch files id to be converted and uploaded to the data index","items":{"type":"string"},"type":"array"}},"title":"DataIndexUploadFileSource","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"description":"Upload a file to a project data index","operationId":"upload_project_data_index_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"file_url":{"type":"string"}},"required":["file_url"],"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"CPS task info","schema":{"$ref":"#/definitions/CpsTask"}},"404":{"description":"Project data index not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project data index deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"description":"Notify upload completion of an attachment to a project data index","operationId":"register_attachment","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"body","name":"params","required":true,"schema":{"properties":{"attachment_key":{"type":"string"},"attachment_path":{"type":"string"}},"required":["attachment_path"],"type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Attachment notify successfull"},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"description":"Get url and path to upload an attachment to a project data index","operationId":"get_attachment_upload_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"index_key","required":true,"type":"string"},{"in":"path","name":"index_item_id","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Attachment upload url and path","schema":{"properties":{"attachment_path":{"description":"Attachment path.","type":"string"},"upload_data":{"description":"Data to upload the temporary file. Example using requests 'requests(dot)post(url, data=fields, files=file)'. More information can be found on aws s3 documentation here https://docs.aws.amazon.com/AmazonS3/latest/userguide/PresignedUrlUploadObject.html","properties":{"fields":{"description":"fields to use in request body.","type":"object"},"url":{"description":"url of the host.","type":"string"}},"type":"object"}},"required":["attachment_path","upload_data"],"title":"AttachmentUploadData","type":"object"}},"404":{"description":"Project data index or document ID not found.","schema":{"$ref":"#/definitions/Problem"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Indices"],"x-swagger-router-controller":"api_server.controllers.project_data_indices"}},"/project/{proj_key}/dataset_assembles/{task_id}/report":{"post":{"description":"Create a report for a data flow task assemble.","operationId":"create_project_knowledge_graph_assemble_report","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"event_log_level":{"default":"error","enum":["debug","info","warning","error","critical"],"type":"string"},"max_errors":{"default":50,"maximum":100,"minimum":0,"type":"integer"}},"title":"DataFlowAssembleReportOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Report.","schema":{"properties":{"dataflow_tasks":{"additionalProperties":{"properties":{"chunks":{"properties":{"completed":{"type":"integer"},"failure":{"type":"integer"},"spawned":{"type":"integer"},"success":{"type":"integer"},"total":{"type":"integer"}},"type":"object"},"errors":{"items":{"properties":{"cause":{"properties":{"type":{"type":"string"},"value":{}},"type":"object"},"timestamp":{"type":"number"}},"type":"object"},"type":"array"},"progress":{"type":"number"},"status":{"type":"string"},"task_type":{"type":"string"}},"title":"DataFlowAssembleReportSingleTask","type":"object"},"type":"object"},"task_id":{"type":"string"}},"title":"DataFlowAssembleReport","type":"object"}},"404":{"description":"Task not found, or is not a data flow assemble.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/default_values":{"get":{"description":"List project's default values","operationId":"get_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProjectDefaultValues"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"List project's default values","operationId":"update_project_default_values","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"default_values","required":true,"schema":{"$ref":"#/definitions/ProjectDefaultValues"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/dictionaries":{"get":{"description":"List dictionaries for a project","operationId":"list_project_dictionaries","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of dictionaries","schema":{"items":{"$ref":"#/definitions/Dictionary"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"consumes":["application/json"],"description":"Create an empty dictionary","operationId":"create_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CreateDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created.","schema":{"$ref":"#/definitions/Dictionary"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/from_mongo":{"post":{"consumes":["application/json"],"description":"Create a dictionary from a mongo database","operationId":"import_project_dictionary_from_mongo","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"options":{"properties":{"coordinates":{"$ref":"#/definitions/MongoS3CoordinatesWithCollectionList"}},"required":["coordinates"],"type":"object"},"target":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public"],"type":"object"}},"required":["target","options"],"title":"DictionaryImportOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary created, and data is being imported.","schema":{"properties":{"dictionary":{"$ref":"#/definitions/Dictionary"},"import_task":{"$ref":"#/definitions/Task"}},"title":"DictionaryImportResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}":{"delete":{"description":"Delete a single dictionary","operationId":"delete_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Dictionary deleted."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"get":{"description":"Get a single dictionary","operationId":"get_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the metadata of a dictionary","operationId":"update_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"additionalProperties":false,"properties":{"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"title":"PatchDictionaryOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary updated.","schema":{"$ref":"#/definitions/Dictionary"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/clone":{"post":{"consumes":["application/json"],"description":"Clone an existing dictionary","operationId":"clone_project_dictionary","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collections":{"items":{"type":"string"},"type":"array"},"copy_s3":{"default":true,"description":"Should the dictionary's S3 data also be copied?","type":"boolean"},"description":{"type":"string","x-nullable":true},"name":{"pattern":"^(?:\\w| |-)+$","type":"string","x-nullable":true},"public":{"type":"boolean"}},"required":["name","description","public"],"title":"CloneDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary cloned, and data is being copied.","schema":{"$ref":"#/definitions/DictionaryCloneResult"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/export":{"post":{"description":"Export the contents of a dictionary.","operationId":"export_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/zip"],"responses":{"200":{"description":"Dictionary contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).","operationId":"upload_project_dictionary_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections":{"get":{"description":"Get the collections of a dictionary.","operationId":"list_project_dictionary_collections","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collections","schema":{"items":{"$ref":"#/definitions/DictionaryCollection"},"type":"array"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"post":{"description":"Create a collection in a dictionary","operationId":"create_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"collection_name":{"maxLength":50,"minLength":4,"pattern":"^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$","type":"string"}},"required":["collection_name"],"title":"CreateCollectionInDictionaryOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Collection created."},"404":{"description":"Dictionary doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}":{"delete":{"description":"Delete a single dictionary's collection","operationId":"delete_project_dictionary_collection","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Collection deleted."},"404":{"description":"Collection doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export":{"post":{"description":"Export the contents of a dictionary's collection","operationId":"export_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"file_format","required":false,"type":"string"}],"produces":["application/zip","application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"type":"file"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload":{"post":{"consumes":["multipart/form-data"],"description":"Upload data to a dictionary collection. The collection will be created if it doesn't exist.","operationId":"upload_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Data is being processed.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data":{"get":{"description":"Get a preview of the data in a dictionary","operationId":"get_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"in":"query","name":"after","pattern":"[a-zA-Z0-9]{24}","required":false,"type":"string"},{"default":1000,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":"object","in":"query","name":"response_format","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary collection contents.","schema":{"x-oneOf":[{"$ref":"#/definitions/DictionaryCollectionObjectData"},{"$ref":"#/definitions/DictionaryCollectionCsvData"}]}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"},"patch":{"description":"Update the data in a dictionary's collection","operationId":"update_project_dictionary_collection_data","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"},{"in":"path","name":"collection_name","required":true,"type":"string"},{"description":"A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n","in":"body","name":"body","required":true,"schema":{"items":{"$ref":"#/definitions/DictionaryCollectionPatch"},"type":"array"}}],"produces":["application/json"],"responses":{"204":{"description":"Data updated."},"404":{"description":"Dictionary not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/dictionaries/{dict_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a dictionary.","operationId":"create_project_dictionary_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"dict_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Dictionary deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Dictionaries"],"x-swagger-router-controller":"api_server.controllers.dicts_controller"}},"/project/{proj_key}/ingest/documentqa":{"post":{"description":"Ingest a document for QA","operationId":"ingest_documentqa","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"properties":{"source":{"title":"Source","x-anyOf":[{"properties":{"type":{"enum":["url"],"title":"Type","type":"string"},"url":{"title":"Url","type":"string"}},"required":["type","url"],"title":"IngestDocumentQASourceUrl","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"elastic_id":{"title":"Elastic Id","type":"string"},"index_key":{"title":"Index Key","type":"string"},"type":{"enum":["public_data"],"title":"Type","type":"string"}},"required":["type","elastic_id","index_key","document_hash"],"title":"IngestDocumentQASourcePublicData","type":"object"},{"properties":{"document_hash":{"title":"Document Hash","type":"string"},"index_key":{"title":"Index Key","type":"string"},"proj_key":{"title":"Proj Key","type":"string"},"type":{"enum":["private_data"],"title":"Type","type":"string"}},"required":["type","proj_key","index_key","document_hash"],"title":"IngestDocumentQASourcePrivateData","type":"object"}]}},"required":["source"],"title":"IngestDocumentQARequest","type":"object"},"x-body-name":"body"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Document Inspection"],"x-swagger-router-controller":"api_server.controllers.document_inspect_controller"}},"/project/{proj_key}/integrations/{integration_name}":{"delete":{"description":"Delete the config for a given project integration","operationId":"delete_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"get":{"description":"Get the config for a given project integration","operationId":"get_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"},{"default":false,"description":"Project owners can retrieve decoded secrets","in":"query","name":"decode_secrets","type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ProjectIntegrations"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Update the config for a given project integration","operationId":"update_project_integration_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"integration_name","required":true,"type":"string"},{"in":"body","name":"config","required":true,"schema":{"$ref":"#/definitions/ProjectIntegrations"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates":{"get":{"description":"List a data flow templates","operationId":"list_project_data_flow_templates","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of data flow templates.","schema":{"items":{"$ref":"#/definitions/DataFlowTemplateListItem"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"description":"Create a data flow template","operationId":"create_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string","x-nullable":true},"name":{"maxLength":50,"minLength":1,"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template","description"],"title":"CreateDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/from_json":{"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n","operationId":"upload_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"name","required":false,"type":"string"},{"in":"formData","name":"description","required":false,"type":"string"},{"in":"formData","name":"public","required":false,"type":"boolean"},{"in":"formData","name":"contents","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow created.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}":{"delete":{"description":"Delete a single data flow template","operationId":"delete_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"query","name":"confirmation_token","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Data flow deleted."},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"get":{"description":"Get a single data flow template","operationId":"get_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow template.","schema":{"$ref":"#/definitions/DataFlow"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"},"put":{"description":"Update a data flow template","operationId":"update_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"description":{"type":"string"},"name":{"type":"string"},"public":{"type":"boolean"},"template":{"$ref":"#/definitions/DataFlowTemplate"},"variables":{"additionalProperties":{"properties":{"default_value":{},"type":{"$ref":"#/definitions/DataFlowTemplateVariable"}},"required":["type"],"type":"object"},"type":"object"}},"required":["public","name","variables","template"],"title":"UpdateDataFlowOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Dataflow updated.","schema":{"$ref":"#/definitions/DataFlow"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.","operationId":"load_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"render":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"type":"object"},"target":{"properties":{"save":{"type":"object"}},"required":["save"],"type":"object"}},"title":"LoadDataFlowIntoKnowledgeGraphOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values.","operationId":"render_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"description":"If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used.","type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["target_bag","variables"],"title":"RenderDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag_key":{"type":"string"},"variables":{"additionalProperties":{},"type":"object"}},"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token":{"post":{"description":"Get a token used to confirm the deletion of a data flow template.","operationId":"create_project_data_flow_template_delete_token","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow deletion token.","schema":{"$ref":"#/definitions/TokenResponse"}},"404":{"description":"Data flow template not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json":{"post":{"description":"Export a single data flow template","operationId":"export_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"}],"produces":["application/vnd.ibm.cps.df-template+json"],"responses":{"200":{"description":"Data flow template.","schema":{"type":"file"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.","operationId":"get_project_data_flow_template_topology","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"variables":{"additionalProperties":{},"type":"object"}},"title":"DataFlowTopologyOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Data flow topology.","schema":{"$ref":"#/definitions/Topology"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/load":{"post":{"description":"Load a dataflow into a KG","operationId":"load_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"$ref":"#/definitions/LoadKgcDataInput"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/run":{"post":{"description":"Run a dataflow","operationId":"assemble_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/dataflows/actions/validate":{"post":{"description":"Validate a dataflow","operationId":"validate_project_data_flow","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"dataflow","required":true,"schema":{"$ref":"#/definitions/KgcDataInput"},"x-body-name":"dataflow"}],"produces":["application/json"],"responses":{"200":{"description":"Validation successful."},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc/raw_dataflow_templates/actions/run":{"post":{"consumes":["application/json"],"description":"Render a single data flow template, replacing the variable placeholders by their actual values and run it.","operationId":"assemble_project_raw_data_flow_template_into_knowledge_graph","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"data_flow":{"properties":{"template":{"properties":{"config":{"type":"object"},"data-flow":{"items":{"type":"object"},"type":"array"}},"required":["config","data-flow"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"required":["template","variables"],"type":"object"},"log_task":{"default":true,"type":"boolean"},"variable_values":{"additionalProperties":{},"type":"object"}},"required":["data_flow","variable_values","log_task"],"title":"RunDataFlowTemplateOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Task started.","schema":{"$ref":"#/definitions/Task"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}":{"post":{"consumes":["application/json"],"description":"(Debug) get the fully rendered data flow, with all the coordinates set.","operationId":"debug_project_data_flow_template","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"df_tpl_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"target_bag":{"properties":{"bag_key":{"type":"string"},"proj_key":{"type":"string"}},"required":["bag_key"],"type":"object"},"variables":{"additionalProperties":{},"type":"object"}},"title":"FullyRenderedDataFlow","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"Rendered data flow.","schema":{"type":"object"}},"400":{"description":"Invalid dataflow.","schema":{"$ref":"#/definitions/Problem"}},"404":{"description":"Data flow template doesn't exist.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Data Flows"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/model_configs":{"get":{"description":"List Model Configurations for a project","operationId":"list_project_model_configs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Model Configurations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"post":{"consumes":["application/json"],"description":"Create a Model Configuration","operationId":"create_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"model_config_key":{"type":"string"},"name":{"pattern":"^(?:\\w| |-)+$","type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"CreateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration created.","schema":{"$ref":"#/definitions/ModelConfiguration"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/model_configs/{model_config_key}":{"delete":{"description":"Delete a single Model Configuration","operationId":"delete_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration deleted."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"get":{"description":"Get a single Model Configuration","operationId":"read_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"default":false,"in":"query","name":"include_collections","required":false,"type":"boolean"}],"produces":["application/json"],"responses":{"200":{"description":"Model Configuration","schema":{"$ref":"#/definitions/ModelConfiguration"}},"404":{"description":"Model Configuration not found","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"},"patch":{"description":"Update a single Model Configuration","operationId":"update_project_model_config","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"model_config_key","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"additionalProperties":false,"properties":{"configurations":{"properties":{"type":{"type":"string"}},"required":["type"],"type":"object"},"description":{"type":"string","x-nullable":true},"name":{"type":"string"},"public":{"type":"boolean"}},"required":["name","description","public","configurations"],"title":"UpdateProjectModelConfigOptions","type":"object"}}],"produces":["application/json"],"responses":{"204":{"description":"Model Configuration updated."},"404":{"description":"Model Configuration doesn't exist.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/models":{"get":{"description":"List models with the supported annotations for a project","operationId":"get_project_models_with_supported_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of Models with the supported annotations","schema":{"items":{"$ref":"#/definitions/ModelConfiguration"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Model Configurations"],"x-swagger-router-controller":"api_server.controllers.model_configs_controller"}},"/project/{proj_key}/object_annotations":{"post":{"deprecated":true,"description":"Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n","operationId":"generate_project_object_annotations","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"maxProperties":1,"minProperties":1,"properties":{"image":{"$ref":"#/definitions/AnnotatedImage"},"table":{"$ref":"#/definitions/AnnotatedTable"},"text":{"properties":{"entities":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/EntityAnnotation"},"type":"array"},"type":"object"},"type":"array"},"properties":{"description":"One item per line on the original text.","items":{"$ref":"#/definitions/ObjectPropertyMap"},"type":"array"},"relationships":{"description":"One item per line on the original text.","items":{"additionalProperties":{"items":{"$ref":"#/definitions/RelationshipAnnotation"},"type":"array"},"type":"object"},"type":"array"},"text":{"description":"Input text after clean up. The annotation indexes will be based on this text and not the input text.","type":"string"}},"required":["text","entities","relationships","properties"],"title":"AnnotatedTextLines","type":"object"}},"title":"AnnotatedObject","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/object_annotations_async":{"post":{"description":"Run an annotator on an object, using resources from the project.","operationId":"generate_project_object_annotations_async","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"options","required":true,"schema":{"properties":{"input":{"maxProperties":1,"minProperties":1,"properties":{"image":{"properties":{"metadata":{"properties":{"cells":{"properties":{"data":{"description":"A 6-tuple consisting of x1, y1, x2, y2, font, coordinates","items":[{"type":"number"},{"type":"number"},{"type":"number"},{"type":"number"},{"type":"string"},{"type":"string"}],"type":"array"}},"required":["data"],"title":"ImageCells","type":"object"},"info":{"properties":{"height":{"type":"number"},"width":{"type":"number"}},"required":["width","height"],"title":"ImageInfo","type":"object"}},"required":["cells"],"title":"ImageMetadata","type":"object"},"source":{"minProperties":1,"properties":{"proj_key":{"type":"string"},"scratch_id":{"type":"string"},"url":{"type":"string"}},"title":"ImageSource","type":"object"}},"required":["source"],"title":"AnnotatorImageInput","type":"object"},"table":{"description":"A table, specified as an array of arrays. Each outer array represents a row, and each item in the inner array represents the column.","items":{"items":{"properties":{"bbox":{"items":{"format":"double","type":"number"},"maxItems":4,"minItems":4,"type":"array"},"spans":{"description":"2-tuple representing the row:column where this cell spans to.","items":{"items":{"format":"integer","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"type":"array"},"text":{"type":"string"},"type":{"enum":["col_header","row_header","body"],"title":"AnnotateTableCellType","type":"string"}},"required":["bbox","spans","text","type"],"title":"AnnotateTableCell","type":"object"},"type":"array"},"type":"array"},"text":{"maxLength":4500,"type":"string"}},"title":"AnnotatorInput","type":"object"},"model_config_key":{"type":"string"},"parameters":{"additionalProperties":{},"properties":{"type":{"type":"string"}},"required":["type"],"title":"AnnotatorParameters","type":"object"},"proj_key":{"type":"string"},"public":{"type":"boolean"}},"required":["parameters","input"],"title":"AnnotateObjectOptions","type":"object"},"x-body-name":"options"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Task"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Annotate"],"x-swagger-router-controller":"api_server.controllers.annotate"}},"/project/{proj_key}/packages":{"post":{"description":"Install packages on a project","operationId":"provision_project_packages","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"body","name":"body","schema":{"properties":{"packages":{"items":{"properties":{"overrides":{"type":"object"},"package_id":{"type":"string"}},"required":["package_id"],"type":"object"},"type":"array","uniqueItems":true}},"required":["packages"],"title":"ProjectPackageInstalationManifest","type":"object"}}],"responses":{"200":{"description":"Task started. It can be found in the tasks endpoint for the project.","schema":{"$ref":"#/definitions/Task"}},"404":{"description":"Package not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Project"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/project/{proj_key}/scratch/files":{"get":{"description":"Get temporary files uploaded to a project","operationId":"list_project_scratch_files","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"scratch_ids","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"},"post":{"consumes":["multipart/form-data"],"deprecated":true,"description":"Upload a file to temporary storage","operationId":"upload_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"formData","name":"file","required":true,"type":"file"}],"produces":["application/json"],"responses":{"200":{"description":"File uploaded","schema":{"properties":{"id":{"description":"ID of the temporary file.","type":"string"},"url":{"description":"URL to get the temporary file form.","type":"string"}},"required":["id","url"],"title":"UploadedFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"consumes":["application/json"],"description":"Create file pointers for temporary storage","operationId":"create_project_scratch_file","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"filename","required":true,"type":"string"}],"produces":["application/json"],"responses":{"201":{"description":"Temporary file details","schema":{"properties":{"download":{"description":"URL to get the temporary file.","properties":{"url":{"type":"string"}},"type":"object"},"download_private":{"description":"URL to get the temporary file. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"id":{"description":"ID of the temporary file.","type":"string"},"metadata":{"description":"URL to metadata of the temporary file using the HEAD HTTP method.","properties":{"url":{"type":"string"}},"type":"object"},"metadata_private":{"description":"URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)","properties":{"url":{"type":"string"}},"type":"object"},"upload":{"description":"URL to upload the temporary file.","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"},"upload_private":{"description":"URL to upload the temporary file. (private URL, usable within the infrastracture)","properties":{"fields":{"type":"object"},"url":{"type":"string"}},"type":"object"}},"required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult","type":"object"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/scratch/files_paginated":{"get":{"description":"Get paginated list of temporary files uploaded to a project","operationId":"list_project_scratch_files_paginated","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"description":"page of the result list","in":"query","name":"page","required":false,"type":"integer"},{"default":20,"description":"items on one page of the result list","in":"query","name":"items_per_page","required":false,"type":"integer"},{"description":"search keyword","in":"query","name":"search_string","required":false,"type":"string"},{"description":"begin date of the search date interval","in":"query","name":"begin_date","required":false,"type":"integer"},{"description":"end date of the search date interval","in":"query","name":"end_date","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Files","schema":{"items":{"properties":{"filename":{"type":"string"},"id":{"description":"ID of the temporary file.","type":"string"},"proj_key":{"type":"string"},"timestamp":{"type":"number"},"user_key":{"type":"string"}},"required":["id","proj_key","user_key","filename","timestamp"],"title":"UploadedFile","type":"object"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Uploads"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks":{"get":{"description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_type","required":false,"type":"string"},{"default":50,"in":"query","minimum":0,"name":"limit","required":false,"type":"integer"},{"default":0,"in":"query","minimum":0,"name":"skip","required":false,"type":"integer"},{"in":"query","name":"sort_by","required":false,"type":"string"},{"default":"asc","enum":["asc","desc"],"in":"query","name":"sort_order","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"List of tasks.","schema":{"items":{"$ref":"#/definitions/ProjectTask"},"type":"array"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}":{"get":{"description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Task","schema":{"$ref":"#/definitions/ProjectTask"}},"404":{"description":"Task not found.","schema":{"$ref":"#/definitions/Problem"}},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]},{"KGAuth":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"description":"Abort a task.","operationId":"abort_project_task","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"204":{"description":"Task aborted."},"default":{"description":"Unexpected error.","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"description":"Get dc storage summary","operationId":"system_get_dc_storage_summary_async","parameters":[{"description":"Data catalog key","in":"path","name":"dc_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"DC storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"description":"Delete flavour from db","operationId":"delete_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Deleted flavour successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_all_dcs":{"get":{"description":"Get all data catalogs (only dc_key) for admin use","operationId":"system_get_all_dcs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all dcs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_all_kgs":{"get":{"description":"Get all kgs (only bag_key) for admin use","operationId":"system_get_all_kgs_admin","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Array with all kgs's key","schema":{"items":{"type":"string"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/get_flavour/{flavour_name}":{"get":{"description":"Get flavour from db","operationId":"get_flavour","parameters":[{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Get flavour successful","schema":{"$ref":"#/definitions/BagFlavourFullData"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_flavours_default_quota":{"get":{"description":"Get flavours default values","operationId":"get_flavours_default_quotas","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours default values","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"description":"Gets kg total number by proj_key and flavour_key","operationId":"get_project_flavour_total_kgs","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"},{"in":"path","name":"flavour_name","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours total kg number","schema":{"properties":{"flavour_name":{"type":"string"},"proj_key":{"type":"string"},"total_kgs":{"type":"integer"}},"required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"description":"Get project assignment flavours","operationId":"list_flavours_by_project","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Ok","schema":{"properties":{"flavours":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"},"proj_key":{"type":"string"}},"required":["proj_key","flavours"],"title":"ProjectFlavours","type":"object"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"description":"Get project flavours quota","operationId":"get_project_flavours_quota","parameters":[{"in":"path","name":"proj_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Project flavours quota","schema":{"items":{"$ref":"#/definitions/FlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/get_projects_flavours_quota":{"get":{"description":"Get projects flavours quotas","operationId":"get_projects_flavours_quota","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Projects flavours quotas","schema":{"items":{"$ref":"#/definitions/ProjectsFlavoursQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"description":"Get kg storage summary","operationId":"system_get_kg_storage_summary_async","parameters":[{"description":"Knowledge graph key","in":"path","name":"kg_key","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Kg storage summary","schema":{"$ref":"#/definitions/StorageSummaryTask"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/admin/list_all_flavours":{"get":{"description":"Get all KG flavours storage on db","operationId":"list_all_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/BagFlavourFullData"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/list_projects_flavours":{"get":{"description":"Get all projects and their flavours","operationId":"list_projects_flavours","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Flavours storage on db","schema":{"items":{"$ref":"#/definitions/ProjectsFlavours"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavour":{"put":{"description":"Save flavour on db","operationId":"save_flavour","parameters":[{"in":"query","name":"new_flavour","required":true,"type":"boolean"},{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/BagFlavourFullData"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavour successful"},"409":{"description":"Flavour name already taken"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_flavours_default_quota":{"put":{"description":"Save flavours default quota","operationId":"save_flavours_default_quotas","parameters":[{"in":"body","name":"flavours","required":true,"schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}}],"produces":["application/json"],"responses":{"200":{"description":"Save flavours default quotas successful","schema":{"items":{"$ref":"#/definitions/BagFlavourDefaultQuota"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours":{"put":{"description":"Save project flavours assignment on db","operationId":"save_project_flavours","parameters":[{"in":"body","name":"body","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavours"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/save_project_flavours_quota":{"put":{"description":"Save project flavours quota","operationId":"save_project_flavours_quota","parameters":[{"in":"body","name":"projects_flavours_quotas","required":true,"schema":{"$ref":"#/definitions/ProjectsFlavoursQuota"}}],"produces":["application/json"],"responses":{"200":{"description":"Save project flavours quota successful"},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}},"/system/admin/summary":{"get":{"description":"Get cps summary data.","operationId":"system_get_cps_summary","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Cps summary","schema":{"items":{"properties":{"availCpuSlots":{"type":"integer"},"availMemSlots":{"type":"integer"},"availSlots":{"type":"integer"},"name":{"type":"string"},"numNodes":{"type":"integer"},"numberKgs":{"type":"integer"},"runningKgs":{"type":"integer"},"workersPool":{"type":"string"}},"type":"object"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/failure":{"get":{"description":"Get celery tasks that failed.","operationId":"list_failure_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":true,"type":"string"},{"in":"query","name":"task_id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"failures":{"items":{"properties":{"logs":{"additionalProperties":{},"type":"object"},"meta":{"additionalProperties":{},"type":"object"},"task_id":{"type":"string"},"worker_name":{"type":"string"}},"type":"object"},"type":"array"},"proj_key":{"type":"string"},"task_id":{"type":"string"}},"required":["proj_key","task_id","failures"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/celery_tasks/status":{"get":{"description":"Get the status of Celery tasks.","operationId":"list_system_celery_tasks","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"project_task_id","required":false,"type":"string"},{"description":"If set, return the tasks created at or after this timestamp. Otherwise, return the tasks created up to 60 minutes of the system's date, if `project_task_id` is not set.","in":"query","name":"started_since","required":false,"type":"number"},{"format":"double","in":"query","name":"task_status","required":false,"type":"number"},{"default":50,"in":"query","name":"limit","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"Celery tasks","schema":{"items":{"properties":{"completed_at":{"type":"number"},"created_at":{"type":"number"},"meta":{"additionalProperties":{},"type":"object"},"metrics":{"type":"object"},"proj_key":{"type":"string"},"project_task_id":{"type":"string"},"project_task_type":{"type":"string","x-nullable":true},"started_at":{"type":"number"},"task_id":{"type":"string"},"task_status":{"type":"string"},"task_type":{"type":"string"},"worker_name":{"type":"string"}},"required":["task_id","project_task_id","proj_key","task_type","created_at","started_at","completed_at","task_status","worker_name","meta"],"title":"CeleryTask","type":"object"},"type":"array"}}},"security":[{"Bearer":[]}],"tags":["Tasks"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/info":{"get":{"description":"Get system info","operationId":"get_system_information","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"OK","schema":{"$ref":"#/definitions/SystemInfo"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/kgs":{"get":{"description":"List all Knowledge Graphs in the system","operationId":"list_system_knowledge_graphs","parameters":[{"in":"query","name":"proj_key","required":false,"type":"string"},{"in":"query","name":"term","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"items":{"properties":{"backend":{"additionalProperties":{"properties":{"deployment":{"properties":{"chart":{"type":"string"},"flavour":{"type":"string"},"name":{"type":"string"},"resources":{"additionalProperties":{"properties":{"limits":{"type":"object"},"requests":{"type":"object"}},"type":"object"},"type":"object"}},"type":"object"},"flavour":{"type":"string"}},"type":"object"},"type":"object"},"bag_domain":{"type":"string"},"bag_key":{"type":"string"},"bag_url":{"type":"string"},"name":{"type":"string"},"proj_key":{"type":"string"},"project_name":{"type":"string"},"public":{"type":"boolean"},"slug":{"type":"string"},"timestamp":{"format":"double","type":"number"}},"title":"KnowledgeGraphSystemInformation","type":"object"},"type":"array"}},"default":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.admin_kg_controller"}},"/system/modules/configuration":{"get":{"description":"Get modules configuration","operationId":"get_system_modules_configuration","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules configuration","schema":{"$ref":"#/definitions/SystemModulesConfiguration"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/modules/tasks":{"get":{"description":"Get modules tasks","operationId":"get_system_modules_tasks","parameters":[],"produces":["application/json"],"responses":{"201":{"description":"Modules tasks","schema":{"$ref":"#/definitions/SystemModulesTasks"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"tags":["System"],"x-swagger-router-controller":"api_server.controllers.controller"}},"/system/packages":{"get":{"description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","parameters":[],"produces":["application/json"],"responses":{"200":{"description":"Packages available to this CPS installation","schema":{"items":{"$ref":"#/definitions/CpsPackage"},"type":"array"}},"500":{"description":"Error occured on the server","schema":{"$ref":"#/definitions/Problem"}}},"security":[{"Bearer":[]}],"tags":["System"],"x-swagger-router-controller":"api_server.controllers.system_controller"}}},"produces":["application/json"],"schemes":["http","https"],"securityDefinitions":{"Bearer":{"description":"For accessing the API a valid JWT token must be passed in all the queries in\nthe 'Authorization' header.\n\nA valid JWT token is generated by the API and returned.\n\nThe following syntax must be used in the 'Authorization' header :\n Bearer xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"oidc_user_mngt.utils.connexion_auth.api_key_info"},"KGAuth":{"description":"API endpoints called by the KG application are authenticated by a valid JWT\ntoken which must contain the correct project resources which is needed.\nThe token must be passed in the 'X-CPS-KG-Authorization' header.\n\nA valid JWT token can be obtained by the CPS API or UI.\n\nThe following syntax must be used in the 'Authorization' header :\n KGToken xxxxxx.yyyyyyy.zzzzzz\n","in":"header","name":"X-CPS-KG-Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.kg_auth_info"},"ManagementKey":{"description":"For accessing the API using a valid management token, it must be passed in all the queries in\nthe 'Authorization' header.\n","in":"header","name":"Authorization","type":"apiKey","x-apikeyInfoFunc":"api_server.utils.connexion_auth.api_mngt_token_info"}},"swagger":"2.0"}