@@ -73,47 +63,6 @@ Let `URL` be the web address for an online document.
---
-### Multiple URLs
-
-Multiple online documents can also be conveniently converted.
-
-- For CLI:
-Create a text file containing the web addresses for online documents, separated by empty lines. For example, the contents of `ONLINE-DOCS.txt` could be:
-
-```text
-URL1
-URL2
-URL3
-```
-Let `PATH_ONLINE_DOCS` be the path to this text file.
-
-- For python:
-Simply pass a python list object containing multiple urls. Let `URL` be a list containing several URLs.
-
-=== "CLI"
-
-
- ```console
- deepsearch documents convert -p PROJ_KEY -u PATH_ONLINE_DOCS
- ```
-
-
-
-
-=== "Python"
- ```python
- import deepsearch as ds
- URL = ["https:///URL1", "https://URL2", "https://URL3"]
- documents = ds.convert_documents(api=api,proj_key=PROJ_KEY, urls=URL)
-
- # Let's download all the converted documents locally in RESULT_DIR
- documents.download_all(result_dir = RESULT_DIR)
- ```
-
-As we saw [before](#converting-local-documents), converted documents are automatically downloaded when using the CLI. Using python, the user specifies the directory where converted documents are downloaded.
-
----
-
## Generating reports
It is possible to create reports which inform the user about the document conversion tasks and their statuses. Such a report is useful in analysis and debugging large tasks.
@@ -149,14 +98,12 @@ The `DocumentConversionResult` object has a built-in method for generating repor
You can exercise control over the conversion settings used in document conversion through the python SDK as follows.
-To do so, initialise a `ConversionSettings` object, either using the system defaults, or the settings of a particular project.
+To do so, initialise a `ConversionSettings` object.
```python
from deepsearch.documents.core.models import ConversionSettings
-conv_settings = ConversionSettings.from_defaults(api)
-# or by using the project key:
-conv_settings = ConversionSettings.from_project(api, proj_key=PROJ_KEY)
+conv_settings = ConversionSettings()
# Modify conv_settings, see sections below...
@@ -171,89 +118,49 @@ documents = ds.convert_documents(
### Modify the conversion pipeline models
-You can modify the behaviour of the conversion pipeline by setting custom models for a task, or disabling them altogether. Currently, you may modify which models to use for layout segmentation (`clusters`), and for table structure prediction (`tables`).
+You can modify the behaviour of the conversion pipeline by setting custom models for a task, or disabling them altogether. Currently, you may modify which models to use for table structure prediction (`tables`).
#### Example 1: Disable the table structure predictions
-You can simply disable a model by setting it to `None`
+You can simply disable a model by setting it to `False`
```python
-conv_settings.pipeline.tables = None
+conv_settings.table_structure.do_table_structure = False
```
#### Example 2: Pick an alternative system model for table structure
-Deep Search may offer multiple alternative models for the same task, e.g. for table structure prediction. You can list all available models, and set a different model.
-
+Deep Search offer two alternative models for the same task, e.g. for table structure prediction. You can choose between `fast` and `accurate` where's default is `fast`.
-```python
-from deepsearch.documents.core.models import DefaultConversionModel
-
-# Find out which system models are available
-available_models = DefaultConversionModel.get_models(api)
-
-for m in available_models:
- print(f"Got model type={m.type}, name={m.name}")
-
-
-# Modify the settings to use another model (assuming it is available)
-conv_settings.pipeline.tables = \
- DefaultConversionModel(type="WalnutTableStructureModel")
-```
-#### Example 3: Pick a custom project model for table structure
-
-If you previously set up a custom model in your project, you can choose it the same way as above.
+You can simply change the table structure by setting it to `accurate`
```python
-from deepsearch.documents.core.models import ProjectConversionModel
-
-project_models = ProjectConversionModel.get_models(api, proj_key)
-
-for pm in project_models:
- if pm.name == "my-ts-model-test-1": # basic example: match by name
- conv_settings.pipeline.tables = pm
+conv_settings.table_structure.table_structure_mode = "accurate"
```
### Modify OCR settings
-If you want to use OCR, you can enable it and choose an OCR backend.
+By default OCR is enable, you can disable it or choose an OCR backend.
-#### Example 1: Enable default OCR
+#### Example 1: Disable default OCR
```python
-from deepsearch.documents.core.models import ConversionSettings, OCRSettings
+from deepsearch.documents.core.models import ConversionSettings
-conv_settings = ConversionSettings.from_defaults(api)
-conv_settings.ocr.enabled = True
+conv_settings = ConversionSettings()
+conv_settings.ocr.do_ocr = False
```
#### Example 2: Choose alternative OCR engine
-```python
-from deepsearch.documents.core.models import ConversionSettings, OCRSettings
-
-conv_settings = ConversionSettings.from_defaults(api)
-conv_settings.ocr.enabled = True
-
-# Find out which OCR backends are available
-engines = OCRSettings.get_backends(api)
-
-for b in engines:
- print(f"Got OCR backend id={b.id}")
-
-# We pick the first engine from the list above
-conv_settings.ocr.engine = engines[0]
-```
-
-#### Example 3: Specify OCR engine and language
+The default OCR engine is `easyocr`, you can change it to alternative `tesserocr`.
```python
-from deepsearch.documents.core.models import ConversionSettings, OCRSettings, AlpineOcrEngine
+from deepsearch.documents.core.models import ConversionSettings
-conv_settings = ConversionSettings.from_defaults(api)
-conv_settings.ocr.enabled = True
-conv_settings.ocr.engine = AlpineOcrEngine(languages=[AlpineOcrLanguage.Japanese])
+conv_settings = ConversionSettings()
+conv_settings.ocr.kind = "tesserocr"
```
diff --git a/tools/swagger-client-generator/generate-client.sh b/tools/swagger-client-generator/generate-client.sh
index 1f9a228c..a378de37 100755
--- a/tools/swagger-client-generator/generate-client.sh
+++ b/tools/swagger-client-generator/generate-client.sh
@@ -29,7 +29,7 @@ function download_swagger {
if [[ "${base_path}" == http* ]]; then
download_swagger "${base_path}/public/v1/swagger.json" "${curdir}/swagger-cps.json"
download_swagger "${base_path}/public/v2/openapi.json" "${curdir}/openapi-ds-v2.json"
- download_swagger "${base_path}/user/v1/swagger.json" "${curdir}/swagger-user.json"
+ download_swagger "${base_path}/user/v1/openapi.json" "${curdir}/swagger-user.json"
download_swagger "${base_path}/kg/v1/swagger.json" "${curdir}/swagger-cps-kg.json"
fi
diff --git a/tools/swagger-client-generator/openapi-ds-v2.json b/tools/swagger-client-generator/openapi-ds-v2.json
index 873649dd..e78bd259 100644
--- a/tools/swagger-client-generator/openapi-ds-v2.json
+++ b/tools/swagger-client-generator/openapi-ds-v2.json
@@ -1 +1 @@
-{"openapi":"3.1.0","info":{"title":"Deep Search (DS) API","description":"API for Deep Search.\n\n**WARNING**: This API is subject to change without warning!","version":"3.0.0"},"servers":[{"url":"/api/cps/public/v2"}],"paths":{"/project/{proj_key}/data_indices/documents/agents":{"get":{"tags":["Content Manager"],"summary":"Get Project Agents","description":"Get project agents.","operationId":"get_project_agents","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAgents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/transactions/{transaction_id}":{"get":{"tags":["Content Manager"],"summary":"Get Project Documents By Transaction","description":"Get project documents by transaction ID.","operationId":"get_project_documents_by_transaction","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","format":"uuid","title":"Transaction Id"},"name":"transaction_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/":{"get":{"tags":["Content Manager"],"summary":"Get All Project Data Index Documents","description":"Get all project documents","operationId":"get_all_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/statistics":{"get":{"tags":["Content Manager"],"summary":"Get Project Conversion Statistics","description":"Get project conversion statistics.","operationId":"get_project_conversion_statistics","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentStatistics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Documents","description":"Get project documents, can be filter by status.","operationId":"get_project_data_index_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}/grouped":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Grouped Documents","description":"Get project documents grouped by upload.","operationId":"get_project_data_index_grouped_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page","default":1},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Page Size","default":25},"name":"page_size","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGroupedDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/upload_jobs":{"get":{"tags":["Content Manager"],"summary":"Get Project Index Upload Jobs","description":"Get project upload jobs.","operationId":"get_project_index_upload_jobs","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUploadJobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/Markdown":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Markdown","description":"Get project document Markdown.","operationId":"get_project_data_index_document_markdown","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/PDF":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Pdf Document","description":"Get project PDF document.","operationId":"get_project_data_index_pdf_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/JSON":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Json Document","description":"Get project JSON document.","operationId":"get_project_data_index_json_document","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Json Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/artifacts":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Artifacts","description":"Get project document artifacts.","operationId":"get_project_data_index_document_artifacts","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentArtifacts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/metadata":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Metadata","description":"Get project document metadata.","operationId":"get_project_data_index_document_metadata","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/doc_events":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Events","description":"Get events of a project document.","operationId":"get_project_data_index_document_events","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Document Hash"},"name":"document_hash","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Agent Name"},"name":"agent_name","in":"query"},{"required":false,"schema":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"Status"},"name":"status","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Document Events"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Indices","description":"Get project data indices.","operationId":"get_project_data_indices","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"},"type":"array","title":"Response Get Project Data Indices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Data Indices"],"summary":"Create Project Data Index","description":"Create a project data index.","operationId":"create_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Index","description":"Get project data index.","operationId":"get_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Data Indices"],"summary":"Delete Project Data Index","description":"Delete a project index data.","operationId":"delete_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Confirmation Token"},"name":"confirmation_token","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"patch":{"tags":["Data Indices"],"summary":"Update Project Data Index","description":"Update a project data index.","operationId":"update_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"tags":["Data Indices"],"summary":"Create Project Data Index Delete Token","description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Project Data Index File","description":"Upload a file to a project data index.","operationId":"upload_project_data_index_file","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonUploadRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Register Project Documents","description":"Upload and register documents to be converted later.","operationId":"upload_register_project_documents","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsSources"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/load_elastic":{"post":{"tags":["Data Indices Upload"],"summary":"Load Project Data Index Files Elastic","description":"Load file(s) in a project data index to elastic.","operationId":"load_project_data_index_files_elastic","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadElasticRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert File Project Data Index","description":"Convert files via CCS previously registered and in a project data index.","operationId":"ccs_convert_file_project_data_index","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert Upload File Project Data Index","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":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertUploadDocumentsRequestBody"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Html Print Convert Upload","description":"Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"html_print_convert_upload","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataIndexUploadFileSource"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"tags":["Data Indices Upload"],"summary":"Get Attachment Upload Data","description":"Get url and path to upload an attachment to a project data index.","operationId":"get_attachment_upload_data","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"tags":["Data Indices Upload"],"summary":"Register Attachment","description":"Notify upload completion of an attachment to a project data index.","operationId":"register_attachment","parameters":[{"required":true,"schema":{"type":"string","title":"Index Key"},"name":"index_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Index Item Id"},"name":"index_item_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadRequestBody"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/public/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"List Public Knowledge Graphs","description":"List all public BAGs","operationId":"list_public_knowledge_graphs","parameters":[{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response List Public Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"Backend List Project Kgs","description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array","title":"Response Backend List Project Kgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Knowledge Graphs"],"summary":"Create Project Knowledge Graph","description":"Create new BAG, backend-aware","operationId":"create_project_knowledge_graph","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Create Project Knowledge Graph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"tags":["Knowledge Graphs"],"summary":"Update Project Knowledge Graph Metadata","description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","parameters":[{"required":true,"schema":{"title":"Bag Key"},"name":"bag_key","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Update Project Knowledge Graph Metadata"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/default_values":{"get":{"tags":["Project"],"summary":"Get Project Default Values","description":"List project's default values.","operationId":"get_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Default Values","description":"Update project's default values.","operationId":"update_project_default_values","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/integrations/genai":{"get":{"tags":["Project"],"summary":"Get Project Integration Config Genai","description":"Get the GenAI config for a given project.","operationId":"get_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"boolean","title":"Decode Secrets"},"name":"decode_secrets","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Response Get Project Integration Config Genai"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"post":{"tags":["Project"],"summary":"Update Project Integration Config Genai","description":"Update the GenAI config for a given project.","operationId":"update_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"title":"Config"}}},"required":true},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]},"delete":{"tags":["Project"],"summary":"Delete Project Integration Config Genai","description":"Delete the GenAI config for a given project integration.","operationId":"delete_project_integration_config_genai","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/packages":{"post":{"tags":["Project"],"summary":"Provision Project Packages","description":"Install packages on a project.","operationId":"provision_project_packages","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPackageInstalationManifest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/convert":{"post":{"tags":["Project"],"summary":"Convert Pdf Document","description":"Convert a PDF document directly to CCS.","operationId":"convert_pdf_document","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CcsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/convert_tasks/{task_id}":{"get":{"tags":["Project"],"summary":"Check Wait Ccs Task Task","description":"Check status of a CCS conversion task.","operationId":"check_wait_ccs_task_task","parameters":[{"required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","required":false,"schema":{"type":"number","maximum":30.0,"exclusiveMinimum":0.0,"title":"Wait","description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."},"name":"wait","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/semantic/ingest":{"post":{"tags":["Semantic"],"summary":"Ingest","description":"Ingest documents and collections for RAG","operationId":"ingest","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SemanticIngestRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/info":{"get":{"tags":["System"],"summary":"Get System Information","description":"Get system info.","operationId":"get_system_information","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}}}}},"/system/modules/configuration":{"get":{"tags":["System"],"summary":"Get System Modules Configuration","description":"Get modules configuration.","operationId":"get_system_modules_configuration","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulesConfig"}}}}}}},"/system/modules/tasks":{"get":{"tags":["System"],"summary":"Get System Modules Tasks","description":"Get modules configuration.","operationId":"get_system_modules_tasks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get System Modules Tasks"}}}}}}},"/system/kgs":{"get":{"tags":["System"],"summary":"List System Knowledge Graphs","description":"List all Knowledge Graphs in the system.","operationId":"list_system_knowledge_graphs","parameters":[{"required":false,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"query"},{"required":false,"schema":{"type":"string","title":"Term"},"name":"term","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response List System Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_kgs":{"get":{"tags":["System"],"summary":"System Get All Kgs Admin","description":"Get all kgs (only bag_key) for admin use.","operationId":"system_get_all_kgs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response System Get All Kgs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/packages":{"get":{"tags":["System"],"summary":"List Packages","description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSPackage"},"type":"array","title":"Response List Packages"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_dcs":{"get":{"tags":["System"],"summary":"System Get All Dcs Admin","description":"Get all data catalogs (only dc_key) for admin use.","operationId":"system_get_all_dcs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response System Get All Dcs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_all_flavours":{"get":{"tags":["System Flavours"],"summary":"List All Flavours","description":"Get all KG flavours storage on db.","operationId":"list_all_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Response List All Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavour/{flavour_name}":{"get":{"tags":["System Flavours"],"summary":"Get Flavour","description":"Get flavour from db.","operationId":"get_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavour":{"put":{"tags":["System Flavours"],"summary":"Save Flavour","description":"Save flavour on db.","operationId":"save_flavour","parameters":[{"required":true,"schema":{"type":"boolean","title":"New Flavour"},"name":"new_flavour","in":"query"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"tags":["System Flavours"],"summary":"Delete Flavour","description":"Delete flavour from db.","operationId":"delete_flavour","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_projects_flavours":{"get":{"tags":["System Flavours"],"summary":"List Projects Flavours","description":"Get all projects and their flavours.","operationId":"list_projects_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectsFlavours"},"type":"array","title":"Response List Projects Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours":{"put":{"tags":["System Flavours"],"summary":"Save Project Flavours","description":"Save project flavours assignment on db.","operationId":"save_project_flavours","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectsFlavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"tags":["System Flavours"],"summary":"List Flavours By Project","description":"Get project assignment flavours.","operationId":"list_flavours_by_project","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectFlavours"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"tags":["System Summary"],"summary":"System Get Kg Storage Summary Async","description":"Get knowledge graph storage summary.","operationId":"system_get_kg_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Kg Key"},"name":"kg_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"tags":["System Summary"],"summary":"System Get Dc Storage Summary Async","description":"Get data catalog storage summary.","operationId":"system_get_dc_storage_summary_async","parameters":[{"required":true,"schema":{"type":"string","title":"Dc Key"},"name":"dc_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/summary":{"get":{"tags":["System Summary"],"summary":"System Get Cps Summary","description":"Get cps summary data.","operationId":"system_get_cps_summary","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSSummary"},"type":"array","title":"Response System Get Cps Summary"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavours_default_quota":{"get":{"tags":["System Quotas"],"summary":"Get Flavours Default Quotas","description":"Get flavours default values.","operationId":"get_flavours_default_quotas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Get Flavours Default Quotas"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavours_default_quota":{"put":{"tags":["System Quotas"],"summary":"Save Flavours Default Quotas","description":"Save flavours default quota.","operationId":"save_flavours_default_quotas","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Flavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Save Flavours Default Quotas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_projects_flavours_quota":{"get":{"tags":["System Quotas"],"summary":"Get Projects Flavours Quota","description":"Get projects flavours quotas.","operationId":"get_projects_flavours_quota","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectFlavoursQuota"},"type":"array","title":"Response Get Projects Flavours Quota"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours_quota":{"put":{"tags":["System Quotas"],"summary":"Save Project Flavours Quota","description":"Save project flavours quota.","operationId":"save_project_flavours_quota","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavoursQuota"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavours Quota","description":"Get project flavours quota.","operationId":"get_project_flavours_quota","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Response Get Project Flavours Quota"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavour Total Kgs","description":"Gets kg total number by proj_key and flavour_key.","operationId":"get_project_flavour_total_kgs","parameters":[{"required":true,"schema":{"type":"string","title":"Flavour Name"},"name":"flavour_name","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavourTotalKgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Celery Task","description":"Get a celery task for a project.","operationId":"get_project_celery_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","required":false,"schema":{"type":"number","maximum":30.0,"exclusiveMinimum":0.0,"title":"Wait","description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."},"name":"wait","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks":{"get":{"tags":["Tasks"],"summary":"List Project Tasks","description":"List tasks for a project.","operationId":"list_project_tasks","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Task Type"},"name":"task_type","in":"query"},{"required":false,"schema":{"type":"integer","title":"Skip","default":0},"name":"skip","in":"query"},{"required":false,"schema":{"type":"integer","title":"Limit","default":50},"name":"limit","in":"query"},{"required":false,"schema":{"type":"string","title":"Sort By","default":"_id"},"name":"sort_by","in":"query"},{"required":false,"schema":{"type":"string","enum":["asc","desc"],"title":"Sort Order","default":"desc"},"name":"sort_order","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TaskContext"},"type":"array","title":"Response List Project Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Task","description":"Get a task for a project.","operationId":"get_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"tags":["Tasks"],"summary":"Abort Project Task","description":"Abort a task.","operationId":"abort_project_task","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files","description":"Get temporary files uploaded to a project.","operationId":"list_project_scratch_files","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"string","title":"Scratch Ids"},"name":"scratch_ids","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Response List Project Scratch Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files_paginated":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files Paginated","description":"Get paginated list of temporary files uploaded to a project.","operationId":"list_project_scratch_files_paginated","parameters":[{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"},{"required":false,"schema":{"type":"integer","title":"Page"},"name":"page","in":"query"},{"required":false,"schema":{"type":"integer","title":"Items Per Page","default":20},"name":"items_per_page","in":"query"},{"required":false,"schema":{"type":"string","title":"Search String"},"name":"search_string","in":"query"},{"required":false,"schema":{"type":"integer","title":"Begin Date"},"name":"begin_date","in":"query"},{"required":false,"schema":{"type":"integer","title":"End Date"},"name":"end_date","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectScratchFilesPaginated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"tags":["Upload"],"summary":"Create Project Scratch File","description":"Create file pointers for temporary storage.","operationId":"create_project_scratch_file","parameters":[{"required":true,"schema":{"type":"string","title":"Filename"},"name":"filename","in":"path"},{"required":true,"schema":{"type":"string","title":"Proj Key"},"name":"proj_key","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryUploadFileResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}}},"components":{"schemas":{"AssembleMode":{"properties":{"page_elements":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Page Elements"},"tables":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Tables"}},"type":"object","required":["page_elements","tables"],"title":"AssembleMode"},"AssembleSettings":{"properties":{"mode":{"$ref":"#/components/schemas/AssembleMode"},"include_incomplete_documents":{"type":"boolean","title":"Include Incomplete Documents"}},"type":"object","required":["mode","include_incomplete_documents"],"title":"AssembleSettings"},"AttachmentUploadData":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"upload_data":{"type":"string","title":"Upload Data"}},"type":"object","required":["attachment_path","upload_data"],"title":"AttachmentUploadData"},"AttachmentUploadRequestBody":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"attachment_key":{"type":"string","title":"Attachment Key","default":"usr_attachments"}},"type":"object","required":["attachment_path"],"title":"AttachmentUploadRequestBody"},"BagFlavourFullData":{"properties":{"backend":{"type":"string","title":"Backend"},"config":{"type":"object","title":"Config"},"default_quota":{"type":"integer","title":"Default Quota","default":0},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"is_from_deployment":{"type":"boolean","title":"Is From Deployment","default":true},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order","default":0},"project_specific":{"type":"boolean","title":"Project Specific"}},"type":"object","required":["backend","config","description","display_name","name","project_specific"],"title":"BagFlavourFullData"},"CCSProject":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"collection_name":{"type":"string","title":"Collection Name"}},"type":"object","required":["name","proj_key","collection_name"],"title":"CCSProject"},"CPSPackage":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"package_id":{"type":"string","title":"Package Id"},"type":{"type":"string","enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"title":"Type"}},"type":"object","required":["name","description","package_id","type"],"title":"CPSPackage"},"CPSSummary":{"properties":{"availCpuSlots":{"type":"integer","title":"Availcpuslots"},"availMemSlots":{"type":"integer","title":"Availmemslots"},"availSlots":{"type":"integer","title":"Availslots"},"name":{"type":"string","title":"Name"},"numNodes":{"type":"integer","title":"Numnodes"},"numberKgs":{"type":"integer","title":"Numberkgs"},"runningKgs":{"type":"integer","title":"Runningkgs"},"workersPool":{"type":"string","title":"Workerspool"}},"type":"object","required":["availCpuSlots","availMemSlots","availSlots","name","numNodes","numberKgs","runningKgs","workersPool"],"title":"CPSSummary"},"CcsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"ccs_project_key":{"type":"string","title":"Ccs Project Key"},"ccs_collection_name":{"type":"string","title":"Ccs Collection Name"}},"type":"object","required":["task_id","ccs_project_key","ccs_collection_name"],"title":"CcsTask"},"CollectionMetadataSettings":{"properties":{"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"license":{"type":"string","title":"License"},"source":{"type":"string","title":"Source"},"version":{"type":"string","title":"Version"}},"type":"object","title":"CollectionMetadataSettings"},"ConvertDocumentRequest":{"properties":{"http_source":{"$ref":"#/components/schemas/HttpSource"},"file_source":{"$ref":"#/components/schemas/FileSource"}},"type":"object","title":"ConvertDocumentRequest"},"ConvertDocumentsRequestBody":{"properties":{"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"allOf":[{"$ref":"#/components/schemas/TargetConversionParameters"}],"title":"Target Settings","description":"Specify the target settings to use."},"document_hashes":{"items":{"type":"string"},"type":"array","title":"Document Hashes","description":"List of document hashes to be used as filter."},"without_operations":{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array","title":"Without Operations","description":"List of Operation Status documents don't have to be used as filter."},"upload_to_elastic":{"type":"boolean","title":"Upload To Elastic"}},"type":"object","title":"ConvertDocumentsRequestBody"},"ConvertDocumentsSources":{"properties":{"file_url":{"items":{"type":"string"},"type":"array","title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"internal_file_url":{"items":{"$ref":"#/components/schemas/InternalUrl"},"type":"array","title":"Internal File Url","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"allOf":[{"$ref":"#/components/schemas/S3DocumentSource"}],"title":"S3 Source","description":"Coordinates to object store to get files to convert. Can specify which files with object keys."}},"type":"object","title":"ConvertDocumentsSources"},"ConvertUploadDocumentsRequestBody":{"properties":{"file_url":{"items":{"type":"string"},"type":"array","title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"internal_file_url":{"items":{"$ref":"#/components/schemas/InternalUrl"},"type":"array","title":"Internal File Url","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"allOf":[{"$ref":"#/components/schemas/S3DocumentSource"}],"title":"S3 Source","description":"Coordinates to object store to get files to convert. Can specify which files with object keys."},"upload_to_elastic":{"type":"boolean","title":"Upload To Elastic"},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"allOf":[{"$ref":"#/components/schemas/TargetConversionParameters"}],"title":"Target Settings","description":"Specify the target settings to use."}},"type":"object","title":"ConvertUploadDocumentsRequestBody"},"CpsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"task_type":{"type":"string","title":"Task Type"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_type","task_status"],"title":"CpsTask"},"DataFlow":{"properties":{"df_tpl_key":{"type":"string","title":"Df Tpl Key"},"name":{"type":"string","title":"Name"}},"type":"object","required":["df_tpl_key","name"],"title":"DataFlow"},"DataIndexUploadFileSource":{"properties":{"urls":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Urls","description":"List of URLs to be printed to PDF, converted and uploaded to the data index."},"conversion_settings":{"allOf":[{"$ref":"#/components/schemas/PartialDirectConversionParameters"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."}},"type":"object","required":["urls"],"title":"DataIndexUploadFileSource"},"DefaultValues":{"properties":{"ccs_project":{"$ref":"#/components/schemas/CCSProject"},"dataflow":{"$ref":"#/components/schemas/DataFlow"}},"type":"object","required":["ccs_project"],"title":"DefaultValues"},"Deployment":{"properties":{"name":{"type":"string","title":"Name"},"disclaimer":{"type":"string","title":"Disclaimer"},"should_show_warning":{"type":"boolean","title":"Should Show Warning"},"disable_kg_actions":{"type":"boolean","title":"Disable Kg Actions"},"linked_ccs_api":{"type":"object","title":"Linked Ccs Api"}},"type":"object","required":["name","disclaimer","should_show_warning","disable_kg_actions","linked_ccs_api"],"title":"Deployment"},"DirectModelConfig":{"properties":{"type":{"type":"string","title":"Type"},"config":{"type":"object","title":"Config"}},"type":"object","required":["type","config"],"title":"DirectModelConfig","description":"Direct configuration of a model."},"DocumentArtifacts":{"properties":{"document_meta_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_pdf":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_glm_json":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"document_md":{"$ref":"#/components/schemas/DocumentArtifactsItem"},"page_pdfs":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Pdfs","default":[]},"page_images":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Images","default":[]}},"type":"object","title":"DocumentArtifacts"},"DocumentArtifactsItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"}},"type":"object","required":["mime","path","url"],"title":"DocumentArtifactsItem"},"DocumentArtifactsPageItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"},"page":{"type":"integer","title":"Page","description":"Page number starting at 1."}},"type":"object","required":["mime","path","url","page"],"title":"DocumentArtifactsPageItem"},"DocumentStatistics":{"properties":{"total_documents":{"type":"integer","title":"Total Documents"},"documents_pending":{"type":"integer","title":"Documents Pending"},"documents_failed":{"type":"integer","title":"Documents Failed"},"documents_converted":{"type":"integer","title":"Documents Converted"}},"type":"object","required":["total_documents","documents_pending","documents_failed","documents_converted"],"title":"DocumentStatistics"},"ElasticIndexPropertyObject":{"properties":{"type":{"type":"string","title":"Type"},"enabled":{"type":"boolean","title":"Enabled"},"ignore_above":{"type":"integer","title":"Ignore Above"}},"type":"object","required":["type"],"title":"ElasticIndexPropertyObject"},"ElasticIndexPropertyPrimitive":{"properties":{"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Properties"}},"type":"object","required":["properties"],"title":"ElasticIndexPropertyPrimitive"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"items":{"type":"string"},"type":"array","title":" Source"},"from_":{"type":"integer","title":"From "},"size":{"type":"integer","title":"Size"},"query":{"type":"object","title":"Query"},"aggs":{"type":"object","title":"Aggs"},"sort":{"items":{"type":"object"},"type":"array","title":"Sort"}},"type":"object","title":"ElasticIndexSearchQueryOptions"},"ElasticIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","elastic_id"],"title":"ElasticIndexSource"},"ElasticInstanceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","query_options","elastic_id"],"title":"ElasticInstanceDataIndex"},"ElasticMetadata":{"properties":{"aliases":{"items":{"type":"string"},"type":"array","title":"Aliases"},"created":{"type":"string","title":"Created"},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"source":{"type":"string","title":"Source"},"storage":{"type":"string","title":"Storage"},"version":{"type":"string","title":"Version"},"type":{"type":"string","title":"Type"},"domain":{"items":{"type":"string"},"type":"array","title":"Domain"},"classification":{"items":{"type":"string"},"type":"array","title":"Classification"}},"type":"object","required":["classification"],"title":"ElasticMetadata"},"FileSource":{"properties":{"base64_string":{"type":"string","title":"Base64 String"},"filename":{"type":"string","title":"Filename"}},"type":"object","required":["base64_string","filename"],"title":"FileSource"},"Flavour":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"}},"type":"object","required":["name"],"title":"Flavour"},"FlavoursDefaultQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"default_quota":{"type":"integer","title":"Default Quota"}},"type":"object","required":["display_name","name","default_quota"],"title":"FlavoursDefaultQuota"},"FlavoursQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"quota":{"type":"integer","title":"Quota"}},"type":"object","required":["display_name","name","quota"],"title":"FlavoursQuota"},"GenAIAWSBedrock":{"properties":{"kind":{"type":"string","enum":["aws_bedrock"],"title":"Kind","default":"aws_bedrock"},"config":{"$ref":"#/components/schemas/GenAIAWSBedrockConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIAWSBedrock","description":"GenAI integration for AWS Bedrock settings"},"GenAIAWSBedrockConfig":{"properties":{"GENAI_AWS_ACCESS_KEY":{"type":"string","format":"password","title":"Genai Aws Access Key","writeOnly":true},"GENAI_AWS_SECRET_KEY":{"type":"string","format":"password","title":"Genai Aws Secret Key","writeOnly":true},"GENAI_AWS_REGION_NAME":{"type":"string","title":"Genai Aws Region Name"}},"type":"object","required":["GENAI_AWS_ACCESS_KEY","GENAI_AWS_SECRET_KEY","GENAI_AWS_REGION_NAME"],"title":"GenAIAWSBedrockConfig","description":"Config for AWS Bedrock"},"GenAIBAM":{"properties":{"kind":{"type":"string","enum":["bam"],"title":"Kind","default":"bam"},"config":{"$ref":"#/components/schemas/GenAIBAMConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIBAM","description":"GenAI integration for BAM settings"},"GenAIBAMConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_KEY"],"title":"GenAIBAMConfig","description":"Config for BAM"},"GenAIHFInferenceApi":{"properties":{"kind":{"type":"string","enum":["hf_api"],"title":"Kind","default":"hf_api"},"config":{"$ref":"#/components/schemas/GenAIHFInferenceApiConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIHFInferenceApi","description":"GenAI integration for Inference API settings"},"GenAIHFInferenceApiConfig":{"properties":{"GENAI_HF_API_KEY":{"type":"string","format":"password","title":"Genai Hf Api Key","writeOnly":true}},"type":"object","required":["GENAI_HF_API_KEY"],"title":"GenAIHFInferenceApiConfig","description":"Config for HF Inference API"},"GenAIParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"},"timeout":{"type":"number","title":"Timeout"}},"type":"object","required":["model_id","prompt_template","params","timeout"],"title":"GenAIParams"},"GenAIPartialParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"},"timeout":{"type":"number","title":"Timeout"}},"type":"object","title":"GenAIPartialParams"},"GenAIWatsonx":{"properties":{"kind":{"type":"string","enum":["watsonx"],"title":"Kind","default":"watsonx"},"config":{"$ref":"#/components/schemas/GenAIWatsonxConfig"},"proj_params":{"$ref":"#/components/schemas/GenAIPartialParams"}},"type":"object","required":["config"],"title":"GenAIWatsonx","description":"GenAI integration for watsonx settings"},"GenAIWatsonxConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_PROJECT_ID":{"type":"string","title":"Genai Project Id"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_PROJECT_ID","GENAI_KEY"],"title":"GenAIWatsonxConfig","description":"Config for watsonx"},"GroupedProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"},"upload_date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"title":"Upload Date"}},"type":"object","required":["documents","upload_date"],"title":"GroupedProjectDocuments"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HttpSource":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"type":"object","title":"Headers"}},"type":"object","required":["url","headers"],"title":"HttpSource"},"InternalUrl":{"properties":{"download_url":{"type":"string","title":"Download Url"},"header_url":{"type":"string","title":"Header Url"}},"type":"object","required":["download_url","header_url"],"title":"InternalUrl"},"JsonUploadRequestBody":{"properties":{"file_url":{"type":"string","title":"File Url"}},"type":"object","required":["file_url"],"title":"JsonUploadRequestBody"},"ListProjectFlavours":{"properties":{"flavours":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Flavours"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["flavours","proj_key"],"title":"ListProjectFlavours"},"ModelPipelineSettings":{"properties":{"clusters":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Clusters"},"page":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Page"},"tables":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Tables"},"normalization":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Normalization"}},"type":"object","required":["clusters","page","tables","normalization"],"title":"ModelPipelineSettings"},"ModulesConfig":{"properties":{"df_template_variables":{"items":{},"type":"array","title":"Df Template Variables"},"linked_ccs_instances":{"items":{},"type":"array","title":"Linked Ccs Instances"},"linked_elastic_instances":{"items":{},"type":"array","title":"Linked Elastic Instances"}},"type":"object","required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"title":"ModulesConfig"},"OcrSettings":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"backend":{"type":"string","title":"Backend"},"backend_settings":{"type":"object","title":"Backend Settings"},"merge_mode":{"type":"string","title":"Merge Mode"}},"type":"object","title":"OcrSettings"},"Package":{"properties":{"overrides":{"type":"object","title":"Overrides"},"package_id":{"type":"string","title":"Package Id"}},"type":"object","required":["overrides","package_id"],"title":"Package"},"PartialDirectConversionParameters":{"properties":{"type":{"type":"string","enum":["direct"],"title":"Type","default":"direct"},"ocr":{"$ref":"#/components/schemas/OcrSettings"},"assemble":{"$ref":"#/components/schemas/AssembleSettings"},"metadata":{"$ref":"#/components/schemas/CollectionMetadataSettings"},"page_labels":{"additionalProperties":{"type":"object"},"type":"object","title":"Page Labels"},"model_pipeline":{"$ref":"#/components/schemas/ModelPipelineSettings"}},"type":"object","title":"PartialDirectConversionParameters","description":"Specify conversion settings (OCR, Assemble, ML Models) directly.\n\nFields left null are set to platform defaults."},"ProjectAgent":{"properties":{"agent_info":{"type":"object","title":"Agent Info"},"agent_name":{"type":"string","title":"Agent Name"},"version":{"type":"string","title":"Version"}},"type":"object","required":["agent_info","agent_name","version"],"title":"ProjectAgent"},"ProjectAgents":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/ProjectAgent"},"type":"array","title":"Agents"}},"type":"object","required":["agents"],"title":"ProjectAgents"},"ProjectDataIndexNonView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key","default":"generic"}},"type":"object","required":["name"],"title":"ProjectDataIndexNonView"},"ProjectDataIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","proj_key"],"title":"ProjectDataIndexSource"},"ProjectDataIndexView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"}},"type":"object","required":["name","view_of"],"title":"ProjectDataIndexView"},"ProjectDataIndexWithStatus":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexSource"},{"$ref":"#/components/schemas/ProjectDataIndexSource"}],"title":"Source"},"name":{"type":"string","title":"Name"},"documents":{"type":"integer","title":"Documents"},"health":{"type":"string","title":"Health"},"status":{"type":"string","title":"Status"},"creation_date":{"type":"string","title":"Creation Date"},"metadata":{"$ref":"#/components/schemas/ElasticMetadata"},"description":{"type":"string","title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key"},"type":{"type":"string","title":"Type"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"},"record_properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Record Properties"},"provenance":{"type":"string","title":"Provenance"}},"type":"object","required":["source","name","documents","health","status","creation_date","description","type"],"title":"ProjectDataIndexWithStatus"},"ProjectDocument":{"properties":{"document_hash":{"type":"string","title":"Document Hash"},"filename":{"type":"string","title":"Filename"},"file_uri":{"type":"string","title":"File Uri"},"ref_uri":{"type":"string","title":"Ref Uri"},"number_pages":{"type":"integer","title":"Number Pages"},"status":{"type":"string","title":"Status"}},"type":"object","required":["document_hash","filename"],"title":"ProjectDocument"},"ProjectDocumentURL":{"properties":{"download_url":{"type":"string","title":"Download Url"}},"type":"object","required":["download_url"],"title":"ProjectDocumentURL"},"ProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"}},"type":"object","required":["documents"],"title":"ProjectDocuments"},"ProjectFlavourTotalKgs":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"flavour_name":{"type":"string","title":"Flavour Name"},"total_kgs":{"type":"integer","title":"Total Kgs"}},"type":"object","required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs"},"ProjectFlavoursQuota":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"quotas":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Quotas"}},"type":"object","required":["name","proj_key","quotas"],"title":"ProjectFlavoursQuota"},"ProjectPackageInstalationManifest":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/Package"},"type":"array","title":"Packages"}},"type":"object","required":["packages"],"title":"ProjectPackageInstalationManifest"},"ProjectScratchFiles":{"properties":{"id":{"type":"string","title":"Id"},"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"filename":{"type":"string","title":"Filename"},"timestamp":{"type":"string","title":"Timestamp"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","proj_key","user_key","filename","timestamp","url"],"title":"ProjectScratchFiles"},"ProjectScratchFilesPaginated":{"properties":{"files":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Files"},"count":{"type":"integer","title":"Count"},"page":{"type":"integer","title":"Page"},"items_per_page":{"type":"integer","title":"Items Per Page"}},"type":"object","required":["files","count","page","items_per_page"],"title":"ProjectScratchFilesPaginated"},"ProjectSourceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","query_options","proj_key"],"title":"ProjectSourceDataIndex"},"ProjectsFlavours":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name"},"flavours":{"items":{"$ref":"#/components/schemas/Flavour"},"type":"array","title":"Flavours"}},"type":"object","required":["proj_key","name","flavours"],"title":"ProjectsFlavours"},"ReferenceToModel":{"properties":{"model_config_key":{"type":"string","title":"Model Config Key"},"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["model_config_key","proj_key"],"title":"ReferenceToModel","description":"Reference to a model configuration."},"ResponseDocumentArtifacts":{"properties":{"artifacts":{"$ref":"#/components/schemas/DocumentArtifacts"}},"type":"object","required":["artifacts"],"title":"ResponseDocumentArtifacts"},"ResponseGroupedDocuments":{"properties":{"grouped_documents":{"items":{"$ref":"#/components/schemas/GroupedProjectDocuments"},"type":"array","title":"Grouped Documents"}},"type":"object","required":["grouped_documents"],"title":"ResponseGroupedDocuments"},"ResponseUploadJobs":{"properties":{"upload_jobs":{"items":{"$ref":"#/components/schemas/UploadJob"},"type":"array","title":"Upload Jobs"}},"type":"object","required":["upload_jobs"],"title":"ResponseUploadJobs"},"S3Coordinates":{"properties":{"host":{"type":"string","title":"Host"},"port":{"type":"integer","title":"Port"},"ssl":{"type":"boolean","title":"Ssl"},"verifySSL":{"type":"boolean","title":"Verifyssl"},"access-key":{"type":"string","title":"Access-Key"},"secret-key":{"type":"string","title":"Secret-Key"},"bucket":{"type":"string","title":"Bucket"},"key_prefix":{"type":"string","title":"Key Prefix"},"location":{"type":"string","title":"Location"}},"type":"object","required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location"],"title":"S3Coordinates"},"S3DocumentSource":{"properties":{"coordinates":{"$ref":"#/components/schemas/S3Coordinates"},"object_keys":{"items":{"type":"string"},"type":"array","title":"Object Keys","description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index."}},"type":"object","required":["coordinates"],"title":"S3DocumentSource","description":"Specifies documents to import from an S3 bucket"},"SemanticIngestReqParams":{"properties":{"skip_ingested_docs":{"type":"boolean","title":"Skip Ingested Docs"}},"type":"object","required":["skip_ingested_docs"],"title":"SemanticIngestReqParams"},"SemanticIngestRequest":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/SemanticIngestSourceUrl"},{"$ref":"#/components/schemas/SemanticIngestSourcePublicDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataCollection"}],"title":"Source"},"parameters":{"$ref":"#/components/schemas/SemanticIngestReqParams"}},"type":"object","required":["source","parameters"],"title":"SemanticIngestRequest"},"SemanticIngestSourcePrivateDataCollection":{"properties":{"type":{"type":"string","enum":["private_data_collection"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"}},"type":"object","required":["type","proj_key","index_key"],"title":"SemanticIngestSourcePrivateDataCollection"},"SemanticIngestSourcePrivateDataDocument":{"properties":{"type":{"type":"string","enum":["private_data_document"],"title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","proj_key","index_key","document_hash"],"title":"SemanticIngestSourcePrivateDataDocument"},"SemanticIngestSourcePublicDataDocument":{"properties":{"type":{"type":"string","enum":["public_data_document"],"title":"Type"},"elastic_id":{"type":"string","title":"Elastic Id"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","elastic_id","index_key","document_hash"],"title":"SemanticIngestSourcePublicDataDocument"},"SemanticIngestSourceUrl":{"properties":{"type":{"type":"string","enum":["url"],"title":"Type"},"url":{"type":"string","title":"Url"}},"type":"object","required":["type","url"],"title":"SemanticIngestSourceUrl"},"StorageSummaryTask":{"properties":{"dc_key":{"type":"string","title":"Dc Key"},"kg_key":{"type":"string","title":"Kg Key"},"kind":{"type":"string","enum":["project_task","celery_task"],"title":"Kind"},"proj_key":{"type":"string","title":"Proj Key"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["kind","proj_key","task_id"],"title":"StorageSummaryTask"},"SystemInfo":{"properties":{"notifications":{"items":{},"type":"array","title":"Notifications"},"default_project":{"type":"object","title":"Default Project"},"deployment":{"$ref":"#/components/schemas/Deployment"},"toolkit":{"type":"object","title":"Toolkit"},"allow_non_admins_to_make_resources_public":{"type":"boolean","title":"Allow Non Admins To Make Resources Public"},"api":{"type":"object","title":"Api"},"genai_defaults":{"additionalProperties":{"$ref":"#/components/schemas/GenAIParams"},"type":"object","title":"Genai Defaults"}},"type":"object","required":["notifications","default_project","deployment","toolkit","allow_non_admins_to_make_resources_public","api","genai_defaults"],"title":"SystemInfo"},"TargetConversionParameters":{"properties":{"add_raw_pages":{"type":"boolean","title":"Add Raw Pages"},"add_annotations":{"type":"boolean","title":"Add Annotations"}},"type":"object","title":"TargetConversionParameters","description":"Specify target settings (add_raw_pages, add_annotations).\n\nFields left null are set to platform defaults."},"TaskContext":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"task_type":{"type":"string","title":"Task Type"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"},"execution_mode":{"type":"string","title":"Execution Mode"},"progress":{"type":"number","title":"Progress"},"meta":{"type":"object","title":"Meta"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"type":"string","format":"date-time","title":"Started At"},"completed_at":{"type":"string","format":"date-time","title":"Completed At"},"start_count":{"type":"integer","title":"Start Count"},"error_reason":{"type":"string","title":"Error Reason"},"related_tasks":{"items":{},"type":"array","title":"Related Tasks"}},"type":"object","required":["proj_key","user_key","task_type","task_id","task_status","execution_mode","progress","meta","created_at"],"title":"TaskContext"},"TaskResult":{"properties":{"result":{"title":"Result"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_status"],"title":"TaskResult"},"TemporaryUploadFileResult":{"properties":{"id":{"type":"string","title":"Id"},"upload":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata":{"$ref":"#/components/schemas/TemporaryUrl"},"upload_private":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download_private":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata_private":{"$ref":"#/components/schemas/TemporaryUrl"}},"type":"object","required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult"},"TemporaryUrl":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"TemporaryUrl"},"TemporaryUrlFields":{"properties":{"url":{"type":"string","title":"Url"},"fields":{"type":"object","title":"Fields"}},"type":"object","required":["url","fields"],"title":"TemporaryUrlFields"},"TokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"TokenResponse"},"UploadElasticRequestBody":{"properties":{"document_hashes":{"items":{"type":"string"},"type":"array","title":"Document Hashes","description":"List of document hashes to be used as filter."},"with_operations":{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array","title":"With Operations","description":"List of Operation Status documents don't have to be used as filter."}},"type":"object","title":"UploadElasticRequestBody"},"UploadJob":{"properties":{"date":{"type":"string","format":"date-time","title":"Date"},"num_docs":{"type":"integer","title":"Num Docs"}},"type":"object","required":["date","num_docs"],"title":"UploadJob"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Provide a Bearer token in the `Authorization` header","in":"header","name":"Authorization"}}}}
\ No newline at end of file
+{"openapi":"3.1.0","info":{"title":"Deep Search (DS) API","description":"API for Deep Search.\n\n**WARNING**: This API is subject to change without warning!","version":"3.0.0"},"servers":[{"url":"/api/cps/public/v2"}],"paths":{"/project/{proj_key}/data_indices/documents/agents":{"get":{"tags":["Content Manager"],"summary":"Get Project Agents","description":"Get project agents.","operationId":"get_project_agents","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAgents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/transactions/{transaction_id}":{"get":{"tags":["Content Manager"],"summary":"Get Project Documents By Transaction","description":"Get project documents by transaction ID.","operationId":"get_project_documents_by_transaction","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"transaction_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Transaction Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/":{"get":{"tags":["Content Manager"],"summary":"Get All Project Data Index Documents","description":"Get all project documents","operationId":"get_all_project_data_index_documents","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/statistics":{"get":{"tags":["Content Manager"],"summary":"Get Project Conversion Statistics","description":"Get project conversion statistics.","operationId":"get_project_conversion_statistics","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentStatistics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Documents","description":"Get project documents, can be filter by status.","operationId":"get_project_data_index_documents","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"agent_name","in":"path","required":true,"schema":{"type":"string","title":"Agent Name"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StatusFilter","description":"Filter the documents by conversion status."}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/agent/{agent_name}/grouped":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Grouped Documents","description":"Get project documents grouped by upload.","operationId":"get_project_data_index_grouped_documents","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"agent_name","in":"path","required":true,"schema":{"type":"string","title":"Agent Name"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StatusFilter","description":"Filter the documents by conversion status."}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"page_size","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Page Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseGroupedDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/upload_jobs":{"get":{"tags":["Content Manager"],"summary":"Get Project Index Upload Jobs","description":"Get project upload jobs.","operationId":"get_project_index_upload_jobs","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseUploadJobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/Markdown":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Markdown","description":"Get project document Markdown.","operationId":"get_project_data_index_document_markdown","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/PDF":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Pdf Document","description":"Get project PDF document.","operationId":"get_project_data_index_pdf_document","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocumentURL"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/JSON":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Json Document","description":"Get project JSON document.","operationId":"get_project_data_index_json_document","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Json Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/artifacts":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Artifacts","description":"Get project document artifacts.","operationId":"get_project_data_index_document_artifacts","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseDocumentArtifacts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/metadata":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Metadata","description":"Get project document metadata.","operationId":"get_project_data_index_document_metadata","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Content Manager"],"summary":"Add Project Data Index Document Metadata","description":"Insert project document metadata.","operationId":"add_project_data_index_document_metadata","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMeta"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{document_hash}/doc_events":{"get":{"tags":["Content Manager"],"summary":"Get Project Data Index Document Events","description":"Get events of a project document.","operationId":"get_project_data_index_document_events","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"document_hash","in":"path","required":true,"schema":{"type":"string","title":"Document Hash"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"agent_name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Agent Name"}},{"name":"status","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StatusFilter","description":"Filter the documents by conversion status."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get Project Data Index Document Events"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Indices","description":"Get project data indices.","operationId":"get_project_data_indices","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"},"title":"Response Get Project Data Indices"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Data Indices"],"summary":"Create Project Data Index","description":"Create a project data index.","operationId":"create_project_data_index","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Index","description":"Get project data index.","operationId":"get_project_data_index","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Data Indices"],"summary":"Update Project Data Index","description":"Update a project data index.","operationId":"update_project_data_index","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexView"},{"$ref":"#/components/schemas/ProjectDataIndexNonView"}],"title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexWithStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Data Indices"],"summary":"Delete Project Data Index","description":"Delete a project index data.","operationId":"delete_project_data_index","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"confirmation_token","in":"query","required":true,"schema":{"type":"string","title":"Confirmation Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/delete_token":{"post":{"tags":["Data Indices"],"summary":"Create Project Data Index Delete Token","description":"Get a token used to confirm the deletion of a project data index.","operationId":"create_project_data_index_delete_token","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/conversion_settings":{"get":{"tags":["Data Indices"],"summary":"Get Project Data Index Conversion Settings","description":"Get project data index conversion settings.","operationId":"get_project_data_index_conversion_settings","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Output"},{"type":"null"}],"title":"Response Get Project Data Index Conversion Settings"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Data Indices"],"summary":"Update Project Data Index Conversion Settings","description":"Update a project data index conversion settings.","operationId":"update_project_data_index_conversion_settings","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Input"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Output"},{"type":"null"}],"title":"Response Update Project Data Index Conversion Settings"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/upload":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Project Data Index File","description":"Upload a file to a project data index.","operationId":"upload_project_data_index_file","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonUploadRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/upload_register_documents":{"post":{"tags":["Data Indices Upload"],"summary":"Upload Register Project Documents","description":"Upload and register documents to be converted later.","operationId":"upload_register_project_documents","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsSources"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/load_elastic":{"post":{"tags":["Data Indices Upload"],"summary":"Load Project Data Index Files Elastic","description":"Load file(s) in a project data index to elastic.","operationId":"load_project_data_index_files_elastic","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadElasticRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert File Project Data Index","description":"Convert files via CCS previously registered and in a project data index.","operationId":"ccs_convert_file_project_data_index","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentsRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Ccs Convert Upload File Project Data Index","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","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertUploadDocumentsRequestBody"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload":{"post":{"tags":["Data Indices Upload"],"summary":"Html Print Convert Upload","description":"Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema).","operationId":"html_print_convert_upload","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataIndexUploadFileSource"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}":{"get":{"tags":["Data Indices Upload"],"summary":"Get Attachment Upload Data","description":"Get url and path to upload an attachment to a project data index.","operationId":"get_attachment_upload_data","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"index_item_id","in":"path","required":true,"schema":{"type":"string","title":"Index Item Id"}},{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment":{"post":{"tags":["Data Indices Upload"],"summary":"Register Attachment","description":"Notify upload completion of an attachment to a project data index.","operationId":"register_attachment","security":[{"Bearer":[]}],"parameters":[{"name":"index_key","in":"path","required":true,"schema":{"type":"string","title":"Index Key"}},{"name":"index_item_id","in":"path","required":true,"schema":{"type":"string","title":"Index Item Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachmentUploadRequestBody"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/public/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"List Public Knowledge Graphs","description":"List all public BAGs","operationId":"list_public_knowledge_graphs","security":[{"Bearer":[]}],"parameters":[{"name":"term","in":"query","required":false,"schema":{"anyOf":[{},{"type":"null"}],"title":"Term"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"},"title":"Response List Public Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/backend/project/{proj_key}/bags":{"get":{"tags":["Knowledge Graphs"],"summary":"Backend List Project Kgs","description":"List all bags in the project, backend-aware","operationId":"backend_list_project_kgs","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"term","in":"query","required":false,"schema":{"title":"Term"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object"},"title":"Response Backend List Project Kgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Knowledge Graphs"],"summary":"Create Project Knowledge Graph","description":"Create new BAG, backend-aware","operationId":"create_project_knowledge_graph","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Create Project Knowledge Graph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/backend/project/{proj_key}/bags/{bag_key}":{"patch":{"tags":["Knowledge Graphs"],"summary":"Update Project Knowledge Graph Metadata","description":"Update the metadata of a Knowledge graph","operationId":"update_project_knowledge_graph_metadata","security":[{"Bearer":[]}],"parameters":[{"name":"bag_key","in":"path","required":true,"schema":{"title":"Bag Key"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Update Project Knowledge Graph Metadata"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/default_values":{"get":{"tags":["Project"],"summary":"Get Project Default Values","description":"List project's default values.","operationId":"get_project_default_values","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Project"],"summary":"Update Project Default Values","description":"Update project's default values.","operationId":"update_project_default_values","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DefaultValues"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/integrations/genai":{"get":{"tags":["Project"],"summary":"Get Project Integration Config Genai","description":"Get the GenAI config for a given project.","operationId":"get_project_integration_config_genai","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"decode_secrets","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Decode Secrets"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAICPD"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIOpenai"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"discriminator":{"propertyName":"kind","mapping":{"bam":"#/components/schemas/GenAIBAM","watsonx":"#/components/schemas/GenAIWatsonx","cpd":"#/components/schemas/GenAICPD","hf_api":"#/components/schemas/GenAIHFInferenceApi","openai":"#/components/schemas/GenAIOpenai","aws_bedrock":"#/components/schemas/GenAIAWSBedrock"}},"title":"Response Get Project Integration Config Genai"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Project"],"summary":"Update Project Integration Config Genai","description":"Update the GenAI config for a given project.","operationId":"update_project_integration_config_genai","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/GenAIBAM"},{"$ref":"#/components/schemas/GenAIWatsonx"},{"$ref":"#/components/schemas/GenAICPD"},{"$ref":"#/components/schemas/GenAIHFInferenceApi"},{"$ref":"#/components/schemas/GenAIOpenai"},{"$ref":"#/components/schemas/GenAIAWSBedrock"}],"discriminator":{"propertyName":"kind","mapping":{"bam":"#/components/schemas/GenAIBAM","watsonx":"#/components/schemas/GenAIWatsonx","cpd":"#/components/schemas/GenAICPD","hf_api":"#/components/schemas/GenAIHFInferenceApi","openai":"#/components/schemas/GenAIOpenai","aws_bedrock":"#/components/schemas/GenAIAWSBedrock"}},"title":"Config"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Project"],"summary":"Delete Project Integration Config Genai","description":"Delete the GenAI config for a given project integration.","operationId":"delete_project_integration_config_genai","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/packages":{"post":{"tags":["Project"],"summary":"Provision Project Packages","description":"Install packages on a project.","operationId":"provision_project_packages","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPackageInstalationManifest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/convert":{"post":{"tags":["Project"],"summary":"Convert Document","description":"Convert a document directly with Docling.","operationId":"convert_document","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConvertDocumentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/convert_tasks/{task_id}":{"get":{"tags":["Project"],"summary":"Get Convert Task","description":"Check status of a Docling conversion task; return presign urls for MD and JSON file if finished conversion successfully.","operationId":"get_convert_task","security":[{"Bearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Task Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"wait","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":30,"exclusiveMinimum":0},{"type":"null"}],"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","title":"Wait"},"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/semantic/ingest":{"post":{"tags":["Semantic"],"summary":"Ingest","description":"Ingest documents and collections for RAG","operationId":"ingest","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SemanticIngestRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CpsTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/info":{"get":{"tags":["System"],"summary":"Get System Information","description":"Get system info.","operationId":"get_system_information","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemInfo"}}}}}}},"/system/modules/configuration":{"get":{"tags":["System"],"summary":"Get System Modules Configuration","description":"Get modules configuration.","operationId":"get_system_modules_configuration","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulesConfig"}}}}}}},"/system/modules/tasks":{"get":{"tags":["System"],"summary":"Get System Modules Tasks","description":"Get modules configuration.","operationId":"get_system_modules_tasks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Get System Modules Tasks"}}}}}}},"/system/kgs":{"get":{"tags":["System"],"summary":"List System Knowledge Graphs","description":"List all Knowledge Graphs in the system.","operationId":"list_system_knowledge_graphs","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Proj Key"}},{"name":"term","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Term"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{},"title":"Response List System Knowledge Graphs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/get_all_kgs":{"get":{"tags":["System"],"summary":"System Get All Kgs Admin","description":"Get all kgs (only bag_key) for admin use.","operationId":"system_get_all_kgs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response System Get All Kgs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/packages":{"get":{"tags":["System"],"summary":"List Packages","description":"Get packages available in this CPS installation for installing in a project.","operationId":"list_packages","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSPackage"},"type":"array","title":"Response List Packages"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_all_dcs":{"get":{"tags":["System"],"summary":"System Get All Dcs Admin","description":"Get all data catalogs (only dc_key) for admin use.","operationId":"system_get_all_dcs_admin","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array","title":"Response System Get All Dcs Admin"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/list_all_flavours":{"get":{"tags":["System Flavours"],"summary":"List All Flavours","description":"Get all KG flavours storage on db.","operationId":"list_all_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Response List All Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavour/{flavour_name}":{"get":{"tags":["System Flavours"],"summary":"Get Flavour","description":"Get flavour from db.","operationId":"get_flavour","security":[{"Bearer":[]}],"parameters":[{"name":"flavour_name","in":"path","required":true,"schema":{"type":"string","title":"Flavour Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/save_flavour":{"put":{"tags":["System Flavours"],"summary":"Save Flavour","description":"Save flavour on db.","operationId":"save_flavour","security":[{"Bearer":[]}],"parameters":[{"name":"new_flavour","in":"query","required":true,"schema":{"type":"boolean","title":"New Flavour"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BagFlavourFullData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/delete_flavour/{flavour_name}":{"delete":{"tags":["System Flavours"],"summary":"Delete Flavour","description":"Delete flavour from db.","operationId":"delete_flavour","security":[{"Bearer":[]}],"parameters":[{"name":"flavour_name","in":"path","required":true,"schema":{"type":"string","title":"Flavour Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/list_projects_flavours":{"get":{"tags":["System Flavours"],"summary":"List Projects Flavours","description":"Get all projects and their flavours.","operationId":"list_projects_flavours","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectsFlavours"},"type":"array","title":"Response List Projects Flavours"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours":{"put":{"tags":["System Flavours"],"summary":"Save Project Flavours","description":"Save project flavours assignment on db.","operationId":"save_project_flavours","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectsFlavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours/{proj_key}":{"get":{"tags":["System Flavours"],"summary":"List Flavours By Project","description":"Get project assignment flavours.","operationId":"list_flavours_by_project","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProjectFlavours"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/kg_storage_summary/{kg_key}":{"get":{"tags":["System Summary"],"summary":"System Get Kg Storage Summary Async","description":"Get knowledge graph storage summary.","operationId":"system_get_kg_storage_summary_async","security":[{"Bearer":[]}],"parameters":[{"name":"kg_key","in":"path","required":true,"schema":{"type":"string","title":"Kg Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/dc_storage_summary/{dc_key}":{"get":{"tags":["System Summary"],"summary":"System Get Dc Storage Summary Async","description":"Get data catalog storage summary.","operationId":"system_get_dc_storage_summary_async","security":[{"Bearer":[]}],"parameters":[{"name":"dc_key","in":"path","required":true,"schema":{"type":"string","title":"Dc Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorageSummaryTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/summary":{"get":{"tags":["System Summary"],"summary":"System Get Cps Summary","description":"Get cps summary data.","operationId":"system_get_cps_summary","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CPSSummary"},"type":"array","title":"Response System Get Cps Summary"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_flavours_default_quota":{"get":{"tags":["System Quotas"],"summary":"Get Flavours Default Quotas","description":"Get flavours default values.","operationId":"get_flavours_default_quotas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Get Flavours Default Quotas"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_flavours_default_quota":{"put":{"tags":["System Quotas"],"summary":"Save Flavours Default Quotas","description":"Save flavours default quota.","operationId":"save_flavours_default_quotas","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Flavours"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FlavoursDefaultQuota"},"type":"array","title":"Response Save Flavours Default Quotas"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_projects_flavours_quota":{"get":{"tags":["System Quotas"],"summary":"Get Projects Flavours Quota","description":"Get projects flavours quotas.","operationId":"get_projects_flavours_quota","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProjectFlavoursQuota"},"type":"array","title":"Response Get Projects Flavours Quota"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/save_project_flavours_quota":{"put":{"tags":["System Quotas"],"summary":"Save Project Flavours Quota","description":"Save project flavours quota.","operationId":"save_project_flavours_quota","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavoursQuota"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"Bearer":[]}]}},"/system/admin/get_project_flavours_quota/{proj_key}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavours Quota","description":"Get project flavours quota.","operationId":"get_project_flavours_quota","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/FlavoursQuota"},"title":"Response Get Project Flavours Quota"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}":{"get":{"tags":["System Quotas"],"summary":"Get Project Flavour Total Kgs","description":"Gets kg total number by proj_key and flavour_key.","operationId":"get_project_flavour_total_kgs","security":[{"Bearer":[]}],"parameters":[{"name":"flavour_name","in":"path","required":true,"schema":{"type":"string","title":"Flavour Name"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectFlavourTotalKgs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/celery_tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Celery Task","description":"Get a celery task for a project.","operationId":"get_project_celery_task","security":[{"Bearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"wait","in":"query","required":false,"schema":{"anyOf":[{"type":"number","maximum":30.0,"exclusiveMinimum":0.0},{"type":"null"}],"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls.","title":"Wait"},"description":"Optionally block this method call for a few seconds to wait for the result instead of polling through multiple calls."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/tasks":{"get":{"tags":["Tasks"],"summary":"List Project Tasks","description":"List tasks for a project.","operationId":"list_project_tasks","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"task_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task Type"}},{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}},{"name":"sort_by","in":"query","required":false,"schema":{"type":"string","default":"_id","title":"Sort By"}},{"name":"sort_order","in":"query","required":false,"schema":{"enum":["asc","desc"],"type":"string","default":"desc","title":"Sort Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TaskContext"},"title":"Response List Project Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/tasks/{task_id}":{"get":{"tags":["Tasks"],"summary":"Get Project Task","description":"Get a task for a project.","operationId":"get_project_task","security":[{"Bearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskContext"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/tasks/{task_id}/actions/abort":{"post":{"tags":["Tasks"],"summary":"Abort Project Task","description":"Abort a task.","operationId":"abort_project_task","security":[{"Bearer":[]}],"parameters":[{"name":"task_id","in":"path","required":true,"schema":{"type":"string","title":"Task Id"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/scratch/files":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files","description":"Get temporary files uploaded to a project.","operationId":"list_project_scratch_files","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"scratch_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scratch Ids"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"title":"Response List Project Scratch Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/scratch/files_paginated":{"get":{"tags":["Upload"],"summary":"List Project Scratch Files Paginated","description":"Get paginated list of temporary files uploaded to a project.","operationId":"list_project_scratch_files_paginated","security":[{"Bearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page"}},{"name":"items_per_page","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Items Per Page"}},{"name":"search_string","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search String"}},{"name":"begin_date","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Begin Date"}},{"name":"end_date","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"End Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectScratchFilesPaginated"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/project/{proj_key}/scratch/files/upload/{filename}":{"post":{"tags":["Upload"],"summary":"Create Project Scratch File","description":"Create file pointers for temporary storage.","operationId":"create_project_scratch_file","security":[{"Bearer":[]}],"parameters":[{"name":"filename","in":"path","required":true,"schema":{"type":"string","title":"Filename"}},{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemporaryUploadFileResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Acquisition":{"properties":{"type":{"type":"string","enum":["API","FTP","Download","Link","Web scraping/Crawling","Other"],"title":"Type","description":"The method to obtain the data.","x-es-ignore_above":8191,"x-es-type":"keyword"},"date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Date","description":"A string representation of the acquisition datetime in ISO 8601 format."},"link":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Link","description":"Link to the data source of this document.","x-es-ignore_above":8191,"x-es-type":"keyword"},"size":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Size","description":"Size in bytes of the raw document from the data source.","x-es-type":"long"}},"additionalProperties":false,"type":"object","required":["type"],"title":"Acquisition","description":"Information on how the data was obtained."},"Affiliation":{"properties":{"name":{"type":"string","title":"Name","x-es-fields":{"keyword":{"ignore_above":8191,"type":"keyword"},"lower":{"ignore_above":8191,"normalizer":"lowercase_asciifolding","type":"keyword"}}},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","x-es-ignore_above":8191,"x-es-type":"keyword"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","x-es-ignore_above":8191,"x-es-type":"keyword"}},"additionalProperties":false,"type":"object","required":["name"],"title":"Affiliation","description":"Affiliation."},"AssembleMode":{"properties":{"page_elements":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Page Elements"},"tables":{"items":{"type":"string","enum":["H","M","None"]},"type":"array","title":"Tables"}},"type":"object","required":["page_elements","tables"],"title":"AssembleMode"},"AssembleSettings":{"properties":{"mode":{"$ref":"#/components/schemas/AssembleMode"},"include_incomplete_documents":{"type":"boolean","title":"Include Incomplete Documents"}},"type":"object","required":["mode","include_incomplete_documents"],"title":"AssembleSettings"},"AttachmentUploadData":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"upload_data":{"type":"string","title":"Upload Data"}},"type":"object","required":["attachment_path","upload_data"],"title":"AttachmentUploadData"},"AttachmentUploadRequestBody":{"properties":{"attachment_path":{"type":"string","title":"Attachment Path"},"attachment_key":{"type":"string","title":"Attachment Key","default":"usr_attachments"}},"type":"object","required":["attachment_path"],"title":"AttachmentUploadRequestBody"},"Author":{"properties":{"name":{"type":"string","title":"Name","x-es-fields":{"keyword":{"ignore_above":8191,"type":"keyword"},"lower":{"ignore_above":8191,"normalizer":"lowercase_asciifolding","type":"keyword"}},"x-es-type":"text"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","x-es-ignore_above":8191,"x-es-type":"keyword"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source","x-es-ignore_above":8191,"x-es-type":"keyword"},"affiliations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Affiliation"},"type":"array"},{"type":"null"}],"title":"Affiliations"}},"additionalProperties":false,"type":"object","required":["name"],"title":"Author","description":"Author."},"BagFlavourFullData":{"properties":{"backend":{"type":"string","title":"Backend"},"config":{"type":"object","title":"Config"},"default_quota":{"type":"integer","title":"Default Quota","default":0},"description":{"type":"string","title":"Description"},"display_name":{"type":"string","title":"Display Name"},"is_from_deployment":{"type":"boolean","title":"Is From Deployment","default":true},"name":{"type":"string","title":"Name"},"order":{"type":"integer","title":"Order","default":0},"project_specific":{"type":"boolean","title":"Project Specific"}},"type":"object","required":["backend","config","description","display_name","name","project_specific"],"title":"BagFlavourFullData"},"BaseModel":{"properties":{},"type":"object","title":"BaseModel"},"CCSProject":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"collection_name":{"type":"string","title":"Collection Name"}},"type":"object","required":["name","proj_key","collection_name"],"title":"CCSProject"},"CPSPackage":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"package_id":{"type":"string","title":"Package Id"},"type":{"type":"string","enum":["model","dictionary","knowledge_graph","data_catalog","data_flow","bundle"],"title":"Type"}},"type":"object","required":["name","description","package_id","type"],"title":"CPSPackage"},"CPSSummary":{"properties":{"availCpuSlots":{"type":"integer","title":"Availcpuslots"},"availMemSlots":{"type":"integer","title":"Availmemslots"},"availSlots":{"type":"integer","title":"Availslots"},"name":{"type":"string","title":"Name"},"numNodes":{"type":"integer","title":"Numnodes"},"numberKgs":{"type":"integer","title":"Numberkgs"},"runningKgs":{"type":"integer","title":"Runningkgs"},"workersPool":{"type":"string","title":"Workerspool"}},"type":"object","required":["availCpuSlots","availMemSlots","availSlots","name","numNodes","numberKgs","runningKgs","workersPool"],"title":"CPSSummary"},"CollectionDocumentInfo_str_":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the collection.","x-es-ignore_above":8191,"x-es-type":"keyword"},"type":{"type":"string","const":"Document","title":"Type","description":"The collection type.","x-es-ignore_above":8191,"x-es-type":"keyword"},"version":{"anyOf":[{"type":"string","pattern":"^(?P
0|[1-9]\\d*)\\.(?P0|[1-9]\\d*)\\.(?P0|[1-9]\\d*)(?:-(?P(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+(?P[0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"},{"type":"null"}],"title":"Version","description":"The version of this collection model.","x-es-ignore_above":8191,"x-es-type":"keyword"},"alias":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Alias","description":"A list of tags (aliases) for the collection.","x-es-ignore_above":8191,"x-es-type":"keyword"}},"additionalProperties":false,"type":"object","required":["type"],"title":"CollectionDocumentInfo[str]"},"CollectionMetadataSettings":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"license":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"License"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"}},"type":"object","title":"CollectionMetadataSettings"},"ConvertDocumentRequest":{"properties":{"http_source":{"anyOf":[{"$ref":"#/components/schemas/api_server__fastapi_server__public__models__project_models__HttpSource"},{"type":"null"}]},"file_source":{"anyOf":[{"$ref":"#/components/schemas/FileSource"},{"type":"null"}]},"settings":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Input"},{"type":"null"}]},"image_urls":{"anyOf":[{"$ref":"#/components/schemas/ImageUrlsInfo"},{"type":"null"}]},"truncate_pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Truncate Pages"}},"type":"object","title":"ConvertDocumentRequest"},"ConvertDocumentsRequestBody":{"properties":{"conversion_settings":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Input"},{"$ref":"#/components/schemas/PartialDirectConversionParameters"},{"type":"null"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"anyOf":[{"$ref":"#/components/schemas/TargetConversionParameters"},{"type":"null"}],"description":"Specify the target settings to use.","deprecated":true},"document_hashes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Hashes","description":"List of document hashes to be used as filter."},"without_operations":{"anyOf":[{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array"},{"type":"null"}],"title":"Without Operations","description":"List of Operation Status documents don't have to be used as filter."},"upload_to_elastic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Upload To Elastic"}},"type":"object","title":"ConvertDocumentsRequestBody"},"ConvertDocumentsSources":{"properties":{"file_url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"http_source":{"anyOf":[{"items":{"$ref":"#/components/schemas/api_server__fastapi_server__public__models__data_indices_upload_models__HttpSource"},"type":"array"},{"type":"null"}],"title":"Http Source","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"anyOf":[{"$ref":"#/components/schemas/S3DocumentSource"},{"type":"null"}],"description":"Coordinates to object store to get files to convert. Can specify which files with object keys."}},"type":"object","title":"ConvertDocumentsSources"},"ConvertUploadDocumentsRequestBody":{"properties":{"file_url":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"File Url","description":"List of File's URL to be converted and uploaded to the data index."},"http_source":{"anyOf":[{"items":{"$ref":"#/components/schemas/api_server__fastapi_server__public__models__data_indices_upload_models__HttpSource"},"type":"array"},{"type":"null"}],"title":"Http Source","description":"List of Internal File's URLs to be converted and uploaded to the data index."},"s3_source":{"anyOf":[{"$ref":"#/components/schemas/S3DocumentSource"},{"type":"null"}],"description":"Coordinates to object store to get files to convert. Can specify which files with object keys."},"upload_to_elastic":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Upload To Elastic"},"meta":{"anyOf":[{"$ref":"#/components/schemas/DocumentMeta"},{"type":"null"}]},"conversion_settings":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Input"},{"$ref":"#/components/schemas/PartialDirectConversionParameters"},{"type":"null"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"anyOf":[{"$ref":"#/components/schemas/TargetConversionParameters"},{"type":"null"}],"description":"Specify the target settings to use.","deprecated":true}},"type":"object","title":"ConvertUploadDocumentsRequestBody"},"CpsTask":{"properties":{"task_id":{"type":"string","title":"Task Id"},"task_type":{"type":"string","title":"Task Type"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_type","task_status"],"title":"CpsTask"},"DataFlow":{"properties":{"df_tpl_key":{"type":"string","title":"Df Tpl Key"},"name":{"type":"string","title":"Name"}},"type":"object","required":["df_tpl_key","name"],"title":"DataFlow"},"DataIndexUploadFileSource":{"properties":{"conversion_settings":{"anyOf":[{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Input"},{"$ref":"#/components/schemas/PartialDirectConversionParameters"},{"type":"null"}],"title":"Conversion Settings","description":"Specify the conversion settings to use."},"target_settings":{"anyOf":[{"$ref":"#/components/schemas/TargetConversionParameters"},{"type":"null"}],"description":"Specify the target settings to use.","deprecated":true},"urls":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}],"title":"Urls","description":"List of URLs to be printed to PDF, converted and uploaded to the data index."},"headers":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Headers"}},"type":"object","required":["urls"],"title":"DataIndexUploadFileSource"},"DefaultValues":{"properties":{"ccs_project":{"$ref":"#/components/schemas/CCSProject"},"dataflow":{"anyOf":[{"$ref":"#/components/schemas/DataFlow"},{"type":"null"}]}},"type":"object","required":["ccs_project"],"title":"DefaultValues"},"Deployment":{"properties":{"name":{"type":"string","title":"Name"},"disclaimer":{"type":"string","title":"Disclaimer"},"should_show_warning":{"type":"boolean","title":"Should Show Warning"},"disable_kg_actions":{"type":"boolean","title":"Disable Kg Actions"},"linked_ccs_api":{"type":"object","title":"Linked Ccs Api"}},"type":"object","required":["name","disclaimer","should_show_warning","disable_kg_actions","linked_ccs_api"],"title":"Deployment"},"DescriptionLicense":{"properties":{"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","x-es-ignore_above":8191,"x-es-type":"keyword"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"}},"additionalProperties":false,"type":"object","title":"DescriptionLicense","description":"Licence in document description."},"DirectModelConfig":{"properties":{"type":{"type":"string","title":"Type"},"config":{"type":"object","title":"Config"}},"type":"object","required":["type","config"],"title":"DirectModelConfig","description":"Direct configuration of a model."},"DocumentArtifacts":{"properties":{"document_meta_json":{"anyOf":[{"$ref":"#/components/schemas/DocumentArtifactsItem"},{"type":"null"}]},"document_pdf":{"anyOf":[{"$ref":"#/components/schemas/DocumentArtifactsItem"},{"type":"null"}]},"document_json":{"anyOf":[{"$ref":"#/components/schemas/DocumentArtifactsItem"},{"type":"null"}]},"document_legacy_json":{"anyOf":[{"$ref":"#/components/schemas/DocumentArtifactsItem"},{"type":"null"}]},"document_md":{"anyOf":[{"$ref":"#/components/schemas/DocumentArtifactsItem"},{"type":"null"}]},"page_pdfs":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Pdfs","default":[]},"page_images":{"items":{"$ref":"#/components/schemas/DocumentArtifactsPageItem"},"type":"array","title":"Page Images","default":[]}},"type":"object","title":"DocumentArtifacts"},"DocumentArtifactsItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"}},"type":"object","required":["mime","path","url"],"title":"DocumentArtifactsItem"},"DocumentArtifactsPageItem":{"properties":{"mime":{"type":"string","title":"Mime"},"path":{"type":"string","title":"Path"},"url":{"type":"string","title":"Url"},"page":{"type":"integer","title":"Page","description":"Page number starting at 1."}},"type":"object","required":["mime","path","url","page"],"title":"DocumentArtifactsPageItem"},"DocumentDescription":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"abstract":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Abstract"},"authors":{"anyOf":[{"items":{"$ref":"#/components/schemas/Author"},"type":"array"},{"type":"null"}],"title":"Authors"},"affiliations":{"anyOf":[{"items":{"$ref":"#/components/schemas/Affiliation"},"type":"array"},{"type":"null"}],"title":"Affiliations"},"subjects":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Subjects","x-es-fields":{"keyword":{"ignore_above":8191,"type":"keyword"}}},"keywords":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Keywords","x-es-ignore_above":8191,"x-es-type":"keyword"},"publication_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Publication Date"},"languages":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Languages","x-es-ignore_above":8191,"x-es-type":"keyword"},"license":{"anyOf":[{"$ref":"#/components/schemas/DescriptionLicense"},{"type":"null"}]},"publishers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Publishers","x-es-ignore_above":8191,"x-es-type":"keyword"},"url_refs":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Url Refs","x-es-ignore_above":8191,"x-es-type":"keyword"},"references":{"anyOf":[{"items":{"$ref":"#/components/schemas/docling_core__types__base__Identifier"},"type":"array"},{"type":"null"}],"title":"References"},"publication":{"anyOf":[{"items":{"$ref":"#/components/schemas/Publication"},"type":"array"},{"type":"null"}],"title":"Publication","description":"List of publication journals or venues."},"reference_count":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Reference Count","description":"Total number of documents referenced by this document.","x-es-type":"integer"},"citation_count":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Citation Count","description":"Total number of citations that this document has received (number of documents in whose bibliography this document appears).","x-es-type":"integer"},"citation_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Citation Count Date","description":"Last update date of the citation count."},"advanced":{"anyOf":[{"$ref":"#/components/schemas/BaseModel"},{"type":"null"}]},"analytics":{"anyOf":[{"$ref":"#/components/schemas/BaseModel"},{"type":"null"}]},"acquisition":{"anyOf":[{"$ref":"#/components/schemas/Acquisition"},{"type":"null"}],"description":"Information on how the document was obtained, for data governance purposes."}},"type":"object","title":"DocumentDescription"},"DocumentMeta":{"properties":{"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"},"description":{"anyOf":[{"$ref":"#/components/schemas/DocumentDescription"},{"type":"null"}]},"identifiers":{"anyOf":[{"items":{"$ref":"#/components/schemas/api_server__fastapi_server__public__models__data_indices_upload_models__Identifier"},"type":"array"},{"type":"null"}],"title":"Identifiers"}},"type":"object","title":"DocumentMeta"},"DocumentStatistics":{"properties":{"total_documents":{"type":"integer","title":"Total Documents"},"documents_pending":{"type":"integer","title":"Documents Pending"},"documents_failed":{"type":"integer","title":"Documents Failed"},"documents_converted":{"type":"integer","title":"Documents Converted"}},"type":"object","required":["total_documents","documents_pending","documents_failed","documents_converted"],"title":"DocumentStatistics"},"ElasticIndexPropertyObject":{"properties":{"type":{"type":"string","title":"Type"},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled"},"ignore_above":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Ignore Above"}},"type":"object","required":["type"],"title":"ElasticIndexPropertyObject"},"ElasticIndexPropertyPrimitive":{"properties":{"properties":{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object","title":"Properties"}},"type":"object","required":["properties"],"title":"ElasticIndexPropertyPrimitive"},"ElasticIndexSearchQueryOptions":{"properties":{"_source":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Source"},"from_":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"From"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size"},"query":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Query"},"aggs":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Aggs"},"sort":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Sort"}},"type":"object","title":"ElasticIndexSearchQueryOptions"},"ElasticIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","elastic_id"],"title":"ElasticIndexSource"},"ElasticInstanceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"elastic_id":{"type":"string","title":"Elastic Id"}},"type":"object","required":["index_key","query_options","elastic_id"],"title":"ElasticInstanceDataIndex"},"ElasticMetadata":{"properties":{"aliases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Aliases"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"storage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Storage"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"},"domain":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Domain"},"classification":{"items":{"type":"string"},"type":"array","title":"Classification"}},"type":"object","required":["classification"],"title":"ElasticMetadata"},"FileSource":{"properties":{"base64_string":{"type":"string","title":"Base64 String"},"filename":{"type":"string","title":"Filename"}},"type":"object","required":["base64_string","filename"],"title":"FileSource"},"Flavour":{"properties":{"name":{"type":"string","title":"Name"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"}},"type":"object","required":["name"],"title":"Flavour"},"FlavoursDefaultQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"default_quota":{"type":"integer","title":"Default Quota"}},"type":"object","required":["display_name","name","default_quota"],"title":"FlavoursDefaultQuota"},"FlavoursQuota":{"properties":{"display_name":{"type":"string","title":"Display Name"},"name":{"type":"string","title":"Name"},"quota":{"type":"integer","title":"Quota"}},"type":"object","required":["display_name","name","quota"],"title":"FlavoursQuota"},"GenAIAWSBedrock":{"properties":{"kind":{"type":"string","const":"aws_bedrock","title":"Kind","default":"aws_bedrock"},"config":{"$ref":"#/components/schemas/GenAIAWSBedrockConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAIAWSBedrock","description":"GenAI integration for AWS Bedrock settings"},"GenAIAWSBedrockConfig":{"properties":{"GENAI_AWS_ACCESS_KEY":{"type":"string","format":"password","title":"Genai Aws Access Key","writeOnly":true},"GENAI_AWS_SECRET_KEY":{"type":"string","format":"password","title":"Genai Aws Secret Key","writeOnly":true},"GENAI_AWS_REGION_NAME":{"type":"string","title":"Genai Aws Region Name"}},"type":"object","required":["GENAI_AWS_ACCESS_KEY","GENAI_AWS_SECRET_KEY","GENAI_AWS_REGION_NAME"],"title":"GenAIAWSBedrockConfig","description":"Config for AWS Bedrock"},"GenAIBAM":{"properties":{"kind":{"type":"string","const":"bam","title":"Kind","default":"bam"},"config":{"$ref":"#/components/schemas/GenAIBAMConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAIBAM","description":"GenAI integration for BAM settings"},"GenAIBAMConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_KEY"],"title":"GenAIBAMConfig","description":"Config for BAM"},"GenAICPD":{"properties":{"kind":{"type":"string","const":"cpd","title":"Kind","default":"cpd"},"config":{"$ref":"#/components/schemas/GenAICPDConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAICPD","description":"GenAI integration for watsonx settings"},"GenAICPDConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_PROJECT_ID":{"type":"string","title":"Genai Project Id"},"GENAI_CPD_URL":{"type":"string","title":"Genai Cpd Url"},"GENAI_CPD_VERIFY_TLS":{"type":"boolean","title":"Genai Cpd Verify Tls","default":true},"GENAI_CPD_USERNAME":{"type":"string","title":"Genai Cpd Username"},"GENAI_CPD_PASSWORD":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Genai Cpd Password"},"GENAI_CPD_API_KEY":{"anyOf":[{"type":"string","format":"password","writeOnly":true},{"type":"null"}],"title":"Genai Cpd Api Key"}},"type":"object","required":["GENAI_API","GENAI_PROJECT_ID","GENAI_CPD_URL","GENAI_CPD_USERNAME"],"title":"GenAICPDConfig","description":"Config for CPD watsonx"},"GenAIHFInferenceApi":{"properties":{"kind":{"type":"string","const":"hf_api","title":"Kind","default":"hf_api"},"config":{"$ref":"#/components/schemas/GenAIHFInferenceApiConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAIHFInferenceApi","description":"GenAI integration for Inference API settings"},"GenAIHFInferenceApiConfig":{"properties":{"GENAI_HF_API_KEY":{"type":"string","format":"password","title":"Genai Hf Api Key","writeOnly":true}},"type":"object","required":["GENAI_HF_API_KEY"],"title":"GenAIHFInferenceApiConfig","description":"Config for HF Inference API"},"GenAIOpenai":{"properties":{"kind":{"type":"string","const":"openai","title":"Kind","default":"openai"},"config":{"$ref":"#/components/schemas/GenAIOpenaiConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAIOpenai","description":"GenAI integration for OpenAI API settings"},"GenAIOpenaiConfig":{"properties":{"GENAI_OPENAI_API_KEY":{"type":"string","format":"password","title":"Genai Openai Api Key","writeOnly":true},"GENAI_OPENAI_BASE_URL":{"type":"string","title":"Genai Openai Base Url"},"GENAI_OPENAI_VERIFY_TLS":{"type":"boolean","title":"Genai Openai Verify Tls","default":true}},"type":"object","required":["GENAI_OPENAI_API_KEY","GENAI_OPENAI_BASE_URL"],"title":"GenAIOpenaiConfig","description":"Config for OpenAI API"},"GenAIParams":{"properties":{"model_id":{"type":"string","title":"Model Id"},"prompt_template":{"type":"string","title":"Prompt Template"},"params":{"type":"object","title":"Params"},"timeout":{"type":"number","title":"Timeout"}},"type":"object","required":["model_id","prompt_template","params","timeout"],"title":"GenAIParams"},"GenAIPartialParams":{"properties":{"model_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Id"},"prompt_template":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt Template"},"params":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Params"},"timeout":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Timeout"}},"type":"object","title":"GenAIPartialParams"},"GenAIWatsonx":{"properties":{"kind":{"type":"string","const":"watsonx","title":"Kind","default":"watsonx"},"config":{"$ref":"#/components/schemas/GenAIWatsonxConfig"},"proj_params":{"anyOf":[{"$ref":"#/components/schemas/GenAIPartialParams"},{"type":"null"}]}},"type":"object","required":["config"],"title":"GenAIWatsonx","description":"GenAI integration for watsonx settings"},"GenAIWatsonxConfig":{"properties":{"GENAI_API":{"type":"string","title":"Genai Api"},"GENAI_PROJECT_ID":{"type":"string","title":"Genai Project Id"},"GENAI_KEY":{"type":"string","format":"password","title":"Genai Key","writeOnly":true}},"type":"object","required":["GENAI_API","GENAI_PROJECT_ID","GENAI_KEY"],"title":"GenAIWatsonxConfig","description":"Config for watsonx"},"GroupedProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"},"upload_date":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"title":"Upload Date"}},"type":"object","required":["documents","upload_date"],"title":"GroupedProjectDocuments"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImageUrlsInfo":{"type":"string","enum":["STORED"],"title":"ImageUrlsInfo"},"JsonUploadRequestBody":{"properties":{"file_url":{"type":"string","title":"File Url"}},"type":"object","required":["file_url"],"title":"JsonUploadRequestBody"},"ListProjectFlavours":{"properties":{"flavours":{"items":{"$ref":"#/components/schemas/BagFlavourFullData"},"type":"array","title":"Flavours"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["flavours","proj_key"],"title":"ListProjectFlavours"},"Log":{"properties":{"task":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Task","description":"An identifier of this task. It may be used to identify this task from other tasks of the same agent and type.","x-es-ignore_above":8191,"x-es-type":"keyword"},"agent":{"type":"string","title":"Agent","description":"The Docling agent that performed the task, e.g., CCS or CXS.","x-es-ignore_above":8191,"x-es-type":"keyword"},"type":{"type":"string","title":"Type","description":"A task category.","x-es-ignore_above":8191,"x-es-type":"keyword"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment","description":"A description of the task or any comments in natural language."},"date":{"type":"string","format":"date-time","title":"Date","description":"A string representation of the task execution datetime in ISO 8601 format."}},"additionalProperties":false,"type":"object","required":["agent","type","date"],"title":"Log","description":"Log entry to describe an ETL task on a document."},"ModelPipelineSettings":{"properties":{"clusters":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Clusters"},"page":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Page"},"tables":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Tables"},"normalization":{"items":{"anyOf":[{"$ref":"#/components/schemas/ReferenceToModel"},{"$ref":"#/components/schemas/DirectModelConfig"}]},"type":"array","title":"Normalization"}},"type":"object","required":["clusters","page","tables","normalization"],"title":"ModelPipelineSettings"},"ModulesConfig":{"properties":{"df_template_variables":{"items":{},"type":"array","title":"Df Template Variables"},"linked_ccs_instances":{"items":{},"type":"array","title":"Linked Ccs Instances"},"linked_elastic_instances":{"items":{},"type":"array","title":"Linked Elastic Instances"}},"type":"object","required":["df_template_variables","linked_ccs_instances","linked_elastic_instances"],"title":"ModulesConfig"},"OCROptions":{"properties":{"do_ocr":{"type":"boolean","title":"Do Ocr","default":true},"kind":{"type":"string","enum":["easyocr","tesserocr"],"title":"Kind","default":"easyocr"}},"type":"object","title":"OCROptions"},"OcrSettings":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":false},"backend":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Backend"},"backend_settings":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Backend Settings"},"merge_mode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Merge Mode"}},"type":"object","title":"OcrSettings"},"Package":{"properties":{"overrides":{"type":"object","title":"Overrides"},"package_id":{"type":"string","title":"Package Id"}},"type":"object","required":["overrides","package_id"],"title":"Package"},"PartialDirectConversionParameters":{"properties":{"type":{"type":"string","const":"direct","title":"Type","default":"direct"},"ocr":{"anyOf":[{"$ref":"#/components/schemas/OcrSettings"},{"type":"null"}]},"assemble":{"anyOf":[{"$ref":"#/components/schemas/AssembleSettings"},{"type":"null"}]},"metadata":{"anyOf":[{"$ref":"#/components/schemas/CollectionMetadataSettings"},{"type":"null"}]},"page_labels":{"anyOf":[{"additionalProperties":{"type":"object"},"type":"object"},{"type":"null"}],"title":"Page Labels"},"model_pipeline":{"anyOf":[{"$ref":"#/components/schemas/ModelPipelineSettings"},{"type":"null"}]}},"type":"object","title":"PartialDirectConversionParameters","description":"Specify conversion settings (OCR, Assemble, ML Models) directly.\n\nFields left null are set to platform defaults."},"ProjectAgent":{"properties":{"agent_info":{"type":"object","title":"Agent Info"},"agent_name":{"type":"string","title":"Agent Name"},"version":{"type":"string","title":"Version"}},"type":"object","required":["agent_info","agent_name","version"],"title":"ProjectAgent"},"ProjectAgents":{"properties":{"agents":{"items":{"$ref":"#/components/schemas/ProjectAgent"},"type":"array","title":"Agents"}},"type":"object","required":["agents"],"title":"ProjectAgents"},"ProjectDataIndexConversionSettings-Input":{"properties":{"ocr":{"$ref":"#/components/schemas/OCROptions","default":{"do_ocr":true,"kind":"easyocr"}},"table_structure":{"$ref":"#/components/schemas/TableStructureOptions","default":{"do_table_structure":true,"table_structure_mode":"fast"}},"generate_page_images":{"type":"boolean","title":"Generate Page Images","default":true}},"type":"object","title":"ProjectDataIndexConversionSettings"},"ProjectDataIndexConversionSettings-Output":{"properties":{"ocr":{"$ref":"#/components/schemas/OCROptions","default":{"do_ocr":true,"kind":"easyocr"}},"table_structure":{"$ref":"#/components/schemas/TableStructureOptions","default":{"do_table_structure":true,"table_structure_mode":"fast"}},"generate_page_images":{"type":"boolean","title":"Generate Page Images","default":true}},"type":"object","title":"ProjectDataIndexConversionSettings"},"ProjectDataIndexNonView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"schema_key":{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"],"title":"Schema Key","default":"generic"}},"type":"object","required":["name"],"title":"ProjectDataIndexNonView"},"ProjectDataIndexSource":{"properties":{"index_key":{"type":"string","title":"Index Key"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","proj_key"],"title":"ProjectDataIndexSource"},"ProjectDataIndexView":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"}],"title":"View Of"}},"type":"object","required":["name","view_of"],"title":"ProjectDataIndexView"},"ProjectDataIndexWithStatus":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexSource"},{"$ref":"#/components/schemas/ProjectDataIndexSource"}],"title":"Source"},"name":{"type":"string","title":"Name"},"documents":{"type":"integer","title":"Documents"},"health":{"type":"string","title":"Health"},"status":{"type":"string","title":"Status"},"creation_date":{"type":"string","title":"Creation Date"},"metadata":{"anyOf":[{"$ref":"#/components/schemas/ElasticMetadata"},{"type":"null"}]},"description":{"type":"string","title":"Description"},"schema_key":{"anyOf":[{"type":"string","enum":["deepsearch-doc","deepsearch-db","generic"]},{"type":"null"}],"title":"Schema Key"},"type":{"type":"string","title":"Type"},"view_of":{"anyOf":[{"$ref":"#/components/schemas/ProjectSourceDataIndex"},{"$ref":"#/components/schemas/ElasticInstanceDataIndex"},{"type":"null"}],"title":"View Of"},"record_properties":{"anyOf":[{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/ElasticIndexPropertyPrimitive"},{"$ref":"#/components/schemas/ElasticIndexPropertyObject"}]},"type":"object"},{"type":"null"}],"title":"Record Properties"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"}},"type":"object","required":["source","name","documents","health","status","creation_date","description","type"],"title":"ProjectDataIndexWithStatus"},"ProjectDocument":{"properties":{"document_hash":{"type":"string","title":"Document Hash"},"filename":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filename"},"file_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Uri"},"ref_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref Uri"},"number_pages":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Number Pages"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},"type":"object","required":["document_hash"],"title":"ProjectDocument"},"ProjectDocumentURL":{"properties":{"download_url":{"type":"string","title":"Download Url"}},"type":"object","required":["download_url"],"title":"ProjectDocumentURL"},"ProjectDocuments":{"properties":{"documents":{"items":{"$ref":"#/components/schemas/ProjectDocument"},"type":"array","title":"Documents"}},"type":"object","required":["documents"],"title":"ProjectDocuments"},"ProjectFlavourTotalKgs":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"flavour_name":{"type":"string","title":"Flavour Name"},"total_kgs":{"type":"integer","title":"Total Kgs"}},"type":"object","required":["proj_key","flavour_name","total_kgs"],"title":"ProjectFlavourTotalKgs"},"ProjectFlavoursQuota":{"properties":{"name":{"type":"string","title":"Name"},"proj_key":{"type":"string","title":"Proj Key"},"quotas":{"items":{"$ref":"#/components/schemas/FlavoursQuota"},"type":"array","title":"Quotas"}},"type":"object","required":["name","proj_key","quotas"],"title":"ProjectFlavoursQuota"},"ProjectPackageInstalationManifest":{"properties":{"packages":{"items":{"$ref":"#/components/schemas/Package"},"type":"array","title":"Packages"}},"type":"object","required":["packages"],"title":"ProjectPackageInstalationManifest"},"ProjectScratchFiles":{"properties":{"id":{"type":"string","title":"Id"},"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"filename":{"type":"string","title":"Filename"},"timestamp":{"type":"string","title":"Timestamp"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","proj_key","user_key","filename","timestamp","url"],"title":"ProjectScratchFiles"},"ProjectScratchFilesPaginated":{"properties":{"files":{"items":{"$ref":"#/components/schemas/ProjectScratchFiles"},"type":"array","title":"Files"},"count":{"type":"integer","title":"Count"},"page":{"type":"integer","title":"Page"},"items_per_page":{"type":"integer","title":"Items Per Page"}},"type":"object","required":["files","count","page","items_per_page"],"title":"ProjectScratchFilesPaginated"},"ProjectSourceDataIndex":{"properties":{"index_key":{"type":"string","title":"Index Key"},"query_options":{"$ref":"#/components/schemas/ElasticIndexSearchQueryOptions"},"proj_key":{"type":"string","title":"Proj Key"}},"type":"object","required":["index_key","query_options","proj_key"],"title":"ProjectSourceDataIndex"},"ProjectsFlavours":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name"},"flavours":{"items":{"$ref":"#/components/schemas/Flavour"},"type":"array","title":"Flavours"}},"type":"object","required":["proj_key","name","flavours"],"title":"ProjectsFlavours"},"Publication":{"properties":{"identifiers":{"anyOf":[{"items":{"$ref":"#/components/schemas/docling_core__types__base__Identifier"},"type":"array"},{"type":"null"}],"title":"Identifiers","description":"Unique identifiers of a publication venue."},"name":{"type":"string","title":"Name","description":"Name of the publication.","x-es-ignore_above":8191,"x-es-type":"keyword"},"alternate_names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Alternate Names","description":"Other names or abbreviations of this publication.","x-es-type":"text"},"type":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Type","description":"Type of publication (journal article, conference, review,...).","x-es-ignore_above":8191,"x-es-type":"keyword"},"pages":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pages","description":"Page range in the publication.","x-es-type":"text"},"issue":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Issue","description":"Publication issue (issue number).","x-es-ignore_above":8191,"x-es-type":"keyword"},"volume":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Volume","description":"Publication volume.","x-es-ignore_above":8191,"x-es-type":"keyword"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"null"}],"title":"Url","description":"URL on the publication site.","x-es-ignore_above":8191,"x-es-type":"keyword"}},"additionalProperties":false,"type":"object","required":["name"],"title":"Publication","description":"Publication details of a journal or venue."},"ReferenceToModel":{"properties":{"model_config_key":{"type":"string","title":"Model Config Key"},"proj_key":{"type":"string","title":"Proj Key"},"name":{"type":"string","title":"Name","default":""},"description":{"type":"string","title":"Description","default":""}},"type":"object","required":["model_config_key","proj_key"],"title":"ReferenceToModel","description":"Reference to a model configuration."},"ResponseDocumentArtifacts":{"properties":{"artifacts":{"$ref":"#/components/schemas/DocumentArtifacts"}},"type":"object","required":["artifacts"],"title":"ResponseDocumentArtifacts"},"ResponseGroupedDocuments":{"properties":{"grouped_documents":{"items":{"$ref":"#/components/schemas/GroupedProjectDocuments"},"type":"array","title":"Grouped Documents"}},"type":"object","required":["grouped_documents"],"title":"ResponseGroupedDocuments"},"ResponseUploadJobs":{"properties":{"upload_jobs":{"items":{"$ref":"#/components/schemas/UploadJob"},"type":"array","title":"Upload Jobs"}},"type":"object","required":["upload_jobs"],"title":"ResponseUploadJobs"},"S3Coordinates":{"properties":{"host":{"type":"string","title":"Host"},"port":{"type":"integer","title":"Port"},"ssl":{"type":"boolean","title":"Ssl"},"verifySSL":{"type":"boolean","title":"Verifyssl"},"access-key":{"type":"string","title":"Access-Key"},"secret-key":{"type":"string","title":"Secret-Key"},"bucket":{"type":"string","title":"Bucket"},"key_prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key Prefix"},"location":{"type":"string","title":"Location"}},"type":"object","required":["host","port","ssl","verifySSL","access-key","secret-key","bucket","location"],"title":"S3Coordinates"},"S3DocumentSource":{"properties":{"coordinates":{"$ref":"#/components/schemas/S3Coordinates"},"object_keys":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Object Keys","description":"List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index."}},"type":"object","required":["coordinates"],"title":"S3DocumentSource","description":"Specifies documents to import from an S3 bucket"},"SemanticIngestReqParams":{"properties":{"skip_ingested_docs":{"type":"boolean","title":"Skip Ingested Docs"}},"type":"object","required":["skip_ingested_docs"],"title":"SemanticIngestReqParams"},"SemanticIngestRequest":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/SemanticIngestSourceUrl"},{"$ref":"#/components/schemas/SemanticIngestSourcePublicDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataDocument"},{"$ref":"#/components/schemas/SemanticIngestSourcePrivateDataCollection"}],"title":"Source"},"parameters":{"$ref":"#/components/schemas/SemanticIngestReqParams"}},"type":"object","required":["source","parameters"],"title":"SemanticIngestRequest"},"SemanticIngestSourcePrivateDataCollection":{"properties":{"type":{"type":"string","const":"private_data_collection","title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"}},"type":"object","required":["type","proj_key","index_key"],"title":"SemanticIngestSourcePrivateDataCollection"},"SemanticIngestSourcePrivateDataDocument":{"properties":{"type":{"type":"string","const":"private_data_document","title":"Type"},"proj_key":{"type":"string","title":"Proj Key"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","proj_key","index_key","document_hash"],"title":"SemanticIngestSourcePrivateDataDocument"},"SemanticIngestSourcePublicDataDocument":{"properties":{"type":{"type":"string","const":"public_data_document","title":"Type"},"elastic_id":{"type":"string","title":"Elastic Id"},"index_key":{"type":"string","title":"Index Key"},"document_hash":{"type":"string","title":"Document Hash"}},"type":"object","required":["type","elastic_id","index_key","document_hash"],"title":"SemanticIngestSourcePublicDataDocument"},"SemanticIngestSourceUrl":{"properties":{"type":{"type":"string","const":"url","title":"Type"},"url":{"type":"string","title":"Url"}},"type":"object","required":["type","url"],"title":"SemanticIngestSourceUrl"},"StatusFilter":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"],"title":"StatusFilter"},"StorageSummaryTask":{"properties":{"dc_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dc Key"},"kg_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kg Key"},"kind":{"type":"string","enum":["project_task","celery_task"],"title":"Kind"},"proj_key":{"type":"string","title":"Proj Key"},"task_id":{"type":"string","title":"Task Id"}},"type":"object","required":["kind","proj_key","task_id"],"title":"StorageSummaryTask"},"SystemInfo":{"properties":{"notifications":{"items":{},"type":"array","title":"Notifications"},"default_project":{"type":"object","title":"Default Project"},"deployment":{"$ref":"#/components/schemas/Deployment"},"toolkit":{"type":"object","title":"Toolkit"},"allow_non_admins_to_make_resources_public":{"type":"boolean","title":"Allow Non Admins To Make Resources Public"},"api":{"type":"object","title":"Api"},"genai_defaults":{"additionalProperties":{"$ref":"#/components/schemas/GenAIParams"},"type":"object","title":"Genai Defaults"},"conversion_settings_defaults":{"$ref":"#/components/schemas/ProjectDataIndexConversionSettings-Output","default":{"ocr":{"do_ocr":true,"kind":"easyocr"},"table_structure":{"do_table_structure":true,"table_structure_mode":"fast"},"generate_page_images":true}}},"type":"object","required":["notifications","default_project","deployment","toolkit","allow_non_admins_to_make_resources_public","api","genai_defaults"],"title":"SystemInfo"},"TableFormerMode":{"type":"string","enum":["fast","accurate"],"title":"TableFormerMode"},"TableStructureOptions":{"properties":{"do_table_structure":{"type":"boolean","title":"Do Table Structure","default":true},"table_structure_mode":{"$ref":"#/components/schemas/TableFormerMode","default":"fast"}},"type":"object","title":"TableStructureOptions"},"TargetConversionParameters":{"properties":{"add_raw_pages":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add Raw Pages"},"add_annotations":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add Annotations"}},"type":"object","title":"TargetConversionParameters","description":"Specify target settings (add_raw_pages, add_annotations).\n\nFields left null are set to platform defaults."},"TaskContext":{"properties":{"proj_key":{"type":"string","title":"Proj Key"},"user_key":{"type":"string","title":"User Key"},"task_type":{"type":"string","title":"Task Type"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"},"execution_mode":{"type":"string","title":"Execution Mode"},"progress":{"type":"number","title":"Progress"},"meta":{"type":"object","title":"Meta"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"completed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Completed At"},"start_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Start Count"},"error_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Reason"},"related_tasks":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Related Tasks"}},"type":"object","required":["proj_key","user_key","task_type","task_id","task_status","execution_mode","progress","meta","created_at"],"title":"TaskContext"},"TaskResult":{"properties":{"result":{"anyOf":[{},{"type":"null"}],"title":"Result"},"task_id":{"type":"string","title":"Task Id"},"task_status":{"type":"string","title":"Task Status"}},"type":"object","required":["task_id","task_status"],"title":"TaskResult"},"TemporaryUploadFileResult":{"properties":{"id":{"type":"string","title":"Id"},"upload":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata":{"$ref":"#/components/schemas/TemporaryUrl"},"upload_private":{"$ref":"#/components/schemas/TemporaryUrlFields"},"download_private":{"$ref":"#/components/schemas/TemporaryUrl"},"metadata_private":{"$ref":"#/components/schemas/TemporaryUrl"}},"type":"object","required":["id","upload","download","metadata","upload_private","download_private","metadata_private"],"title":"TemporaryUploadFileResult"},"TemporaryUrl":{"properties":{"url":{"type":"string","title":"Url"}},"type":"object","required":["url"],"title":"TemporaryUrl"},"TemporaryUrlFields":{"properties":{"url":{"type":"string","title":"Url"},"fields":{"type":"object","title":"Fields"}},"type":"object","required":["url","fields"],"title":"TemporaryUrlFields"},"TokenResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"TokenResponse"},"UploadElasticRequestBody":{"properties":{"document_hashes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Hashes","description":"List of document hashes to be used as filter."},"with_operations":{"anyOf":[{"items":{"type":"string","enum":["PENDING","FAILURE","SUCCESS"]},"type":"array"},{"type":"null"}],"title":"With Operations","description":"List of Operation Status documents don't have to be used as filter."}},"type":"object","title":"UploadElasticRequestBody"},"UploadJob":{"properties":{"date":{"type":"string","format":"date-time","title":"Date"},"num_docs":{"type":"integer","title":"Num Docs"}},"type":"object","required":["date","num_docs"],"title":"UploadJob"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"api_server__fastapi_server__public__models__data_indices_upload_models__HttpSource":{"properties":{"download_url":{"type":"string","title":"Download Url"},"head_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Head Url"},"headers":{"type":"object","title":"Headers","default":{}}},"type":"object","required":["download_url"],"title":"HttpSource"},"api_server__fastapi_server__public__models__data_indices_upload_models__Identifier":{"properties":{"type":{"type":"string","title":"Type"},"_name":{"type":"string","title":"Name"},"value":{"type":"string","title":"Value"}},"type":"object","required":["type","_name","value"],"title":"Identifier"},"api_server__fastapi_server__public__models__project_models__HttpSource":{"properties":{"url":{"type":"string","title":"Url"},"headers":{"type":"object","title":"Headers"}},"type":"object","required":["url","headers"],"title":"HttpSource"},"docling_core__types__base__Identifier":{"properties":{"type":{"type":"string","title":"Type","description":"A string representing a collection or database that contains this data object.","x-es-ignore_above":8191,"x-es-type":"keyword"},"value":{"type":"string","title":"Value","description":"The identifier value of the data object within a collection or database.","x-es-ignore_above":8191,"x-es-type":"keyword"},"_name":{"type":"string","pattern":"^.+#.+$","title":"_Name","description":"A unique identifier of the data object across Docling, consisting of the concatenation of type and value in lower case, separated by hash (#).","x-es-ignore_above":8191,"x-es-type":"keyword"}},"additionalProperties":false,"type":"object","required":["type","value","_name"],"title":"Identifier","description":"Unique identifier of a Docling data object."}},"securitySchemes":{"Bearer":{"type":"apiKey","description":"Provide a Bearer token in the `Authorization` header","in":"header","name":"Authorization"}}}}
\ No newline at end of file
diff --git a/tools/swagger-client-generator/swagger-cps.json b/tools/swagger-client-generator/swagger-cps.json
index 43601f7c..781e0c98 100644
--- a/tools/swagger-client-generator/swagger-cps.json
+++ b/tools/swagger-client-generator/swagger-cps.json
@@ -1 +1 @@
-{"swagger": "2.0", "info": {"version": "2.0.0", "title": "Corpus Processing Service (CPS) API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "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", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_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", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.api_mngt_token_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", "type": "apiKey", "name": "X-CPS-KG-Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.kg_auth_info"}}, "paths": {"/project/{proj_key}/packages": {"post": {"tags": ["Project"], "description": "Install packages on a project", "operationId": "provision_project_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "security": [{"Bearer": []}], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "schema": {"title": "ProjectPackageInstalationManifest", "type": "object", "required": ["packages"], "properties": {"packages": {"type": "array", "items": {"type": "object", "properties": {"package_id": {"type": "string"}, "overrides": {"type": "object"}}, "required": ["package_id"]}, "uniqueItems": true}}}}], "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"}}}}}, "/project/{proj_key}/data_indices": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data indices", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_indices", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project data indices.", "schema": {"type": "array", "items": {"$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"}}}}, "post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Create a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "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"}}}}, "patch": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Update a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "update_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "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"}}}}, "delete": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Delete a project index data", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "delete_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "required": true, "type": "string", "description": "The delete confirmation token"}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/delete_token": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a project data index.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Upload a file to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "upload_project_data_index_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["file_url"], "properties": {"file_url": {"type": "string"}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "ccs_convert_upload_file_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "properties": {"scratch_files_id": {"description": "List of CCS's scratch files id to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}, "file_url": {"description": "List of File's URL to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}, "s3_source": {"description": "Coordinates to object store to get files to convert. Can specify which files with object keys.", "type": "object", "properties": {"coordinates": {"description": "Coordinates to object store to get files to convert", "$ref": "#/definitions/ProjectDataIndexS3Coordinates"}, "object_keys": {"description": "List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}, "target_settings": {"description": "Specify the conversion target settings to use.", "type": "object", "properties": {"add_raw_pages": {"title": "add_raw_pages", "type": "boolean"}, "add_annotations": {"type": "boolean", "title": "add_annotations"}}}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "html_print_convert_upload", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "required": ["urls"], "properties": {"urls": {"description": "List of URLs to be printed to PDF, converted and uploaded to the data index", "type": "array", "items": {"x-oneOf": [{"type": "string"}, {"type": "object", "properties": {"url": {"type": "string"}, "filename": {"type": "string"}, "meta": {"type": "object"}}, "required": ["url"]}]}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get url and path to upload an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_attachment_upload_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Attachment upload url and path", "schema": {"title": "AttachmentUploadData", "type": "object", "required": ["attachment_path", "upload_data"], "properties": {"attachment_path": {"type": "string", "description": "Attachment path."}, "upload_data": {"type": "object", "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": {"url": {"type": "string", "description": "url of the host."}, "fields": {"type": "object", "description": "fields to use in request body."}}}}}}, "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Notify upload completion of an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "register_attachment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["attachment_path"], "properties": {"attachment_path": {"type": "string"}, "attachment_key": {"type": "string"}}}}], "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"}}}}}, "/backend/project/{proj_key}/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project, backend-aware", "produces": ["application/json"], "operationId": "backend_list_project_kgs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagBackendAware"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG, backend-aware", "produces": ["application/json"], "operationId": "backend_create_project_kg", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavours": {"type": "array", "description": "Flavours names of the bag. Determines its available resources", "items": {"type": "string"}}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavours", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}": {"patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph, backend-aware", "produces": ["application/json"], "operationId": "backend_update_project_kg_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph, backend-aware", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "backend_assemble_project_kg_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "backend_create_project_kg_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}}}}], "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"}}}}}, "/backend/project/{proj_key}/bags/{bag_key}/status": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph, backend-aware", "produces": ["application/json"], "operationId": "backend_get_project_kg_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all public BAGs", "produces": ["application/json"], "operationId": "list_public_knowledge_graphs", "parameters": [{"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project", "produces": ["application/json"], "operationId": "list_project_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG", "produces": ["application/json"], "operationId": "create_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavour": {"type": "string", "description": "\"Flavour\" of the BAG, determines its available resources."}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavour", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a BAG", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph", "produces": ["application/json"], "operationId": "update_project_knowledge_graph_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/status": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/usage_stats": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the usage stats of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_usage_stats", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Knowledge Graph usage stats.", "schema": {"title": "UsageStats", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "last_command": {"type": "string"}}}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/delete_token": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_token": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_authentication_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_callback": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Final step of redirection for authentication on a BAG.", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_authentication_callback", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "bag_token", "in": "query", "type": "string", "required": true}], "responses": {"200": {"description": "BAG auth redirect URL.", "schema": {"title": "KnowledgeGraphAuthenticationCallback", "type": "object", "properties": {"callback_url": {"type": "string"}}}}, "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/backup": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Back up a Knowledge Graph", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "BackupKnowledgeGraphOptions", "type": "object", "properties": {"backup_s3": {"type": "boolean", "default": true}, "coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/restore": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Restore a back up of a Knowledge Graph", "produces": ["application/json"], "operationId": "restore_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RestoreKnowledgeGraphBackupOptions", "type": "object", "properties": {"coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Download a Knowledge Graph", "produces": ["application/json"], "operationId": "download_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List assemble tasks for a Knowledge Graph.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_assemble_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowAssembleIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/dataset_assembles/{task_id}/report": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a report for a data flow task assemble.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_assemble_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowAssembleReportOptions", "type": "object", "properties": {"max_errors": {"type": "integer", "default": 50, "minimum": 0, "maximum": 100}, "event_log_level": {"type": "string", "default": "error", "enum": ["debug", "info", "warning", "error", "critical"]}}}}], "responses": {"200": {"description": "Report.", "schema": {"title": "DataFlowAssembleReport", "type": "object", "properties": {"task_id": {"type": "string"}, "dataflow_tasks": {"type": "object", "additionalProperties": {"title": "DataFlowAssembleReportSingleTask", "type": "object", "properties": {"status": {"type": "string"}, "progress": {"type": "number"}, "chunks": {"type": "object", "properties": {"total": {"type": "integer"}, "completed": {"type": "integer"}, "spawned": {"type": "integer"}, "success": {"type": "integer"}, "failure": {"type": "integer"}}}, "errors": {"type": "array", "items": {"type": "object", "properties": {"cause": {"type": "object", "properties": {"type": {"type": "string"}, "value": {}}}, "timestamp": {"type": "number"}}}}, "task_type": {"type": "string"}}}}}}}, "404": {"description": "Task not found, or is not a data flow assemble.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "create_project_knowledge_graph_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}}}}], "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"}}}}}, "/project/{proj_key}/bags/{bag_key}/snapshots": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List snapshots for a knowledge graph from assembled data flows.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_snapshots", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Snapshots", "schema": {"type": "array", "items": {"$ref": "#/definitions/KgSnapshot"}}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph, with its current state.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphSnapshotOptions", "type": "object", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}}, "required": ["name"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a snapshot resulting from an assembled data flow", "produces": ["application/json"], "operationId": "load_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List load tasks for a Knowledge Graph", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_load_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowLoadIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}, "save": {"type": "object"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a data flow onto a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}, "save": {"type": "object"}}, "required": ["save", "render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/suspend": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Suspend a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "suspend_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "SuspendKnowledgeGraphOptions", "type": "object", "properties": {"force": {"type": "boolean", "description": "If true, the KG will be suspended even if it's busy"}, "snapshot": {"type": "object", "properties": {"name": {"type": "string"}}}}, "required": ["force"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/resume": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Resume a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "resume_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ResumeKnowledgeGraphOptions", "type": "object", "properties": {"snapshot_to_restore_id": {"type": "string"}, "reset": {"type": "boolean"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/upgrade": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Upgrade the deployment chart of a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "upgrade_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphChartUpgradeOptions", "type": "object", "properties": {"chart": {"type": "string"}}}}], "responses": {"200": {"description": "Chart upgrading."}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "(Re)create the deployment for a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "recreate_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphDeploymentRecreationOptions", "type": "object", "properties": {"force": {"type": "boolean"}}, "required": ["force"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export_dataset": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Export dataset from a Knowledge Graph", "produces": ["application/json"], "operationId": "export_dataset", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "in": "body", "required": true, "schema": {"type": "object", "required": ["info"], "properties": {"info": {"type": "object", "required": ["coords"], "properties": {"node_list": {"type": "array", "minLength": 1, "example": [{"_db": "db1-hash", "_id": "node-id"}, {"_db": "db2-hash", "_id": "node-id"}], "items": {"type": "object", "properties": {"_db": {"type": "string"}, "_id": {"type": "string"}}, "required": ["_db", "_id"]}}, "collection_key": {"type": "string"}, "include_s3_data": {"type": "boolean", "default": false}, "projection": {"type": "object", "example": {"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})."}, "coords": {"type": "object", "required": ["databases", "node_collection"], "properties": {"databases": {"type": "object", "additionalProperties": true}, "node_collection": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}, "collection_name_prefix": {"type": "string"}, "collection": {"type": "string"}}, "required": ["uri", "database", "collection_name_prefix", "collection"]}}}}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/elastic/indices/{index_type}/{index_domain}": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List of indices for elastic instance.", "produces": ["application/json"], "operationId": "list_indices_from_elastic_instance", "parameters": [{"name": "index_type", "in": "path", "type": "string", "default": "all", "required": true}, {"name": "index_domain", "in": "path", "type": "string", "required": true, "default": "all"}], "responses": {"200": {"description": "List of Elastic Instance Indices", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCollection"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/properties": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the property schema of the given index.", "produces": ["application/json"], "operationId": "get_index_properties", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/saved_queries": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List Kibana saved queries.", "produces": ["application/json"], "operationId": "get_kibana_saved_queries", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Kibana saved queries", "schema": {"type": "array", "title": "KibanaSavedQueriesResult", "items": {"$ref": "#/definitions/KibanaSavedQueriesResult"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/domains": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List system elastic domains.", "produces": ["application/json"], "operationId": "get_elastic_domains", "responses": {"200": {"description": "List of Elastic Domains.", "schema": {"type": "array", "items": {"type": "string"}}}, "404": {"description": "Domains not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/query_max_size": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the system maximum workable elastic query size.", "produces": ["application/json"], "operationId": "get_elastic_query_max_size", "responses": {"200": {"description": "Maximum elastic query size.", "schema": {"type": "object", "properties": {"elastic_query_max_size": {"type": "number"}}}}, "404": {"description": "No maximum workable elastic query size found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/deployment/info": {"get": {"tags": ["System"], "description": "Get deployment version report", "produces": ["application/json"], "operationId": "get_version_report", "security": [{"ManagementKey": []}], "parameters": [], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/info": {"get": {"tags": ["System"], "description": "Get system info", "produces": ["application/json"], "operationId": "get_system_information", "parameters": [], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/SystemInfo"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/modules/configuration": {"get": {"tags": ["System"], "description": "Get modules configuration", "produces": ["application/json"], "operationId": "get_system_modules_configuration", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules configuration", "schema": {"$ref": "#/definitions/SystemModulesConfiguration"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/modules/tasks": {"get": {"tags": ["System"], "description": "Get modules tasks", "produces": ["application/json"], "operationId": "get_system_modules_tasks", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules tasks", "schema": {"$ref": "#/definitions/SystemModulesTasks"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/celery_tasks/status": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get the status of Celery tasks.", "produces": ["application/json"], "operationId": "list_system_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": false, "type": "string"}, {"name": "project_task_id", "in": "query", "required": false, "type": "string"}, {"name": "started_since", "required": false, "type": "number", "in": "query", "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."}, {"name": "task_status", "required": false, "type": "number", "format": "double", "in": "query"}, {"name": "limit", "required": false, "type": "integer", "in": "query", "default": 50}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["task_id", "project_task_id", "proj_key", "task_type", "created_at", "started_at", "completed_at", "task_status", "worker_name", "meta"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "project_task_id": {"type": "string"}, "project_task_type": {"type": "string", "x-nullable": true}, "meta": {"type": "object", "additionalProperties": {}}, "proj_key": {"type": "string"}, "created_at": {"type": "number"}, "started_at": {"type": "number"}, "completed_at": {"type": "number"}, "task_status": {"type": "string"}, "worker_name": {"type": "string"}, "metrics": {"type": "object"}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/celery_tasks/failure": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get celery tasks that failed.", "produces": ["application/json"], "operationId": "list_failure_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": true, "type": "string"}, {"name": "task_id", "in": "query", "required": true, "type": "string"}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["proj_key", "task_id", "failures"], "properties": {"proj_key": {"type": "string"}, "task_id": {"type": "string"}, "failures": {"type": "array", "items": {"type": "object", "properties": {"worker_name": {"type": "string"}, "task_id": {"type": "string"}, "meta": {"type": "object", "additionalProperties": {}}, "logs": {"type": "object", "additionalProperties": {}}}}}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "List all Knowledge Graphs in the system", "produces": ["application/json"], "operationId": "list_system_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"title": "KnowledgeGraphSystemInformation", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "project_name": {"type": "string"}, "backend": {"type": "object", "additionalProperties": {"type": "object", "properties": {"flavour": {"type": "string"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "chart": {"type": "string"}, "flavour": {"type": "string"}, "resources": {"type": "object", "additionalProperties": {"type": "object", "properties": {"requests": {"type": "object"}, "limits": {"type": "object"}}}}}}}}}}}}}, "default": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.admin_kg_controller"}}, "/system/packages": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get packages available in this CPS installation for installing in a project.", "produces": ["application/json"], "operationId": "list_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Packages available to this CPS installation", "schema": {"type": "array", "items": {"$ref": "#/definitions/CpsPackage"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all kgs (only bag_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_kgs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all kgs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_dcs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all data catalogs (only dc_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_dcs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all dcs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/kg_storage_summary/{kg_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get kg storage summary", "produces": ["application/json"], "operationId": "system_get_kg_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "kg_key", "in": "path", "type": "string", "required": true, "description": "Knowledge graph key"}], "responses": {"200": {"description": "Kg storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/dc_storage_summary/{dc_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get dc storage summary", "produces": ["application/json"], "operationId": "system_get_dc_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true, "description": "Data catalog key"}], "responses": {"200": {"description": "DC storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/summary": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get cps summary data.", "produces": ["application/json"], "operationId": "system_get_cps_summary", "parameters": [], "responses": {"200": {"description": "Cps summary", "schema": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "workersPool": {"type": "string"}, "numNodes": {"type": "integer"}, "availSlots": {"type": "integer"}, "availMemSlots": {"type": "integer"}, "availCpuSlots": {"type": "integer"}, "numberKgs": {"type": "integer"}, "runningKgs": {"type": "integer"}}}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/admin/list_all_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all KG flavours storage on db", "produces": ["application/json"], "operationId": "list_all_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavour/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavour from db", "produces": ["application/json"], "operationId": "get_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Get flavour successful", "schema": {"$ref": "#/definitions/BagFlavourFullData"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavour": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavour on db", "produces": ["application/json"], "operationId": "save_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "new_flavour", "in": "query", "required": true, "type": "boolean"}, {"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BagFlavourFullData"}}], "responses": {"200": {"description": "Save flavour successful"}, "409": {"description": "Flavour name already taken"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/delete_flavour/{flavour_name}": {"delete": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Delete flavour from db", "produces": ["application/json"], "operationId": "delete_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Deleted flavour successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/list_projects_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all projects and their flavours", "produces": ["application/json"], "operationId": "list_projects_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavours"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours assignment on db", "produces": ["application/json"], "operationId": "save_project_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavours"}}], "responses": {"200": {"description": "Save project flavours successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project assignment flavours", "produces": ["application/json"], "operationId": "list_flavours_by_project", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Ok", "schema": {"title": "ProjectFlavours", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavours": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "required": ["proj_key", "flavours"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavours_default_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavours default values", "produces": ["application/json"], "operationId": "get_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours default values", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavours_default_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavours default quota", "produces": ["application/json"], "operationId": "save_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavours", "in": "body", "required": true, "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}], "responses": {"200": {"description": "Save flavours default quotas successful", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_projects_flavours_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get projects flavours quotas", "produces": ["application/json"], "operationId": "get_projects_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Projects flavours quotas", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours quota", "produces": ["application/json"], "operationId": "save_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "projects_flavours_quotas", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}], "responses": {"200": {"description": "Save project flavours quota successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours_quota/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project flavours quota", "produces": ["application/json"], "operationId": "get_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours quota", "schema": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Gets kg total number by proj_key and flavour_key", "produces": ["application/json"], "operationId": "get_project_flavour_total_kgs", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours total kg number", "schema": {"title": "ProjectFlavourTotalKgs", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavour_name": {"type": "string"}, "total_kgs": {"type": "integer"}}, "required": ["proj_key", "flavour_name", "total_kgs"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/kgc/dataflows/actions/validate": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Validate a dataflow", "produces": ["application/json"], "operationId": "validate_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Validation successful."}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Run a dataflow", "produces": ["application/json"], "operationId": "assemble_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Load a dataflow into a KG", "produces": ["application/json"], "operationId": "load_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LoadKgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List public data flow templates", "produces": ["application/json"], "operationId": "list_public_data_flow_templates", "parameters": [{"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List a data flow templates", "produces": ["application/json"], "operationId": "list_project_data_flow_templates", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template", "produces": ["application/json"], "operationId": "create_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CreateDataFlowTemplateOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "maxLength": 50, "minLength": 1}, "description": {"type": "string", "x-nullable": true}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}}, "required": ["public", "name", "variables", "template", "description"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/from_json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n", "deprecated": true, "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "name", "in": "formData", "required": false, "type": "string"}, {"name": "description", "in": "formData", "required": false, "type": "string"}, {"name": "public", "in": "formData", "type": "boolean", "required": false}, {"name": "contents", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single public data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "put": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Update a data flow template", "produces": ["application/json"], "operationId": "update_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "UpdateDataFlowOptions", "type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}, "public": {"type": "boolean"}}, "required": ["public", "name", "variables", "template"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "delete": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Delete a single data flow template", "produces": ["application/json"], "operationId": "delete_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data flow template.", "produces": ["application/json"], "operationId": "create_project_data_flow_template_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "get_project_data_flow_template_topology", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowTopologyOptions", "type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "render_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RenderDataFlowTemplateOptions", "type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "properties": {"target_bag_key": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/raw_dataflow_templates/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_raw_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "required": ["data_flow", "variable_values", "log_task"], "properties": {"log_task": {"type": "boolean", "default": true}, "data_flow": {"type": "object", "properties": {"template": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["template", "variables"]}, "variable_values": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"render": {"type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}, "target": {"type": "object", "properties": {"save": {"type": "object"}}, "required": ["save"]}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "(Debug) get the fully rendered data flow, with all the coordinates set.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "debug_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "FullyRenderedDataFlow", "type": "object", "properties": {"target_bag": {"type": "object", "required": ["bag_key"], "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string"}}}, "variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/data_cataloges/known_schemas": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List System Known Data Catalog Schemas.", "produces": ["application/json"], "operationId": "list_known_data_catalog_schemas", "parameters": [], "responses": {"200": {"description": "List of Known Data Catalog Schemas.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogSchema"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/data_catalogues/with_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues with specific schema", "produces": ["application/json"], "operationId": "list_data_catalogs_and_collections_from_schema", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "schema", "x-body-name": "schema", "in": "body", "required": true, "schema": {"type": "object", "additionalProperties": {}}}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get Data Catalog Collection data.", "produces": ["application/json"], "operationId": "get_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 50, "required": false}], "responses": {"200": {"description": "Get Data Catalog Collection data."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_mongo": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_url": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a URL to a file", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_url", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogUrlImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CloneDataCatalogOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues for a project", "produces": ["application/json"], "operationId": "list_project_data_catalogs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create an empty data catalog", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogOptions", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "topology:data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "object", "additionalProperties": {}}}, "$ref": "#/definitions/DataCatalogTopology"}}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Data catalog created.", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue that was made public", "produces": ["application/json"], "operationId": "get_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_public_data_catalog_collections", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}": {"delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog's collection", "produces": ["application/json"], "operationId": "delete_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Infer the schema for a data catalog's collection.", "produces": ["application/json"], "operationId": "infer_project_data_catalog_category_schema", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "InferProjectDataCatalogCategorySchema", "type": "object", "properties": {"sample_size": {"type": "integer", "minimum": 1, "maximum": 1000}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogCollectionOptions", "minProperties": 1, "maxProperties": 1, "properties": {"ccs": {"type": "object", "properties": {"proj_key": {"type": "string"}, "auth_token": {"type": "string"}, "url": {"type": "string"}, "source_collection_name": {"type": "string"}, "export_package_mongo_options": {"type": "object", "required": ["assemble_options", "incremental", "package_options"], "properties": {"incremental": {"type": "boolean"}, "assemble_options": {"type": "object", "required": ["mode", "options"], "properties": {"mode": {"required": ["page_elements", "tables"], "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"}, "type": "array", "minItems": 2, "maxItems": 2}, "tables": {"description": "Which type of annotations to filter for the tables: H (human annotations), M (model generated)", "items": {"enum": ["H", "M"], "type": "string"}, "type": "array", "minItems": 2, "maxItems": 2}}, "type": "object"}, "options": {"required": ["include_incomplete_documents"], "properties": {"include_incomplete_documents": {"type": "boolean", "description": "Include documents with missing pages? (e.g. no annotations for some pages)"}}, "type": "object"}}}, "inputs": {"type": "object", "required": ["document_hashes"], "properties": {"document_hashes": {"type": "array", "default": [], "items": {"type": "string"}}}}, "package_options": {"type": "object", "properties": {"match_mode": {"type": "string", "default": "document_hash", "enum": ["use_fuzzy_search", "document_hash"]}, "redirect_keys_to_s3": {"type": "array", "default": [], "items": {"type": "string"}}}}}}}, "required": ["proj_key"]}, "url": {"type": "string"}, "elastic": {"title": "ImportFromElasticToDataCatalogOptions", "type": "object", "required": ["parameters"], "properties": {"coordinates": {"$ref": "#/definitions/ElasticCoordinates"}, "elastic_id": {"type": "string"}, "parameters": {"type": "object", "required": ["index", "query_options"], "properties": {"index": {"type": "string"}, "query_options": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "size": {"type": "number", "minimum": 0}, "query": {"type": "object", "additionalProperties": {}}}}, "import_s3_data": {"type": "boolean"}, "s3": {"title": "ImportFromElasticToDataCatalogS3Coords", "type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "key_prefix": {"type": "string"}, "location": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "key_prefix", "location"]}, "page_size": {"type": "number", "default": 100}}}}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog's collection", "produces": ["application/zip", "application/json", "application/x-jsonlines"], "operationId": "export_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog. The collections will be created if they don't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogOptions", "minProperties": 1, "maxProperties": 1, "properties": {"url": {"type": "string"}, "coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog.", "produces": ["application/zip"], "operationId": "export_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/delete_token": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data catalog.", "produces": ["application/json"], "operationId": "create_project_data_catalog_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List public data catalogues", "produces": ["application/json"], "operationId": "list_public_data_catalogs", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing public data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "ClonePublicDataCatalogOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting data catalogue", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue", "produces": ["application/json"], "operationId": "get_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog", "produces": ["application/json"], "operationId": "delete_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "patch": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Update the metadata of a data catalog.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "patch_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDataCatalogOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_project_data_catalog_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a collection in a data catalog", "produces": ["application/json"], "operationId": "create_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogCollectionOptions", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)+$", "maxLength": 24, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/tasks": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "List tasks for a project.", "produces": ["application/json"], "operationId": "list_project_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_type", "in": "query", "required": false, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}, {"name": "sort_by", "in": "query", "required": false, "type": "string"}, {"name": "sort_order", "in": "query", "required": false, "type": "string", "default": "asc", "enum": ["asc", "desc"]}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectTask"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Get a task for a project.", "produces": ["application/json"], "operationId": "get_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}/actions/abort": {"post": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Abort a task.", "produces": ["application/json"], "operationId": "abort_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"204": {"description": "Task aborted."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/celery_tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get a celery task for a project.", "produces": ["application/json"], "operationId": "get_project_celery_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Task", "schema": {"type": "object", "title": "CeleryTaskPromise", "required": ["task_id", "task_status", "result"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"x-nullable": true}}}}, "404": {"description": "Task not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/annotator/metadata": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get annotator's metadata", "produces": ["application/json", "text/html"], "operationId": "get_cached_annotator_metadata", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatorMetadata", "type": "object", "required": ["name", "version", "url", "author", "description"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "url": {"type": "string"}, "author": {"type": "string"}, "description": {"type": "string"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/supported_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get supported annotations for an annotator", "produces": ["application/json", "text/html"], "operationId": "get_project_annotator_supported_annotations", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "SupportedAnnotatorAnnotations", "type": "object", "required": ["entities", "relationships"], "properties": {"entities": {"type": "array", "items": {"title": "EntityAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "data_fields": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}}, "required": ["key", "description"]}}, "relationships": {"type": "array", "items": {"title": "RelationshipAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "columns": {"type": "array", "items": {"type": "object", "title": "RelationshipAnnotationColumn", "properties": {"key": {"type": "string"}, "entities": {"type": "array", "items": {"type": "string"}}}, "required": ["key", "entities"]}}}, "required": ["key", "description", "columns"]}}, "supported_object_types": {"type": "array", "items": {"type": "string"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/object_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n", "deprecated": true, "produces": ["application/json"], "operationId": "generate_project_object_annotations", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "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": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "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"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}}}}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatedObject", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/object_annotations_async": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.", "produces": ["application/json"], "operationId": "generate_project_object_annotations_async", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "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": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "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"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}, "proj_key": {"type": "string"}, "model_config_key": {"type": "string"}, "public": {"type": "boolean"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/scratch/files": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "scratch_ids", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Upload a file to temporary storage", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "File uploaded", "schema": {"title": "UploadedFileResult", "type": "object", "required": ["id", "url"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "url": {"type": "string", "description": "URL to get the temporary file form."}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files_paginated": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get paginated list of temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files_paginated", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files/upload/{filename}": {"post": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Create file pointers for temporary storage", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "required": true, "type": "string"}], "responses": {"201": {"description": "Temporary file details", "schema": {"title": "TemporaryUploadFileResult", "type": "object", "required": ["id", "upload", "download", "metadata", "upload_private", "download_private", "metadata_private"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "upload": {"type": "object", "description": "URL to upload the temporary file.", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "upload_private": {"type": "object", "description": "URL to upload the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "download": {"type": "object", "description": "URL to get the temporary file.", "properties": {"url": {"type": "string"}}}, "download_private": {"type": "object", "description": "URL to get the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}, "metadata": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method.", "properties": {"url": {"type": "string"}}}, "metadata_private": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/default_values": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "get_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "update_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "default_values", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/integrations/{integration_name}": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Get the config for a given project integration", "produces": ["application/json"], "operationId": "get_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "decode_secrets", "in": "query", "type": "boolean", "description": "Project owners can retrieve decoded secrets", "default": false}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectIntegrations"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Update the config for a given project integration", "produces": ["application/json"], "operationId": "update_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "config", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectIntegrations"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Delete the config for a given project integration", "produces": ["application/json"], "operationId": "delete_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/document": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Run an annotator on a document", "produces": ["application/json"], "operationId": "annotate_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotateDocumentRequest", "type": "object", "required": ["document", "text_annotators", "image_annotators", "table_annotators"], "properties": {"document": {"type": "object"}, "text_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "image_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "table_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "use_cache": {"type": "boolean", "default": true}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/report": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Submit a report on an inspected document", "produces": ["application/json"], "operationId": "report_inspected_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotatedDocumentReport", "type": "object", "required": ["document", "report"], "properties": {"document": {"type": "object", "properties": {"input_scratch_id": {"type": "string"}, "output_scratch_id": {"type": "string"}}, "required": ["input_scratch_id", "output_scratch_id"]}, "document_conversion_parameters": {"type": "object"}, "document_annotation_parameters": {"type": "object"}, "report": {"type": "object", "properties": {"description": {"type": "string"}, "review_consent": {"type": "boolean"}}, "required": ["review_consent"]}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/results/{document_hash}": {"delete": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Delete annotation results for a document", "produces": ["application/json"], "operationId": "delete_document_annotation_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "document_hash", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/tasks/{task_id}": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get the result of a previous document annotation", "produces": ["application/json"], "operationId": "get_annotate_document_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}, {"name": "wait", "in": "query", "required": false, "type": "number", "minimum": 0, "maximum": 10, "description": "Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling."}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["task_id", "task_status", "result", "done"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"type": "object", "x-nullable": true}, "done": {"type": "boolean"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/inspection_report": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get paginated list of inspection reports for a project", "produces": ["application/json"], "operationId": "list_project_inspection_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Reports", "schema": {"type": "array", "items": {"title": "InspectionReport", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the inpection report."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "timestamp": {"type": "number"}, "document": {"type": "string"}}, "required": ["id", "proj_key", "user_key", "timestamp", "document"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/ingest/documentqa": {"post": {"deprecated": true, "tags": ["Document Inspection", "Semantic"], "security": [{"Bearer": []}], "description": "Ingest a document for QA", "produces": ["application/json"], "operationId": "ingest_documentqa", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "IngestDocumentQARequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "IngestDocumentQASourcePublicData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "IngestDocumentQASourcePrivateData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}]}}, "required": ["source"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/semantic/ingest": {"post": {"tags": ["Semantic"], "security": [{"Bearer": []}], "description": "Ingest documents and collections for RAG", "produces": ["application/json"], "operationId": "ingest", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "SemanticIngestRequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "SemanticIngestSourcePublicDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data_document"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_document"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataCollection", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_collection"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}}, "required": ["type", "proj_key", "index_key"]}]}, "parameters": {"title": "SemanticIngestReqParams", "type": "object", "properties": {"skip_ingested_docs": {"title": "Skip Ingested Docs", "type": "boolean"}}, "required": ["skip_ingested_docs"]}}, "required": ["source", "parameters"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.semantic_controller"}}, "/project/{proj_key}/dictionaries/from_mongo": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a dictionary from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_dictionary_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DictionaryImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Dictionary created, and data is being imported.", "schema": {"title": "DictionaryImportResult", "type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "import_task": {"$ref": "#/definitions/Task"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CloneDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List dictionaries for a project", "produces": ["application/json"], "operationId": "list_project_dictionaries", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create an empty dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Dictionary created.", "schema": {"$ref": "#/definitions/Dictionary"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary that was made public", "produces": ["application/json"], "operationId": "get_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_public_dictionary_collections", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary's collection", "produces": ["application/zip", "application/json"], "operationId": "export_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file_format", "in": "query", "type": "string", "required": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary.", "produces": ["application/zip"], "operationId": "export_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/delete_token": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a dictionary.", "produces": ["application/json"], "operationId": "create_project_dictionary_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List public dictionaries", "produces": ["application/json"], "operationId": "list_public_dictionaries", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing public dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ClonePublicDictionaryOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting dictionary", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary", "produces": ["application/json"], "operationId": "delete_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "Dictionary deleted."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the metadata of a dictionary", "produces": ["application/json"], "operationId": "update_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDictionaryOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_project_dictionary_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a collection in a dictionary", "produces": ["application/json"], "operationId": "create_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateCollectionInDictionaryOptions", "type": "object", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$", "maxLength": 50, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}": {"delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary's collection", "produces": ["application/json"], "operationId": "delete_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a preview of the data in a dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "pattern": "[a-zA-Z0-9]{24}", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 1000, "required": false}, {"name": "response_format", "in": "query", "type": "string", "default": "object", "required": false}], "responses": {"200": {"description": "Dictionary collection contents.", "schema": {"x-oneOf": [{"$ref": "#/definitions/DictionaryCollectionObjectData"}, {"$ref": "#/definitions/DictionaryCollectionCsvData"}]}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the data in a dictionary's collection", "produces": ["application/json"], "operationId": "update_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "description": "A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollectionPatch"}}}], "responses": {"204": {"description": "Data updated."}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List Model Configurations for a project", "produces": ["application/json"], "operationId": "list_project_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Create a Model Configuration", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"public": {"type": "boolean"}, "name": {"pattern": "^(?:\\w| |-)+$", "type": "string"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}, "model_config_key": {"type": "string"}}, "required": ["name", "description", "public", "configurations"]}}], "responses": {"200": {"description": "Model Configuration created.", "schema": {"$ref": "#/definitions/ModelConfiguration"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration", "produces": ["application/json"], "operationId": "read_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}}, "patch": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Update a single Model Configuration", "produces": ["application/json"], "operationId": "update_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "UpdateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}}, "required": ["name", "description", "public", "configurations"]}}], "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"}}}}, "delete": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Delete a single Model Configuration", "produces": ["application/json"], "operationId": "delete_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}], "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"}}}}}, "/project/public/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List public Model Configurations", "produces": ["application/json"], "operationId": "list_public_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [], "responses": {"200": {"description": "List of public Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/public/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration that was made public", "produces": ["application/json"], "operationId": "read_public_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}}}, "/project/{proj_key}/models": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List models with the supported annotations for a project", "produces": ["application/json"], "operationId": "get_project_models_with_supported_annotations", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Models with the supported annotations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/processing_models/docs_graph_with_databases": {"post": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "consumes": ["application/json"], "produces": ["application/json"], "description": "Create a Data Flow from a list of CCS Collections and CPS Models.", "operationId": "create_data_flow_from_df_wizard", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["ccs_document_collections", "catalog_document_collections", "models", "access_token"], "properties": {"access_token": {"type": "string"}, "ccs_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CcsCollectionReference"}}, "models": {"type": "array", "items": {"$ref": "#/definitions/CpsModelReference"}}, "entity_mappings": {"$ref": "#/definitions/EntityMapping"}, "catalog_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}, "data_catalogs": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}}}}], "responses": {"200": {"description": "Processing model generated successfully", "schema": {"$ref": "#/definitions/ProcessingModel"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.processing_model_controller"}}, "/processing_models": {"get": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "produces": ["application/json"], "description": "List the available processing models.", "operationId": "get_processing_models", "x-swagger-router-controller": "api_server.controllers.processing_model_controller", "responses": {"200": {"description": "List of processing models and their description", "schema": {"type": "object", "required": ["processing_models"], "properties": {"processing_models": {"type": "array", "items": {"$ref": "#/definitions/ProcessingModelDescription"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}}, "definitions": {"TokenResponse": {"type": "object", "properties": {"token": {"type": "string"}}, "required": ["token"]}, "ProjectDataIndexWithStatus": {"title": "ProjectDataIndexWithStatus", "description": "Project data index with elastic status", "type": "object", "properties": {"source": {"title": "ProjectDataIndexSource", "type": "object", "properties": {"proj_key": {"type": "string"}, "index_key": {"type": "string"}}, "required": ["proj_key", "index_key"]}, "name": {"type": "string"}, "description": {"type": "string"}, "schema_key": {"type": "string", "description": "Index's schema key", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}, "type": {"type": "string", "description": "Index type, user friendly format", "enum": ["View", "Document", "DB Record", "Generic", "Experiment"]}, "view_of": {"type": "object", "properties": {"index_key": {"type": "string"}, "elastic_id": {"type": "string"}, "proj_key": {"type": "string"}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "creation_date": {"type": "string"}, "record_properties": {"$ref": "#/definitions/ElasticIndexProperties"}, "provenance": {"type": "string"}}, "required": ["source", "name", "description", "type", "documents", "health", "status", "creation_date"]}, "ProjectDataIndexNonView": {"title": "ProjectDataIndexNonView", "description": "Object to create a project data index", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the Index", "minLength": 1, "maxLength": 254}, "schema_key": {"type": "string", "description": "Schema key", "minLength": 1, "maxLength": 64, "default": "generic", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}}, "required": ["name"]}, "ProjectDataIndexView": {"title": "ProjectDataIndexView", "description": "Object to create a project data index view", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index view", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the index view", "minLength": 1, "maxLength": 254}, "view_of": {"type": "object", "title": "ProjectDataIndexViewOf", "properties": {"instance_id": {"type": "string", "description": "Instance id key, if the source is a data asset", "minLength": 1, "maxLength": 64}, "proj_key": {"type": "string", "description": "Project id key, if the source is a project data index", "minLength": 1, "maxLength": 64}, "index_key": {"type": "string", "description": "Data index key", "minLength": 1, "maxLength": 64}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}}, "required": ["name", "view_of"]}, "ProjectDataIndexConversionSettings": {"title": "ProjectDataIndexConversionSettings", "description": "Specify the conversion settings to use.", "type": "object", "properties": {"type": {"title": "Type", "type": "string", "default": "direct", "enum": ["direct"]}, "ocr": {"type": "object", "title": "OCR Settings", "properties": {"enabled": {"title": "Enabled", "type": "boolean", "default": false}, "backend": {"title": "Backend", "type": "string"}, "backend_settings": {"title": "Backend Settings", "type": "object"}, "merge_mode": {"title": "Merge Mode", "type": "string"}}}, "assemble": {"title": "Assemble Settings", "type": "object", "required": ["mode", "include_incomplete_documents"], "properties": {"mode": {"type": "object", "required": ["page_elements", "tables"], "properties": {"page_elements": {"title": "Page Elements", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}, "tables": {"title": "Tables", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}}}, "include_incomplete_documents": {"title": "Include Incomplete Documents", "type": "boolean"}}}, "metadata": {"title": "Collection Metadata Settings", "type": "object", "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"}}}, "page_labels": {"title": "Page Labels", "type": "object"}, "model_pipeline": {"title": "Model Pipeline Settings", "type": "object", "required": ["clusters", "page", "tables", "normalization"], "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"}]}, "page": {"title": "Page", "x-oneOf": [{"type": "object", "description": "Reference to a model configuration", "required": ["model_config_key", "proj_key"], "properties": {"model_config_key": {"title": "Model Config Key", "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string"}}}, {"type": "object", "description": "Direct configuration of a model", "required": ["type", "config"], "properties": {"type": {"title": "Type", "type": "string"}, "config": {"title": "Config", "type": "string"}}}]}, "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"}]}, "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"}]}}}}}, "ProjectDataIndexS3Coordinates": {"title": "ProjectDataIndexCOSCoordinates", "description": "Coordinates to COS", "type": "object", "properties": {"host": {"title": "host", "type": "string"}, "port": {"title": "port", "type": "number"}, "ssl": {"title": "ssl", "type": "boolean"}, "verify_ssl": {"title": "verify_ssl", "type": "boolean"}, "access_key": {"title": "access_key", "type": "string"}, "secret_key": {"title": "secret_key", "type": "string"}, "bucket": {"title": "bucket", "type": "string"}, "location": {"title": "location", "type": "string"}, "key_prefix": {"title": "key_prefix", "type": "string"}}, "required": ["host", "port", "ssl", "verify_ssl", "access_key", "secret_key", "bucket", "location"]}, "error_response": {"type": "object", "properties": {"error_message": {"type": "string"}, "error_code": {"type": "string", "x-nullable": true}}, "required": ["error_message"]}, "Problem": {"type": "object", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}, "status": {"type": "integer"}}, "additionalProperties": {}, "example": {"type": "ExampleError", "title": "An example title", "detail": "A descriptive message.", "status": 500, "may_have_extra_fields": true}}, "Bag": {"type": "object", "required": ["proj_key", "bag_key", "name", "slug", "timestamp", "bag_domain", "flavour", "bag_url", "public", "_svc_endpoint", "token"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "_svc_endpoint": {"type": "string"}, "token": {"type": "string"}}}, "BagFlavour": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}, "BagFlavourDefaultQuota": {"title": "BagFlavourDefaultQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "default_quota": {"type": "number"}}, "required": ["name", "display_name"]}, "BagFlavourFullData": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}, "is_from_deployment": {"type": "boolean"}, "project_specific": {"type": "boolean"}, "default_quota": {"type": "integer"}, "order": {"type": "number"}, "backend": {"type": "string"}, "config": {"type": "object"}}, "required": ["display_name", "description", "project_specific", "backend", "config"]}, "ProjectsFlavours": {"type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "flavours": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}}, "required": ["name"]}}}, "required": ["proj_key", "name", "flavours"]}, "ProjectsFlavoursQuota": {"title": "ProjectsFlavoursQuota", "type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "quotas": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "required": ["proj_key", "name", "quotas"]}, "FlavoursQuota": {"title": "FlavoursQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "quota": {"type": "integer"}}, "required": ["name", "display_name"]}, "SystemInfo": {"type": "object", "properties": {"allow_non_admins_to_make_resources_public": {"type": "boolean"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "disclaimer": {"type": "string"}, "should_show_warning": {"type": "boolean"}, "disable_kg_actions": {"type": "boolean"}, "linked_ccs_api": {"type": "object", "properties": {"uri": {"type": "string"}, "project_sync": {"type": "boolean"}}}}}, "toolkit": {"type": "object", "properties": {"name": {"type": "string"}, "host": {"type": "string"}, "verify_ssl": {"type": "boolean"}, "cli_command": {"type": "string"}, "required_version": {"type": "string", "x-nullable": true}}}, "api": {"type": "object", "properties": {"version": {"type": "string"}, "commit_hash": {"type": "string"}, "build_date": {"type": "integer"}}}}}, "SystemModulesConfiguration": {"type": "object", "required": ["df_template_variables", "linked_ccs_instances", "linked_elastic_instances"], "properties": {"df_template_variables": {"type": "array", "items": {"type": "object", "title": "WellKnownDfTemplateVariable", "required": ["description", "id", "type"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}, "type": {"$ref": "#/definitions/DataFlowTemplateVariable"}}}}, "linked_ccs_instances": {"type": "array", "items": {"type": "object", "title": "LinkedCcsInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}, "linked_elastic_instances": {"type": "array", "items": {"type": "object", "title": "LinkedElasticInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}}}, "SystemModulesTasks": {"type": "object", "properties": {"tasks": {"type": "object", "additionalProperties": {"type": "object", "properties": {"schema": {"type": "object"}}}}}}, "BagCallback": {"type": "object", "properties": {"callback_url": {"type": "string"}}}, "KgcDataInput": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object", "additionalProperties": {}, "properties": {"config": {"type": "object", "additionalProperties": {}, "properties": {"coordinates": {"type": "object", "additionalProperties": {}, "properties": {"source": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}, "target": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}}}}, "required": ["coordinates"]}}, "required": ["config"]}}}, "required": ["config", "data-flow"]}, "LoadKgcDataInput": {"type": "object", "properties": {"dataflow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}}, "target": {"type": "object", "properties": {"bag_key": {"type": "string"}, "save": {"type": "object"}}, "required": ["bag_key", "save"]}}, "required": ["dataflow", "target"]}, "Task": {"type": "object", "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "task_status": {"type": "string"}, "proj_key": {"type": "string"}, "error_reason": {"type": "string", "x-nullable": true}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}, "related_tasks": {"type": "array", "items": {"title": "RelatedTask", "type": "object", "required": ["task_id", "task_type"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}}}}}, "required": ["task_id", "task_type", "task_status", "proj_key", "error_reason", "kind"]}, "CcsTask": {"title": "CcsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "ccs_project_key": {"type": "string"}, "ccs_collection_name": {"type": "string"}}, "required": ["task_id", "ccs_project_key", "ccs_collection_name"]}, "CpsTask": {"title": "CpsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "task_type": {"type": "string"}}, "required": ["task_id", "task_status", "task_type"]}, "StorageSummaryTask": {"type": "object", "properties": {"task_id": {"type": "string"}, "proj_key": {"type": "string"}, "kg_key": {"type": "string"}, "dc_key": {"type": "string"}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}}, "required": ["task_id", "proj_key", "kind"]}, "StorageSummaryKG": {"type": "object", "properties": {"bag_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}, "categories_fraction": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "percentage": {"type": "number"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "color": {"type": "string"}}, "required": ["name", "percentage", "size_bytes_db", "size_converted_db"]}}}, "required": ["bag_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3", "categories_fraction"]}, "StorageSummaryDC": {"type": "object", "properties": {"dc_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}}, "required": ["dc_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3"]}, "DataCatalogue": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}, "provenance_logs": {"type": "array", "items": {"type": "object", "title": "DataCatalogProvenanceLog", "required": ["user", "timestamp", "collection_name", "source"], "properties": {"user": {"type": "object", "title": "DataCatalogProvenanceLogUser", "properties": {"user_key": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string"}}, "required": ["user_key", "name", "email"]}, "timestamp": {"type": "number"}, "collection_name": {"type": "string", "x-nullable": true}, "source": {"type": "object", "title": "DataCatalogProvenanceLogSource", "x-nullable": true, "properties": {"elastic": {}, "mongo_s3": {}, "file": {}, "url": {}, "clone": {}, "ccs": {}}}}}}}, "required": ["name", "description", "dc_key", "proj_key", "created_by", "created_at", "copy_of", "public", "topology", "category_schemas", "collections_data_flows", "provenance_logs"]}, "DataCatalogSchema": {"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}}}, "DataCatalogCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "CloneDataCatalogResult": {"type": "object", "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "clone_task": {"$ref": "#/definitions/Task"}}, "required": ["data_catalogue", "clone_task"]}, "ProjectTask": {"type": "object", "properties": {"proj_key": {"type": "string"}, "user_key": {"type": "string"}, "task_type": {"type": "string"}, "task_id": {"type": "string"}, "task_status": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "started_at": {"type": "number", "format": "double", "x-nullable": true}, "completed_at": {"type": "number", "format": "double", "x-nullable": true}, "progress": {"type": "number", "format": "double"}, "meta": {"type": "object"}}}, "BagComponentStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "start_time": {"type": "number", "format": "double", "x-nullable": true}}, "required": ["status", "start_time"]}, "BagStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "components": {"type": "object", "properties": {"kg": {"description": "Status of the Knowledge Graph and its API", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_api": {"description": "Status of the Erlenmeyer API for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_ui": {"description": "Status of the Erlenmeyer UI for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}}, "required": ["kg", "erlenmeyer_api", "erlenmeyer_ui"]}}, "required": ["status", "components"]}, "BagComponentStatusEnum": {"type": "string", "enum": ["LAUNCHING", "READY", "BUSY", "SUSPENDED", "SUSPENDING", "ERROR", "PROVISIONING", "PROVISIONING_FAILED", "UNKNOWN", "CHECKING", "PENDING_RESOURCES", "IDLE"]}, "DataFlowTemplate": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "DataFlowTemplateListItem": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlow": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object"}}, "template": {"type": "object"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlowTemplateVariable": {"type": "string", "enum": ["string", "boolean", "number", "integer", "DataCatalogId", "DictionaryId", "KnowledgeGraphId", "ModelConfigurationId", "file", "SecretString", "ElasticId", "DataCatalogCollection", "DictionaryCollection", "KnowledgeGraphCollection", "CcsCollection", "DocumentSources"]}, "TakeSnapshotSettings": {"type": "object", "properties": {"flavour": {"type": "string"}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["flavour"]}, "KgSnapshot": {"type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "x-nullable": true}, "project_task_id": {"type": "string"}, "task_type": {"type": "string"}, "name": {"type": "string"}, "is_current": {"type": "boolean"}}}, "S3CoordinatesWithBackupKey": {"type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "backup_key": {"type": "string"}, "presigned": {"type": "object", "properties": {"url": {"type": "string"}, "fields": {"type": "object", "additionalProperties": {}}}, "required": ["url", "fields"]}}, "required": ["bucket", "backup_key"]}, "MongoCoordinates": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}}, "required": ["uri", "database"]}, "S3Coordinates": {"type": "object", "description": "If provided, the S3 data will be copied", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "key_prefix": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "location", "key_prefix"]}, "MongoS3Coordinates": {"type": "object", "properties": {"mongo": {"$ref": "#/definitions/MongoCoordinates"}, "s3": {"$ref": "#/definitions/S3Coordinates"}}}, "CollectionListCoordinates": {"type": "object", "properties": {"collections": {"type": "array", "items": {"type": "string"}}}}, "MongoS3CoordinatesWithCollectionList": {"allOf": [{"$ref": "#/definitions/MongoS3Coordinates"}, {"$ref": "#/definitions/CollectionListCoordinates"}]}, "CpsPackage": {"type": "object", "properties": {"name": {"type": "string"}, "package_id": {"type": "string"}, "description": {"type": "string"}, "type": {"type": "string", "enum": ["model", "dictionary", "knowledge_graph", "data_catalog", "data_flow", "bundle"]}, "dependencies": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "package_id", "description", "type", "dependencies"]}, "EntityAnnotation": {"type": "object", "properties": {"match": {"type": "string"}, "range": {"type": "array", "description": "2-Tuple representing the low and high indexes of the matching substring", "items": {"type": "integer"}, "minItems": 2, "maxItems": 2}, "subtype": {"type": "string"}, "type": {"type": "string"}}, "required": ["match", "range", "type"]}, "RelationshipAnnotation": {"type": "object"}, "ObjectPropertyMap": {"type": "object"}, "AnnotatedText": {"type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedTable": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedImage": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedObject": {"type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}, "TopologyNode": {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"]}, "TopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "source", "target"]}, "Topology": {"type": "object", "properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/TopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/TopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogTopologyNode": {"properties": {"name": {"type": "string"}, "data-fields": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "data-fields"]}, "DataCatalogTopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}, "source_field": {"type": "string"}, "target_field": {"type": "string"}}, "required": ["name", "source", "target", "source_field", "target_field"]}, "DataCatalogTopology": {"properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogImportResult": {"type": "object", "required": ["data_catalogue", "import_task"], "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "import_task": {"$ref": "#/definitions/Task"}}}, "ElasticCoordinates": {"type": "object", "required": ["hosts"], "properties": {"hosts": {"type": "array", "items": {"type": "string"}}, "ca_certificate_base64": {"type": "string"}, "dangerously_disable_ssl_validation": {"type": "boolean"}}}, "ModelConfiguration": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"], "additionalProperties": {}}, "supported_annotations": {"type": "object"}}, "required": ["name", "description", "model_config_key", "proj_key", "created_by", "created_at", "public"]}, "DictionaryCollectionObjectData": {"title": "DictionaryCollectionObjectData", "type": "array", "items": {"title": "DictionaryEntryWithId", "properties": {"_id": {"type": "string"}}, "required": ["_id"], "allOf": [{"$ref": "#/definitions/DictionaryEntry"}]}}, "DictionaryCollectionCsvData": {"title": "DictionaryCollectionCsvData", "type": "object", "properties": {"header": {"type": "string"}, "body": {"type": "string"}}, "required": ["header", "body"]}, "ProjectDefaultValues": {"type": "object", "properties": {"ccs_project": {"type": "object", "required": ["proj_key", "name"], "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "collection_name": {"type": "string"}}}, "dataflow": {"type": "object", "required": ["df_tpl_key", "name"], "properties": {"df_tpl_key": {"type": "string"}, "name": {"type": "string"}}}}}, "ProjectIntegrations": {"x-anyOf": [{"title": "Genai", "x-anyOf": [{"title": "GenAIWatsonx", "description": "GenAI integration for watsonx settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "watsonx", "const": "watsonx", "type": "string"}, "config": {"title": "GenAIWatsonxConfig", "description": "Config for watsonx", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_PROJECT_ID": {"title": "Project Id", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "project_id", "apikey"]}}, "required": ["config"]}, {"title": "GenAIBAM", "description": "GenAI integration for BAM settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "bam", "const": "bam", "type": "string"}, "config": {"title": "GenAIBAMConfig", "description": "Config for BAM", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "apikey"]}}, "required": ["config"]}, {"title": "GenAIHFInferenceApi", "description": "GenAI integration for Inference API settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "hf_api", "const": "hf_api", "type": "string"}, "config": {"title": "GenAIHFInferenceApiConfig", "description": "Config for HF Inference API", "type": "object", "properties": {"GENAI_HF_API_KEY": {"title": "Genai Hf Api Key", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["GENAI_HF_API_KEY"]}}, "required": ["config"]}, {"title": "GenAIAWSBedrock", "description": "GenAI integration for AWS Bedrock settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "aws_bedrock", "const": "aws_bedrock", "type": "string"}, "config": {"title": "GenAIAWSBedrockConfig", "description": "Config for AWS Bedrock", "type": "object", "properties": {"GENAI_AWS_ACCESS_KEY": {"title": "Genai Aws Access Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_SECRET_KEY": {"title": "Genai Aws Secret Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_REGION_NAME": {"title": "Genai Aws Region Name", "type": "string"}}, "required": ["GENAI_AWS_ACCESS_KEY", "GENAI_AWS_SECRET_KEY", "GENAI_AWS_REGION_NAME"]}}, "required": ["config"]}]}]}, "BagBackendAware": {"type": "object", "required": ["proj_key", "bag_key", "name", "description", "slug", "timestamp", "backend", "public"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "backend": {"type": "object", "title": "BagBackends", "properties": {"kg_legacy_api": {"type": "object", "title": "BagKgLegacyApiBackend", "properties": {"bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "token": {"type": "string"}, "_svc_endpoint": {"type": "string"}}}, "kg_amqp": {"type": "object", "title": "BagAmqpBackend", "properties": {"flavour": {"type": "string"}}}}}, "public": {"type": "boolean"}, "last_coords_resolution": {"type": "number"}}}, "TakeSnapshotSettingsBackendAware": {"type": "object", "properties": {"backend_flavours": {"type": "object", "title": "BackendFlavour", "properties": {"kg_amqp": {"type": "string"}, "kg_legacy_api": {"type": "string"}}}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["backend_flavours"]}, "BagStatusBackendAware": {"type": "object", "properties": {"overall_status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "kg_amqp": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}}, "required": ["status"]}, "kg_legacy_api": {"$ref": "#/definitions/BagStatus"}}, "required": ["overall_status"]}, "AnnotatorSupportedAnnotationsParameters": {"type": "object", "properties": {"annotator": {"type": "string"}, "annotator_settings": {"type": "object"}}, "required": ["annotator"]}, "ModelSupportedAnnotationsParameters": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}, "required": ["model_config_key", "proj_key", "public"]}, "ElasticIndexSearchQueryOptions": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "from": {"type": "number", "minimum": 0}, "size": {"type": "number", "minimum": 0, "maximum": 10000}, "query": {"type": "object", "additionalProperties": {}}, "aggs": {"type": "object"}, "sort": {"type": "array", "items": {"type": "object"}}}}, "ElasticIndexProperties": {"type": "object"}, "KibanaSavedQueriesResult": {"type": "object", "properties": {"description": {"type": "string"}, "fields": {"type": "array", "items": {"type": "string"}}, "query": {"type": "string"}, "title": {"type": "string"}}}, "AnnotatorParametersOrRef": {"type": "object", "properties": {"type": {"type": "string"}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}}, "DataCollection": {"type": "object", "required": ["name", "documents", "health", "status", "metadata"], "properties": {"name": {"type": "string"}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "metadata": {"type": "object", "required": ["aliases", "created", "description", "source", "version", "type", "domain"], "properties": {"aliases": {"type": "array", "items": {"type": "string"}}, "created": {"type": "string", "format": "datetime"}, "description": {"type": "string"}, "source": {"type": "string"}, "storage": {"type": "string"}, "version": {"type": "string"}, "type": {"type": "string"}, "domain": {"type": "array", "items": {"type": "string"}}}}, "source": {"type": "object", "required": ["index_key"], "properties": {"index_key": {"type": "string"}, "proj_key": {"type": "string"}, "elastic_id": {"type": "string"}}}}}, "Dictionary": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dict_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "required": ["name", "description", "dict_key", "proj_key", "created_by", "created_at", "copy_of", "public"]}, "DictionaryEntry": {"type": "object", "additionalProperties": {}, "properties": {"_name": {"type": "string"}, "_synonyms": {"type": "array", "items": {"type": "string"}}}, "required": ["_name", "_synonyms"]}, "DictionaryCloneResult": {"type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "clone_task": {"$ref": "#/definitions/Task"}}}, "DictionaryCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "DictionaryCollectionPatch": {"type": "object", "required": ["op", "path"], "properties": {"op": {"type": "string", "enum": ["add", "replace", "remove"]}, "path": {"type": "string", "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})$"}, "value": {"$ref": "#/definitions/DictionaryEntry"}}}, "CpsModelReference": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}}, "required": ["model_config_key", "proj_key"]}, "CcsCollectionReference": {"type": "object", "properties": {"proj_key": {"type": "string"}, "collection_name": {"type": "string"}, "language": {"type": "string"}}, "required": ["proj_key", "collection_name"]}, "ProcessingModelDataFlow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "WorkFlow": {"type": "object"}, "ProcessingModel": {"type": "object", "required": ["dataflow"], "properties": {"dataflow": {"$ref": "#/definitions/ProcessingModelDataFlow"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "title": "DataFlowVariableDefinition", "properties": {"type": {"type": "string"}}, "required": ["type"]}}}}, "CatalogReference": {"type": "object", "properties": {"dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection_name": {"type": "string"}}, "required": ["dc_key", "collection_name"]}, "EntityMapping": {"type": "object", "additionalProperties": {"type": "string"}}, "ProcessingModelDescription": {"type": "object", "required": ["name", "display_name", "description"], "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}}, "basePath": "/api/cps/public/v1"}
+{"swagger": "2.0", "info": {"version": "2.0.0", "title": "Corpus Processing Service (CPS) API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "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", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_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", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.api_mngt_token_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", "type": "apiKey", "name": "X-CPS-KG-Authorization", "in": "header", "x-apikeyInfoFunc": "api_server.utils.connexion_auth.kg_auth_info"}}, "paths": {"/project/{proj_key}/packages": {"post": {"tags": ["Project"], "description": "Install packages on a project", "operationId": "provision_project_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "security": [{"Bearer": []}], "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "schema": {"title": "ProjectPackageInstalationManifest", "type": "object", "required": ["packages"], "properties": {"packages": {"type": "array", "items": {"type": "object", "properties": {"package_id": {"type": "string"}, "overrides": {"type": "object"}}, "required": ["package_id"]}, "uniqueItems": true}}}}], "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"}}}}}, "/project/{proj_key}/data_indices": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data indices", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_indices", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project data indices.", "schema": {"type": "array", "items": {"$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"}}}}, "post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Create a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "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"}}}}, "patch": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Update a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "update_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"x-oneOf": [{"$ref": "#/definitions/ProjectDataIndexNonView"}, {"$ref": "#/definitions/ProjectDataIndexView"}]}}], "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"}}}}, "delete": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Delete a project index data", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "delete_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "required": true, "type": "string", "description": "The delete confirmation token"}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/delete_token": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a project data index.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "create_project_data_index_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Upload a file to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "upload_project_data_index_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["file_url"], "properties": {"file_url": {"type": "string"}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/ccs_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert files via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "ccs_convert_upload_file_project_data_index", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "properties": {"file_url": {"description": "List of File's URL to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}, "s3_source": {"description": "Coordinates to object store to get files to convert. Can specify which files with object keys.", "type": "object", "properties": {"coordinates": {"description": "Coordinates to object store to get files to convert", "$ref": "#/definitions/ProjectDataIndexS3Coordinates"}, "object_keys": {"description": "List of s3 object keys to retrieve from bucket to be converted and uploaded to the data index", "type": "array", "items": {"type": "string"}}}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}, "target_settings": {"description": "Specify the conversion target settings to use.", "type": "object", "properties": {"add_raw_pages": {"title": "add_raw_pages", "type": "boolean"}, "add_annotations": {"type": "boolean", "title": "add_annotations"}}}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/actions/html_print_convert_upload": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Convert a list of HTML pages to PDF, convert them via CCS and upload to a project data index (only for indices with 'deepsearch-doc' schema)", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "html_print_convert_upload", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataIndexUploadFileSource", "type": "object", "required": ["urls"], "properties": {"urls": {"description": "List of URLs to be printed to PDF, converted and uploaded to the data index", "type": "array", "items": {"x-oneOf": [{"type": "string"}, {"type": "object", "properties": {"url": {"type": "string"}, "filename": {"type": "string"}, "meta": {"type": "object"}}, "required": ["url"]}]}}, "conversion_settings": {"description": "Specify conversion settings (OCR, Assemble, ML Models) directly", "$ref": "#/definitions/ProjectDataIndexConversionSettings"}}}}], "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment_url/{filename}": {"get": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Get url and path to upload an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "get_attachment_upload_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Attachment upload url and path", "schema": {"title": "AttachmentUploadData", "type": "object", "required": ["attachment_path", "upload_data"], "properties": {"attachment_path": {"type": "string", "description": "Attachment path."}, "upload_data": {"type": "object", "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": {"url": {"type": "string", "description": "url of the host."}, "fields": {"type": "object", "description": "fields to use in request body."}}}}}}, "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"}}}}}, "/project/{proj_key}/data_indices/{index_key}/documents/{index_item_id}/attachment": {"post": {"tags": ["Data Indices"], "security": [{"Bearer": []}], "description": "Notify upload completion of an attachment to a project data index", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.project_data_indices", "operationId": "register_attachment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "index_key", "in": "path", "type": "string", "required": true}, {"name": "index_item_id", "in": "path", "type": "string", "required": true}, {"name": "params", "in": "body", "required": true, "schema": {"type": "object", "required": ["attachment_path"], "properties": {"attachment_path": {"type": "string"}, "attachment_key": {"type": "string"}}}}], "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"}}}}}, "/backend/project/{proj_key}/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project, backend-aware", "produces": ["application/json"], "operationId": "backend_list_project_kgs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagBackendAware"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG, backend-aware", "produces": ["application/json"], "operationId": "backend_create_project_kg", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavours": {"type": "array", "description": "Flavours names of the bag. Determines its available resources", "items": {"type": "string"}}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavours", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}": {"patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph, backend-aware", "produces": ["application/json"], "operationId": "backend_update_project_kg_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph, backend-aware", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "backend_assemble_project_kg_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/backend/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task, backend-aware", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "backend_create_project_kg_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettingsBackendAware"}}}}], "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"}}}}}, "/backend/project/{proj_key}/bags/{bag_key}/status": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph, backend-aware", "produces": ["application/json"], "operationId": "backend_get_project_kg_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/bags": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all public BAGs", "produces": ["application/json"], "operationId": "list_public_knowledge_graphs", "parameters": [{"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List all bags in the project", "produces": ["application/json"], "operationId": "list_project_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Bag"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create new BAG", "produces": ["application/json"], "operationId": "create_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateKnowledgeGraphOptions", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "description": "Name of the BAG", "maxLength": 32}, "flavour": {"type": "string", "description": "\"Flavour\" of the BAG, determines its available resources."}, "public": {"type": "boolean", "description": "If true, the BAG will be publicly available"}, "description": {"type": "string", "x-nullable": true, "description": "Description of the BAG"}}, "required": ["name", "flavour", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a BAG", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "patch": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Update the metadata of a Knowledge graph", "produces": ["application/json"], "operationId": "update_project_knowledge_graph_metadata", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "x-body-name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchKnowledgeGraphOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"], "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/status": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the status of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_status", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "details", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/usage_stats": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get the usage stats of a Knowledge Graph", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_usage_stats", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Knowledge Graph usage stats.", "schema": {"title": "UsageStats", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "last_command": {"type": "string"}}}}, "404": {"description": "BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/delete_token": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_token": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Get a token used to authenticate in the Erlenmeyer / KG APIs of a BAG.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_authentication_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/auth_callback": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Final step of redirection for authentication on a BAG.", "produces": ["application/json"], "operationId": "get_project_knowledge_graph_authentication_callback", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "bag_token", "in": "query", "type": "string", "required": true}], "responses": {"200": {"description": "BAG auth redirect URL.", "schema": {"title": "KnowledgeGraphAuthenticationCallback", "type": "object", "properties": {"callback_url": {"type": "string"}}}}, "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/backup": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Back up a Knowledge Graph", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "BackupKnowledgeGraphOptions", "type": "object", "properties": {"backup_s3": {"type": "boolean", "default": true}, "coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/restore": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Restore a back up of a Knowledge Graph", "produces": ["application/json"], "operationId": "restore_project_knowledge_graph_backup", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RestoreKnowledgeGraphBackupOptions", "type": "object", "properties": {"coordinates": {"$ref": "#/definitions/S3CoordinatesWithBackupKey"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Download a Knowledge Graph", "produces": ["application/json"], "operationId": "download_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow": {"get": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List assemble tasks for a Knowledge Graph.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_assemble_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowAssembleIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Assemble a data flow on a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AssembleDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}}, "required": ["render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/dataset_assembles/{task_id}/report": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a report for a data flow task assemble.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_assemble_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowAssembleReportOptions", "type": "object", "properties": {"max_errors": {"type": "integer", "default": 50, "minimum": 0, "maximum": 100}, "event_log_level": {"type": "string", "default": "error", "enum": ["debug", "info", "warning", "error", "critical"]}}}}], "responses": {"200": {"description": "Report.", "schema": {"title": "DataFlowAssembleReport", "type": "object", "properties": {"task_id": {"type": "string"}, "dataflow_tasks": {"type": "object", "additionalProperties": {"title": "DataFlowAssembleReportSingleTask", "type": "object", "properties": {"status": {"type": "string"}, "progress": {"type": "number"}, "chunks": {"type": "object", "properties": {"total": {"type": "integer"}, "completed": {"type": "integer"}, "spawned": {"type": "integer"}, "success": {"type": "integer"}, "failure": {"type": "integer"}}}, "errors": {"type": "array", "items": {"type": "object", "properties": {"cause": {"type": "object", "properties": {"type": {"type": "string"}, "value": {}}}, "timestamp": {"type": "number"}}}}, "task_type": {"type": "string"}}}}}}}, "404": {"description": "Task not found, or is not a data flow assemble.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/assemble_dataflow/latest/snapshots": {"post": {"deprecated": true, "tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph from the last data flow assembly task.", "produces": ["application/json"], "x-swagger-router-controller": "api_server.controllers.controller", "operationId": "create_project_knowledge_graph_snapshot_from_data_flow_assembly", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["snapshot"], "properties": {"snapshot": {"$ref": "#/definitions/TakeSnapshotSettings"}}}}], "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"}}}}}, "/project/{proj_key}/bags/{bag_key}/snapshots": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List snapshots for a knowledge graph from assembled data flows.", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_snapshots", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Snapshots", "schema": {"type": "array", "items": {"$ref": "#/definitions/KgSnapshot"}}}, "404": {"description": "KG/BAG not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Create a snapshot of a Knowledge Graph, with its current state.", "produces": ["application/json"], "operationId": "create_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphSnapshotOptions", "type": "object", "properties": {"name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}}, "required": ["name"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}/actions/load": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a snapshot resulting from an assembled data flow", "produces": ["application/json"], "operationId": "load_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/snapshots/{execution_id}": {"delete": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Delete a snapshot resulting from an assembled data flow. The execution log itself is not deleted.", "produces": ["application/json"], "operationId": "delete_project_knowledge_graph_snapshot", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "execution_id", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/load_dataflow": {"get": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "List load tasks for a Knowledge Graph", "produces": ["application/json"], "operationId": "list_project_knowledge_graph_load_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"title": "DataFlowLoadIntoKnowledgeGraphTask", "type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "properties": {"render_options": {"type": "object", "properties": {"variables": {"type": "object"}, "target_bag": {"type": "object"}}}, "template": {"type": "string"}, "variables": {"type": "object"}}}, "save": {"type": "object"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Load a data flow onto a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_knowledge_graph_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"data_flow": {"type": "object", "properties": {"raw_data_flow": {"type": "object", "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"]}, "public": {"description": "Must be set if the data flow template is public", "type": "boolean"}, "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"}}}, "render": {"type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}, "required": ["variables"]}, "save": {"type": "object"}}, "required": ["save", "render", "data_flow"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/suspend": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Suspend a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "suspend_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "SuspendKnowledgeGraphOptions", "type": "object", "properties": {"force": {"type": "boolean", "description": "If true, the KG will be suspended even if it's busy"}, "snapshot": {"type": "object", "properties": {"name": {"type": "string"}}}}, "required": ["force"]}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/ProjectTask"}}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/resume": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Resume a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "resume_project_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ResumeKnowledgeGraphOptions", "type": "object", "properties": {"snapshot_to_restore_id": {"type": "string"}, "reset": {"type": "boolean"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/upgrade": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "Upgrade the deployment chart of a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "upgrade_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphChartUpgradeOptions", "type": "object", "properties": {"chart": {"type": "string"}}}}], "responses": {"200": {"description": "Chart upgrading."}, "404": {"description": "Knowledge Graph doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/recreate_deployment": {"post": {"tags": ["Knowledge Graphs"], "security": [{"Bearer": []}], "description": "(Re)create the deployment for a Knowledge Graph", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "recreate_project_knowledge_graph_deployment", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "KnowledgeGraphDeploymentRecreationOptions", "type": "object", "properties": {"force": {"type": "boolean"}}, "required": ["force"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/bags/{bag_key}/tasks/export_dataset": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Export dataset from a Knowledge Graph", "produces": ["application/json"], "operationId": "export_dataset", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "bag_key", "in": "path", "type": "string", "required": true}, {"name": "data", "in": "body", "required": true, "schema": {"type": "object", "required": ["info"], "properties": {"info": {"type": "object", "required": ["coords"], "properties": {"node_list": {"type": "array", "minLength": 1, "example": [{"_db": "db1-hash", "_id": "node-id"}, {"_db": "db2-hash", "_id": "node-id"}], "items": {"type": "object", "properties": {"_db": {"type": "string"}, "_id": {"type": "string"}}, "required": ["_db", "_id"]}}, "collection_key": {"type": "string"}, "include_s3_data": {"type": "boolean", "default": false}, "projection": {"type": "object", "example": {"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})."}, "coords": {"type": "object", "required": ["databases", "node_collection"], "properties": {"databases": {"type": "object", "additionalProperties": true}, "node_collection": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}, "collection_name_prefix": {"type": "string"}, "collection": {"type": "string"}}, "required": ["uri", "database", "collection_name_prefix", "collection"]}}}}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.kg_controller"}}, "/elastic/indices/{index_type}/{index_domain}": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List of indices for elastic instance.", "produces": ["application/json"], "operationId": "list_indices_from_elastic_instance", "parameters": [{"name": "index_type", "in": "path", "type": "string", "default": "all", "required": true}, {"name": "index_domain", "in": "path", "type": "string", "required": true, "default": "all"}], "responses": {"200": {"description": "List of Elastic Instance Indices", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCollection"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/properties": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the property schema of the given index.", "produces": ["application/json"], "operationId": "get_index_properties", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/{elastic_instance}/{elastic_index}/saved_queries": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List Kibana saved queries.", "produces": ["application/json"], "operationId": "get_kibana_saved_queries", "parameters": [{"name": "elastic_instance", "in": "path", "type": "string", "required": true}, {"name": "elastic_index", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Kibana saved queries", "schema": {"type": "array", "title": "KibanaSavedQueriesResult", "items": {"$ref": "#/definitions/KibanaSavedQueriesResult"}}}, "404": {"description": "Instance indices not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/domains": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "List system elastic domains.", "produces": ["application/json"], "operationId": "get_elastic_domains", "responses": {"200": {"description": "List of Elastic Domains.", "schema": {"type": "array", "items": {"type": "string"}}}, "404": {"description": "Domains not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/elastic/query_max_size": {"get": {"tags": ["Elastic"], "security": [{"Bearer": []}], "description": "Get the system maximum workable elastic query size.", "produces": ["application/json"], "operationId": "get_elastic_query_max_size", "responses": {"200": {"description": "Maximum elastic query size.", "schema": {"type": "object", "properties": {"elastic_query_max_size": {"type": "number"}}}}, "404": {"description": "No maximum workable elastic query size found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.elastic_controller"}}, "/deployment/info": {"get": {"tags": ["System"], "description": "Get deployment version report", "produces": ["application/json"], "operationId": "get_version_report", "security": [{"ManagementKey": []}], "parameters": [], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/info": {"get": {"tags": ["System"], "description": "Get system info", "produces": ["application/json"], "operationId": "get_system_information", "parameters": [], "responses": {"201": {"description": "OK", "schema": {"$ref": "#/definitions/SystemInfo"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/modules/configuration": {"get": {"tags": ["System"], "description": "Get modules configuration", "produces": ["application/json"], "operationId": "get_system_modules_configuration", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules configuration", "schema": {"$ref": "#/definitions/SystemModulesConfiguration"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/modules/tasks": {"get": {"tags": ["System"], "description": "Get modules tasks", "produces": ["application/json"], "operationId": "get_system_modules_tasks", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"201": {"description": "Modules tasks", "schema": {"$ref": "#/definitions/SystemModulesTasks"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/celery_tasks/status": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get the status of Celery tasks.", "produces": ["application/json"], "operationId": "list_system_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": false, "type": "string"}, {"name": "project_task_id", "in": "query", "required": false, "type": "string"}, {"name": "started_since", "required": false, "type": "number", "in": "query", "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."}, {"name": "task_status", "required": false, "type": "number", "format": "double", "in": "query"}, {"name": "limit", "required": false, "type": "integer", "in": "query", "default": 50}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["task_id", "project_task_id", "proj_key", "task_type", "created_at", "started_at", "completed_at", "task_status", "worker_name", "meta"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "project_task_id": {"type": "string"}, "project_task_type": {"type": "string", "x-nullable": true}, "meta": {"type": "object", "additionalProperties": {}}, "proj_key": {"type": "string"}, "created_at": {"type": "number"}, "started_at": {"type": "number"}, "completed_at": {"type": "number"}, "task_status": {"type": "string"}, "worker_name": {"type": "string"}, "metrics": {"type": "object"}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/celery_tasks/failure": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get celery tasks that failed.", "produces": ["application/json"], "operationId": "list_failure_celery_tasks", "parameters": [{"name": "proj_key", "in": "query", "required": true, "type": "string"}, {"name": "task_id", "in": "query", "required": true, "type": "string"}], "responses": {"200": {"description": "Celery tasks", "schema": {"type": "array", "items": {"title": "CeleryTask", "type": "object", "required": ["proj_key", "task_id", "failures"], "properties": {"proj_key": {"type": "string"}, "task_id": {"type": "string"}, "failures": {"type": "array", "items": {"type": "object", "properties": {"worker_name": {"type": "string"}, "task_id": {"type": "string"}, "meta": {"type": "object", "additionalProperties": {}}, "logs": {"type": "object", "additionalProperties": {}}}}}}}}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "List all Knowledge Graphs in the system", "produces": ["application/json"], "operationId": "list_system_knowledge_graphs", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "term", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"title": "KnowledgeGraphSystemInformation", "type": "object", "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "project_name": {"type": "string"}, "backend": {"type": "object", "additionalProperties": {"type": "object", "properties": {"flavour": {"type": "string"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "chart": {"type": "string"}, "flavour": {"type": "string"}, "resources": {"type": "object", "additionalProperties": {"type": "object", "properties": {"requests": {"type": "object"}, "limits": {"type": "object"}}}}}}}}}}}}}, "default": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.admin_kg_controller"}}, "/system/packages": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get packages available in this CPS installation for installing in a project.", "produces": ["application/json"], "operationId": "list_packages", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Packages available to this CPS installation", "schema": {"type": "array", "items": {"$ref": "#/definitions/CpsPackage"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_kgs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all kgs (only bag_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_kgs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all kgs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_all_dcs": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all data catalogs (only dc_key) for admin use", "produces": ["application/json"], "operationId": "system_get_all_dcs_admin", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [], "responses": {"200": {"description": "Array with all dcs's key", "schema": {"type": "array", "items": {"type": "string"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/kg_storage_summary/{kg_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get kg storage summary", "produces": ["application/json"], "operationId": "system_get_kg_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "kg_key", "in": "path", "type": "string", "required": true, "description": "Knowledge graph key"}], "responses": {"200": {"description": "Kg storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/dc_storage_summary/{dc_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get dc storage summary", "produces": ["application/json"], "operationId": "system_get_dc_storage_summary_async", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true, "description": "Data catalog key"}], "responses": {"200": {"description": "DC storage summary", "schema": {"$ref": "#/definitions/StorageSummaryTask"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/summary": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get cps summary data.", "produces": ["application/json"], "operationId": "system_get_cps_summary", "parameters": [], "responses": {"200": {"description": "Cps summary", "schema": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "workersPool": {"type": "string"}, "numNodes": {"type": "integer"}, "availSlots": {"type": "integer"}, "availMemSlots": {"type": "integer"}, "availCpuSlots": {"type": "integer"}, "numberKgs": {"type": "integer"}, "runningKgs": {"type": "integer"}}}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/system/admin/list_all_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all KG flavours storage on db", "produces": ["application/json"], "operationId": "list_all_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavour/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavour from db", "produces": ["application/json"], "operationId": "get_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Get flavour successful", "schema": {"$ref": "#/definitions/BagFlavourFullData"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavour": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavour on db", "produces": ["application/json"], "operationId": "save_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "new_flavour", "in": "query", "required": true, "type": "boolean"}, {"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/BagFlavourFullData"}}], "responses": {"200": {"description": "Save flavour successful"}, "409": {"description": "Flavour name already taken"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/delete_flavour/{flavour_name}": {"delete": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Delete flavour from db", "produces": ["application/json"], "operationId": "delete_flavour", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Deleted flavour successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/list_projects_flavours": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get all projects and their flavours", "produces": ["application/json"], "operationId": "list_projects_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours storage on db", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavours"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours assignment on db", "produces": ["application/json"], "operationId": "save_project_flavours", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavours"}}], "responses": {"200": {"description": "Save project flavours successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project assignment flavours", "produces": ["application/json"], "operationId": "list_flavours_by_project", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Ok", "schema": {"title": "ProjectFlavours", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavours": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourFullData"}}}, "required": ["proj_key", "flavours"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_flavours_default_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get flavours default values", "produces": ["application/json"], "operationId": "get_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Flavours default values", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_flavours_default_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save flavours default quota", "produces": ["application/json"], "operationId": "save_flavours_default_quotas", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "flavours", "in": "body", "required": true, "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}], "responses": {"200": {"description": "Save flavours default quotas successful", "schema": {"type": "array", "items": {"$ref": "#/definitions/BagFlavourDefaultQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_projects_flavours_quota": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get projects flavours quotas", "produces": ["application/json"], "operationId": "get_projects_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [], "responses": {"200": {"description": "Projects flavours quotas", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/save_project_flavours_quota": {"put": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Save project flavours quota", "produces": ["application/json"], "operationId": "save_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "projects_flavours_quotas", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectsFlavoursQuota"}}], "responses": {"200": {"description": "Save project flavours quota successful"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavours_quota/{proj_key}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Get project flavours quota", "produces": ["application/json"], "operationId": "get_project_flavours_quota", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours quota", "schema": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/system/admin/get_project_flavour_total_kgs/{proj_key}/{flavour_name}": {"get": {"tags": ["System"], "security": [{"Bearer": []}], "description": "Gets kg total number by proj_key and flavour_key", "produces": ["application/json"], "operationId": "get_project_flavour_total_kgs", "x-swagger-router-controller": "api_server.controllers.system_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "flavour_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Project flavours total kg number", "schema": {"title": "ProjectFlavourTotalKgs", "type": "object", "properties": {"proj_key": {"type": "string"}, "flavour_name": {"type": "string"}, "total_kgs": {"type": "integer"}}, "required": ["proj_key", "flavour_name", "total_kgs"]}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/kgc/dataflows/actions/validate": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Validate a dataflow", "produces": ["application/json"], "operationId": "validate_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Validation successful."}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Run a dataflow", "produces": ["application/json"], "operationId": "assemble_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dataflow", "x-body-name": "dataflow", "in": "body", "required": true, "schema": {"$ref": "#/definitions/KgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflows/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Load a dataflow into a KG", "produces": ["application/json"], "operationId": "load_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"$ref": "#/definitions/LoadKgcDataInput"}}], "responses": {"200": {"description": "Task started.", "schema": {"$ref": "#/definitions/Task"}}, "400": {"description": "Invalid dataflow.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List public data flow templates", "produces": ["application/json"], "operationId": "list_public_data_flow_templates", "parameters": [{"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "List a data flow templates", "produces": ["application/json"], "operationId": "list_project_data_flow_templates", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "required": false, "type": "string"}], "responses": {"200": {"description": "List of data flow templates.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataFlowTemplateListItem"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template", "produces": ["application/json"], "operationId": "create_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CreateDataFlowTemplateOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "maxLength": 50, "minLength": 1}, "description": {"type": "string", "x-nullable": true}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}}, "required": ["public", "name", "variables", "template", "description"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/from_json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Create a data flow template from a JSON file.\n**DEPRECATED**: use `create_project_data_flow_template`\n", "deprecated": true, "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "name", "in": "formData", "required": false, "type": "string"}, {"name": "description", "in": "formData", "required": false, "type": "string"}, {"name": "public", "in": "formData", "type": "boolean", "required": false}, {"name": "contents", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/public/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single public data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_public_data_flow_template", "parameters": [{"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}": {"get": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a single data flow template", "produces": ["application/json"], "operationId": "get_project_data_flow", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "put": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Update a data flow template", "produces": ["application/json"], "operationId": "update_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "UpdateDataFlowOptions", "type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "required": ["type"], "properties": {"type": {"$ref": "#/definitions/DataFlowTemplateVariable"}, "default_value": {}}}}, "template": {"$ref": "#/definitions/DataFlowTemplate"}, "public": {"type": "boolean"}}, "required": ["public", "name", "variables", "template"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "delete": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Delete a single data flow template", "produces": ["application/json"], "operationId": "delete_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/delete_token": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data flow template.", "produces": ["application/json"], "operationId": "create_project_data_flow_template_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/export.json": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Export a single data flow template", "produces": ["application/vnd.ibm.cps.df-template+json"], "operationId": "export_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/topology": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and get the resulting Knowledge Graph topology from it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "get_project_data_flow_template_topology", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "DataFlowTopologyOptions", "type": "object", "properties": {"variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/render": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "render_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RenderDataFlowTemplateOptions", "type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "properties": {"target_bag_key": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/raw_dataflow_templates/actions/run": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and run it.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "assemble_project_raw_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "RunDataFlowTemplateOptions", "type": "object", "required": ["data_flow", "variable_values", "log_task"], "properties": {"log_task": {"type": "boolean", "default": true}, "data_flow": {"type": "object", "properties": {"template": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["template", "variables"]}, "variable_values": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc/dataflow_templates/{df_tpl_key}/actions/load": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "Render a single data flow template, replacing the variable placeholders by their actual values and load it into a Knowledge Graph.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "load_project_data_flow_template_into_knowledge_graph", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "LoadDataFlowIntoKnowledgeGraphOptions", "type": "object", "properties": {"render": {"type": "object", "properties": {"target_bag": {"type": "object", "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string", "description": "If set, this will override the 'proj_key' parameter in the path, allowing cross-project KGs to be used."}}, "required": ["bag_key"]}, "variables": {"type": "object", "additionalProperties": {}}}, "required": ["target_bag", "variables"]}, "target": {"type": "object", "properties": {"save": {"type": "object"}}, "required": ["save"]}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/kgc_dataflow_templates/debug/{df_tpl_key}": {"post": {"tags": ["Data Flows"], "security": [{"Bearer": []}], "description": "(Debug) get the fully rendered data flow, with all the coordinates set.", "produces": ["application/json"], "consumes": ["application/json"], "operationId": "debug_project_data_flow_template", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "df_tpl_key", "in": "path", "required": true, "type": "string"}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "FullyRenderedDataFlow", "type": "object", "properties": {"target_bag": {"type": "object", "required": ["bag_key"], "properties": {"bag_key": {"type": "string"}, "proj_key": {"type": "string"}}}, "variables": {"type": "object", "additionalProperties": {}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/data_cataloges/known_schemas": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List System Known Data Catalog Schemas.", "produces": ["application/json"], "operationId": "list_known_data_catalog_schemas", "parameters": [], "responses": {"200": {"description": "List of Known Data Catalog Schemas.", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogSchema"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/data_catalogues/with_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues with specific schema", "produces": ["application/json"], "operationId": "list_data_catalogs_and_collections_from_schema", "parameters": [{"name": "proj_key", "in": "query", "type": "string", "required": false}, {"name": "schema", "x-body-name": "schema", "in": "body", "required": true, "schema": {"type": "object", "additionalProperties": {}}}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/data": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get Data Catalog Collection data.", "produces": ["application/json"], "operationId": "get_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 50, "required": false}], "responses": {"200": {"description": "Get Data Catalog Collection data."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_mongo": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/from_url": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a data catalogue from a URL to a file", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_from_url", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DataCatalogUrlImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Data catalogue created, and data is being imported.", "schema": {"$ref": "#/definitions/DataCatalogImportResult"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "CloneDataCatalogOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List data catalogues for a project", "produces": ["application/json"], "operationId": "list_project_data_catalogs", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create an empty data catalog", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogOptions", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "topology:data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "object", "additionalProperties": {}}}, "$ref": "#/definitions/DataCatalogTopology"}}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Data catalog created.", "schema": {"$ref": "#/definitions/DataCatalogue"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue that was made public", "produces": ["application/json"], "operationId": "get_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_public_data_catalog_collections", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}": {"delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog's collection", "produces": ["application/json"], "operationId": "delete_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/infer_schema": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Infer the schema for a data catalog's collection.", "produces": ["application/json"], "operationId": "infer_project_data_catalog_category_schema", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "InferProjectDataCatalogCategorySchema", "type": "object", "properties": {"sample_size": {"type": "integer", "minimum": 1, "maximum": 1000}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog collection. The collection will be created if it doesn't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogCollectionOptions", "minProperties": 1, "maxProperties": 1, "properties": {"ccs": {"type": "object", "properties": {"proj_key": {"type": "string"}, "auth_token": {"type": "string"}, "url": {"type": "string"}, "source_collection_name": {"type": "string"}, "export_package_mongo_options": {"type": "object", "required": ["assemble_options", "incremental", "package_options"], "properties": {"incremental": {"type": "boolean"}, "assemble_options": {"type": "object", "required": ["mode", "options"], "properties": {"mode": {"required": ["page_elements", "tables"], "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"}, "type": "array", "minItems": 2, "maxItems": 2}, "tables": {"description": "Which type of annotations to filter for the tables: H (human annotations), M (model generated)", "items": {"enum": ["H", "M"], "type": "string"}, "type": "array", "minItems": 2, "maxItems": 2}}, "type": "object"}, "options": {"required": ["include_incomplete_documents"], "properties": {"include_incomplete_documents": {"type": "boolean", "description": "Include documents with missing pages? (e.g. no annotations for some pages)"}}, "type": "object"}}}, "inputs": {"type": "object", "required": ["document_hashes"], "properties": {"document_hashes": {"type": "array", "default": [], "items": {"type": "string"}}}}, "package_options": {"type": "object", "properties": {"match_mode": {"type": "string", "default": "document_hash", "enum": ["use_fuzzy_search", "document_hash"]}, "redirect_keys_to_s3": {"type": "array", "default": [], "items": {"type": "string"}}}}}}}, "required": ["proj_key"]}, "url": {"type": "string"}, "elastic": {"title": "ImportFromElasticToDataCatalogOptions", "type": "object", "required": ["parameters"], "properties": {"coordinates": {"$ref": "#/definitions/ElasticCoordinates"}, "elastic_id": {"type": "string"}, "parameters": {"type": "object", "required": ["index", "query_options"], "properties": {"index": {"type": "string"}, "query_options": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "size": {"type": "number", "minimum": 0}, "query": {"type": "object", "additionalProperties": {}}}}, "import_s3_data": {"type": "boolean"}, "s3": {"title": "ImportFromElasticToDataCatalogS3Coords", "type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "key_prefix": {"type": "string"}, "location": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "key_prefix", "location"]}, "page_size": {"type": "number", "default": 100}}}}}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog's collection", "produces": ["application/zip", "application/json", "application/x-jsonlines"], "operationId": "export_project_data_catalog_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/upload": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Upload data to a data catalog. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/import": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Import data to a data catalog. The collections will be created if they don't exist.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImportToDataCatalogOptions", "minProperties": 1, "maxProperties": 1, "properties": {"url": {"type": "string"}, "coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/actions/export": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Export the contents of a data catalog.", "produces": ["application/zip"], "operationId": "export_project_data_catalog_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/delete_token": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a data catalog.", "produces": ["application/json"], "operationId": "create_project_data_catalog_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "List public data catalogues", "produces": ["application/json"], "operationId": "list_public_data_catalogs", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public data catalogues", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogue"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/public/data_catalogues/{dc_key}/actions/clone": {"post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Clone an existing public data catalogue", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_data_catalog", "parameters": [{"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "ClonePublicDataCatalogOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting data catalogue", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true, "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the catalog's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get a single data catalogue", "produces": ["application/json"], "operationId": "get_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "delete": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Delete a single data catalog", "produces": ["application/json"], "operationId": "delete_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "patch": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Update the metadata of a data catalog.", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "patch_project_data_catalog", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDataCatalogOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}}, "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/data_catalogues/{dc_key}/collections": {"get": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Get the collections of a data catalog.", "produces": ["application/json"], "operationId": "list_project_data_catalog_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Data catalog collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}}, "404": {"description": "Data catalogue not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}, "post": {"tags": ["Data Catalogs"], "security": [{"Bearer": []}], "description": "Create a collection in a data catalog", "produces": ["application/json"], "operationId": "create_project_data_catalog_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dc_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateDataCatalogCollectionOptions", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)+$", "maxLength": 24, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.catalogs_controller"}}, "/project/{proj_key}/tasks": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "List tasks for a project.", "produces": ["application/json"], "operationId": "list_project_tasks", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_type", "in": "query", "required": false, "type": "string"}, {"name": "limit", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 50}, {"name": "skip", "in": "query", "required": false, "type": "integer", "minimum": 0, "default": 0}, {"name": "sort_by", "in": "query", "required": false, "type": "string"}, {"name": "sort_order", "in": "query", "required": false, "type": "string", "default": "asc", "enum": ["asc", "desc"]}], "responses": {"200": {"description": "List of tasks.", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProjectTask"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}, {"KGAuth": []}], "description": "Get a task for a project.", "produces": ["application/json"], "operationId": "get_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/tasks/{task_id}/actions/abort": {"post": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Abort a task.", "produces": ["application/json"], "operationId": "abort_project_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"204": {"description": "Task aborted."}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/celery_tasks/{task_id}": {"get": {"tags": ["Tasks"], "security": [{"Bearer": []}], "description": "Get a celery task for a project.", "produces": ["application/json"], "operationId": "get_project_celery_task", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "Task", "schema": {"type": "object", "title": "CeleryTaskPromise", "required": ["task_id", "task_status", "result"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"x-nullable": true}}}}, "404": {"description": "Task not found.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/annotator/metadata": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get annotator's metadata", "produces": ["application/json", "text/html"], "operationId": "get_cached_annotator_metadata", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatorMetadata", "type": "object", "required": ["name", "version", "url", "author", "description"], "properties": {"name": {"type": "string"}, "version": {"type": "string"}, "url": {"type": "string"}, "author": {"type": "string"}, "description": {"type": "string"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/supported_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Get supported annotations for an annotator", "produces": ["application/json", "text/html"], "operationId": "get_project_annotator_supported_annotations", "x-swagger-router-controller": "api_server.controllers.annotate", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "in": "body", "schema": {"x-oneOf": [{"$ref": "#/definitions/AnnotatorSupportedAnnotationsParameters"}, {"$ref": "#/definitions/ModelSupportedAnnotationsParameters"}]}, "required": true}], "responses": {"200": {"description": "OK", "schema": {"title": "SupportedAnnotatorAnnotations", "type": "object", "required": ["entities", "relationships"], "properties": {"entities": {"type": "array", "items": {"title": "EntityAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "data_fields": {"type": "array", "items": {"type": "string"}, "uniqueItems": true}}, "required": ["key", "description"]}}, "relationships": {"type": "array", "items": {"title": "RelationshipAnnotationDescriptor", "type": "object", "properties": {"key": {"type": "string"}, "description": {"type": "string"}, "columns": {"type": "array", "items": {"type": "object", "title": "RelationshipAnnotationColumn", "properties": {"key": {"type": "string"}, "entities": {"type": "array", "items": {"type": "string"}}}, "required": ["key", "entities"]}}}, "required": ["key", "description", "columns"]}}, "supported_object_types": {"type": "array", "items": {"type": "string"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/object_annotations": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.\n*DEPRECATED*, please use generate_project_object_annotations_async instead.\n", "deprecated": true, "produces": ["application/json"], "operationId": "generate_project_object_annotations", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "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": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "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"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}}}}], "responses": {"200": {"description": "OK", "schema": {"title": "AnnotatedObject", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/object_annotations_async": {"post": {"tags": ["Annotate"], "security": [{"Bearer": []}], "description": "Run an annotator on an object, using resources from the project.", "produces": ["application/json"], "operationId": "generate_project_object_annotations_async", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"title": "AnnotateObjectOptions", "type": "object", "required": ["parameters", "input"], "properties": {"input": {"title": "AnnotatorInput", "type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"type": "string", "maxLength": 4500}, "table": {"type": "array", "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": {"type": "array", "items": {"title": "AnnotateTableCell", "type": "object", "required": ["bbox", "spans", "text", "type"], "properties": {"bbox": {"type": "array", "items": {"type": "number", "format": "double"}, "minItems": 4, "maxItems": 4}, "spans": {"type": "array", "description": "2-tuple representing the row:column where this cell spans to.", "items": {"type": "array", "items": {"type": "number", "format": "integer"}, "minItems": 2, "maxItems": 2}}, "text": {"type": "string"}, "type": {"title": "AnnotateTableCellType", "type": "string", "enum": ["col_header", "row_header", "body"]}}}}}, "image": {"title": "AnnotatorImageInput", "type": "object", "required": ["source"], "properties": {"source": {"title": "ImageSource", "type": "object", "minProperties": 1, "properties": {"scratch_id": {"type": "string"}, "proj_key": {"type": "string"}, "url": {"type": "string"}}}, "metadata": {"title": "ImageMetadata", "type": "object", "required": ["cells"], "properties": {"cells": {"title": "ImageCells", "type": "object", "required": ["data"], "properties": {"data": {"type": "array", "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"}]}}}, "info": {"title": "ImageInfo", "type": "object", "required": ["width", "height"], "properties": {"width": {"type": "number"}, "height": {"type": "number"}}}}}}}}}, "parameters": {"title": "AnnotatorParameters", "type": "object", "properties": {"type": {"type": "string"}}, "additionalProperties": {}, "required": ["type"]}, "proj_key": {"type": "string"}, "model_config_key": {"type": "string"}, "public": {"type": "boolean"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.annotate"}}, "/project/{proj_key}/scratch/files": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "scratch_ids", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}, "post": {"deprecated": true, "tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Upload a file to temporary storage", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "responses": {"200": {"description": "File uploaded", "schema": {"title": "UploadedFileResult", "type": "object", "required": ["id", "url"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "url": {"type": "string", "description": "URL to get the temporary file form."}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files_paginated": {"get": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Get paginated list of temporary files uploaded to a project", "produces": ["application/json"], "operationId": "list_project_scratch_files_paginated", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Files", "schema": {"type": "array", "items": {"title": "UploadedFile", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "filename": {"type": "string"}, "timestamp": {"type": "number"}}, "required": ["id", "proj_key", "user_key", "filename", "timestamp"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/scratch/files/upload/{filename}": {"post": {"tags": ["Uploads"], "security": [{"Bearer": []}], "description": "Create file pointers for temporary storage", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_scratch_file", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "filename", "in": "path", "required": true, "type": "string"}], "responses": {"201": {"description": "Temporary file details", "schema": {"title": "TemporaryUploadFileResult", "type": "object", "required": ["id", "upload", "download", "metadata", "upload_private", "download_private", "metadata_private"], "properties": {"id": {"type": "string", "description": "ID of the temporary file."}, "upload": {"type": "object", "description": "URL to upload the temporary file.", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "upload_private": {"type": "object", "description": "URL to upload the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}, "fields": {"type": "object"}}}, "download": {"type": "object", "description": "URL to get the temporary file.", "properties": {"url": {"type": "string"}}}, "download_private": {"type": "object", "description": "URL to get the temporary file. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}, "metadata": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method.", "properties": {"url": {"type": "string"}}}, "metadata_private": {"type": "object", "description": "URL to metadata of the temporary file using the HEAD HTTP method. (private URL, usable within the infrastracture)", "properties": {"url": {"type": "string"}}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.controller"}}, "/project/{proj_key}/default_values": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "get_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "List project's default values", "produces": ["application/json"], "operationId": "update_project_default_values", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "default_values", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectDefaultValues"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/integrations/{integration_name}": {"get": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Get the config for a given project integration", "produces": ["application/json"], "operationId": "get_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "decode_secrets", "in": "query", "type": "boolean", "description": "Project owners can retrieve decoded secrets", "default": false}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ProjectIntegrations"}}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Update the config for a given project integration", "produces": ["application/json"], "operationId": "update_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}, {"name": "config", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectIntegrations"}}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}, "delete": {"tags": ["Project"], "security": [{"Bearer": []}], "description": "Delete the config for a given project integration", "produces": ["application/json"], "operationId": "delete_project_integration_config", "x-swagger-router-controller": "api_server.controllers.controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "integration_name", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "500": {"description": "Error occured on the server", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/annotate/document": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Run an annotator on a document", "produces": ["application/json"], "operationId": "annotate_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotateDocumentRequest", "type": "object", "required": ["document", "text_annotators", "image_annotators", "table_annotators"], "properties": {"document": {"type": "object"}, "text_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "image_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "table_annotators": {"type": "array", "items": {"$ref": "#/definitions/AnnotatorParametersOrRef"}}, "use_cache": {"type": "boolean", "default": true}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/report": {"post": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Submit a report on an inspected document", "produces": ["application/json"], "operationId": "report_inspected_document", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "AnnotatedDocumentReport", "type": "object", "required": ["document", "report"], "properties": {"document": {"type": "object", "properties": {"input_scratch_id": {"type": "string"}, "output_scratch_id": {"type": "string"}}, "required": ["input_scratch_id", "output_scratch_id"]}, "document_conversion_parameters": {"type": "object"}, "document_annotation_parameters": {"type": "object"}, "report": {"type": "object", "properties": {"description": {"type": "string"}, "review_consent": {"type": "boolean"}}, "required": ["review_consent"]}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/results/{document_hash}": {"delete": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Delete annotation results for a document", "produces": ["application/json"], "operationId": "delete_document_annotation_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "document_hash", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "OK"}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/document/tasks/{task_id}": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get the result of a previous document annotation", "produces": ["application/json"], "operationId": "get_annotate_document_result", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "task_id", "in": "path", "required": true, "type": "string"}, {"name": "wait", "in": "query", "required": false, "type": "number", "minimum": 0, "maximum": 10, "description": "Allow the response to be delayed for a few seconds to wait for the result, instead of doing client-side polling."}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["task_id", "task_status", "result", "done"], "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "result": {"type": "object", "x-nullable": true}, "done": {"type": "boolean"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/annotate/inspection_report": {"get": {"tags": ["Document Inspection"], "security": [{"Bearer": []}], "description": "Get paginated list of inspection reports for a project", "produces": ["application/json"], "operationId": "list_project_inspection_report", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 20, "type": "integer"}, {"name": "search_string", "in": "query", "description": "search keyword", "required": false, "type": "string"}, {"name": "begin_date", "in": "query", "description": "begin date of the search date interval", "required": false, "type": "integer"}, {"name": "end_date", "in": "query", "description": "end date of the search date interval", "required": false, "type": "integer"}], "responses": {"200": {"description": "Reports", "schema": {"type": "array", "items": {"title": "InspectionReport", "type": "object", "properties": {"id": {"type": "string", "description": "ID of the inpection report."}, "proj_key": {"type": "string"}, "user_key": {"type": "string"}, "timestamp": {"type": "number"}, "document": {"type": "string"}}, "required": ["id", "proj_key", "user_key", "timestamp", "document"]}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/ingest/documentqa": {"post": {"deprecated": true, "tags": ["Document Inspection", "Semantic"], "security": [{"Bearer": []}], "description": "Ingest a document for QA", "produces": ["application/json"], "operationId": "ingest_documentqa", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "IngestDocumentQARequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "IngestDocumentQASourcePublicData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "IngestDocumentQASourcePrivateData", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}]}}, "required": ["source"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.document_inspect_controller"}}, "/project/{proj_key}/semantic/ingest": {"post": {"tags": ["Semantic"], "security": [{"Bearer": []}], "description": "Ingest documents and collections for RAG", "produces": ["application/json"], "operationId": "ingest", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "x-body-name": "body", "in": "body", "required": true, "schema": {"title": "SemanticIngestRequest", "type": "object", "properties": {"source": {"title": "Source", "x-anyOf": [{"title": "IngestDocumentQASourceUrl", "type": "object", "properties": {"type": {"title": "Type", "enum": ["url"], "type": "string"}, "url": {"title": "Url", "type": "string"}}, "required": ["type", "url"]}, {"title": "SemanticIngestSourcePublicDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["public_data_document"], "type": "string"}, "elastic_id": {"title": "Elastic Id", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "elastic_id", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataDocument", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_document"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}, "document_hash": {"title": "Document Hash", "type": "string"}}, "required": ["type", "proj_key", "index_key", "document_hash"]}, {"title": "SemanticIngestSourcePrivateDataCollection", "type": "object", "properties": {"type": {"title": "Type", "enum": ["private_data_collection"], "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "index_key": {"title": "Index Key", "type": "string"}}, "required": ["type", "proj_key", "index_key"]}]}, "parameters": {"title": "SemanticIngestReqParams", "type": "object", "properties": {"skip_ingested_docs": {"title": "Skip Ingested Docs", "type": "boolean"}}, "required": ["skip_ingested_docs"]}}, "required": ["source", "parameters"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Task"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.semantic_controller"}}, "/project/{proj_key}/dictionaries/from_mongo": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a dictionary from a mongo database", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "import_project_dictionary_from_mongo", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "DictionaryImportOptions", "type": "object", "properties": {"target": {"type": "object", "required": ["name", "description", "public"], "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}}, "options": {"type": "object", "required": ["coordinates"], "properties": {"coordinates": {"$ref": "#/definitions/MongoS3CoordinatesWithCollectionList"}}}}, "required": ["target", "options"]}}], "responses": {"200": {"description": "Dictionary created, and data is being imported.", "schema": {"title": "DictionaryImportResult", "type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "import_task": {"$ref": "#/definitions/Task"}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CloneDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}, "collections": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "description", "public"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List dictionaries for a project", "produces": ["application/json"], "operationId": "list_project_dictionaries", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create an empty dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateDictionaryOptions", "type": "object", "properties": {"public": {"type": "boolean"}, "name": {"type": "string", "pattern": "^(?:\\w| |-)+$"}, "description": {"type": "string", "x-nullable": true}}, "required": ["name", "description", "public"]}}], "responses": {"200": {"description": "Dictionary created.", "schema": {"$ref": "#/definitions/Dictionary"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary that was made public", "produces": ["application/json"], "operationId": "get_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_public_dictionary_collections", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary collection. The collection will be created if it doesn't exist.", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary's collection", "produces": ["application/zip", "application/json"], "operationId": "export_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "file_format", "in": "query", "type": "string", "required": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/upload": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Upload data to a dictionary. The collection name(s) will be inferred from the file name(s).", "consumes": ["multipart/form-data"], "produces": ["application/json"], "operationId": "upload_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "file", "in": "formData", "required": true, "type": "file"}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/actions/export": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Export the contents of a dictionary.", "produces": ["application/zip"], "operationId": "export_project_dictionary_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/delete_token": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a token used to confirm the deletion of a dictionary.", "produces": ["application/json"], "operationId": "create_project_dictionary_delete_token", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "List public dictionaries", "produces": ["application/json"], "operationId": "list_public_dictionaries", "parameters": [{"name": "query", "in": "query", "type": "string", "required": false}], "responses": {"200": {"description": "List of public dictionaries", "schema": {"type": "array", "items": {"$ref": "#/definitions/Dictionary"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/public/dictionaries/{dict_key}/actions/clone": {"post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Clone an existing public dictionary", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "clone_public_dictionary", "parameters": [{"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "ClonePublicDictionaryOptions", "type": "object", "properties": {"proj_key": {"description": "The project key of the project to store the resulting dictionary", "type": "string"}, "public": {"type": "boolean"}, "name": {"type": "string", "x-nullable": true}, "description": {"type": "string", "x-nullable": true}, "collections": {"type": "array", "items": {"type": "string"}}, "copy_s3": {"type": "boolean", "description": "Should the dictionary's S3 data also be copied?", "default": true}}, "required": ["name", "description", "public", "proj_key"]}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a single dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary", "produces": ["application/json"], "operationId": "delete_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "confirmation_token", "in": "query", "type": "string", "required": true}], "responses": {"204": {"description": "Dictionary deleted."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the metadata of a dictionary", "produces": ["application/json"], "operationId": "update_project_dictionary", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "options", "x-body-name": "options", "in": "body", "required": true, "schema": {"type": "object", "title": "PatchDictionaryOptions", "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}}, "additionalProperties": false}}], "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"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get the collections of a dictionary.", "produces": ["application/json"], "operationId": "list_project_dictionary_collections", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "Dictionary collections", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "post": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Create a collection in a dictionary", "produces": ["application/json"], "operationId": "create_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateCollectionInDictionaryOptions", "type": "object", "properties": {"collection_name": {"type": "string", "pattern": "^(?:\\w|-)(?:\\w|\\s|-)*(?:\\w|-)$", "maxLength": 50, "minLength": 4}}, "required": ["collection_name"]}}], "responses": {"200": {"description": "Collection created."}, "404": {"description": "Dictionary doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}": {"delete": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Delete a single dictionary's collection", "produces": ["application/json"], "operationId": "delete_project_dictionary_collection", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "required": true, "type": "string"}, {"name": "collection_name", "in": "path", "type": "string", "required": true}], "responses": {"204": {"description": "Collection deleted."}, "404": {"description": "Collection doesn't exist.", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/dictionaries/{dict_key}/collections/{collection_name}/data": {"get": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Get a preview of the data in a dictionary", "produces": ["application/json"], "operationId": "get_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "after", "in": "query", "type": "string", "pattern": "[a-zA-Z0-9]{24}", "required": false}, {"name": "limit", "in": "query", "type": "integer", "minimum": 0, "default": 1000, "required": false}, {"name": "response_format", "in": "query", "type": "string", "default": "object", "required": false}], "responses": {"200": {"description": "Dictionary collection contents.", "schema": {"x-oneOf": [{"$ref": "#/definitions/DictionaryCollectionObjectData"}, {"$ref": "#/definitions/DictionaryCollectionCsvData"}]}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}, "patch": {"tags": ["Dictionaries"], "security": [{"Bearer": []}], "description": "Update the data in a dictionary's collection", "produces": ["application/json"], "operationId": "update_project_dictionary_collection_data", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "dict_key", "in": "path", "type": "string", "required": true}, {"name": "collection_name", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "description": "A subset of JSON Patch operation list. Only `add`, `replace`, and `remove` is supported.\nSee http://jsonpatch.com/ for more details.\n", "schema": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollectionPatch"}}}], "responses": {"204": {"description": "Data updated."}, "404": {"description": "Dictionary not found", "schema": {"$ref": "#/definitions/Problem"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.dicts_controller"}}, "/project/{proj_key}/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List Model Configurations for a project", "produces": ["application/json"], "operationId": "list_project_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}, "post": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Create a Model Configuration", "consumes": ["application/json"], "produces": ["application/json"], "operationId": "create_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "body", "in": "body", "required": true, "schema": {"title": "CreateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"public": {"type": "boolean"}, "name": {"pattern": "^(?:\\w| |-)+$", "type": "string"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}, "model_config_key": {"type": "string"}}, "required": ["name", "description", "public", "configurations"]}}], "responses": {"200": {"description": "Model Configuration created.", "schema": {"$ref": "#/definitions/ModelConfiguration"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/{proj_key}/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration", "produces": ["application/json"], "operationId": "read_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}}, "patch": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Update a single Model Configuration", "produces": ["application/json"], "operationId": "update_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}, {"name": "body", "in": "body", "required": true, "schema": {"title": "UpdateProjectModelConfigOptions", "type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "public": {"type": "boolean"}, "description": {"type": "string", "x-nullable": true}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"]}}, "required": ["name", "description", "public", "configurations"]}}], "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"}}}}, "delete": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Delete a single Model Configuration", "produces": ["application/json"], "operationId": "delete_project_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}, {"name": "model_config_key", "in": "path", "required": true, "type": "string"}], "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"}}}}}, "/project/public/model_configs": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List public Model Configurations", "produces": ["application/json"], "operationId": "list_public_model_configs", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [], "responses": {"200": {"description": "List of public Model Configurations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/project/public/model_configs/{model_config_key}": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "Get a single Model Configuration that was made public", "produces": ["application/json"], "operationId": "read_public_model_config", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "model_config_key", "in": "path", "type": "string", "required": true}, {"name": "include_collections", "in": "query", "type": "boolean", "required": false, "default": false}], "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"}}}}}, "/project/{proj_key}/models": {"get": {"tags": ["Model Configurations"], "security": [{"Bearer": []}], "description": "List models with the supported annotations for a project", "produces": ["application/json"], "operationId": "get_project_models_with_supported_annotations", "x-swagger-router-controller": "api_server.controllers.model_configs_controller", "parameters": [{"name": "proj_key", "in": "path", "type": "string", "required": true}], "responses": {"200": {"description": "List of Models with the supported annotations", "schema": {"type": "array", "items": {"$ref": "#/definitions/ModelConfiguration"}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}, "/processing_models/docs_graph_with_databases": {"post": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "consumes": ["application/json"], "produces": ["application/json"], "description": "Create a Data Flow from a list of CCS Collections and CPS Models.", "operationId": "create_data_flow_from_df_wizard", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"type": "object", "required": ["ccs_document_collections", "catalog_document_collections", "models", "access_token"], "properties": {"access_token": {"type": "string"}, "ccs_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CcsCollectionReference"}}, "models": {"type": "array", "items": {"$ref": "#/definitions/CpsModelReference"}}, "entity_mappings": {"$ref": "#/definitions/EntityMapping"}, "catalog_document_collections": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}, "data_catalogs": {"type": "array", "items": {"$ref": "#/definitions/CatalogReference"}}}}}], "responses": {"200": {"description": "Processing model generated successfully", "schema": {"$ref": "#/definitions/ProcessingModel"}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}, "x-swagger-router-controller": "api_server.controllers.processing_model_controller"}}, "/processing_models": {"get": {"tags": ["Processing Model"], "security": [{"Bearer": []}], "produces": ["application/json"], "description": "List the available processing models.", "operationId": "get_processing_models", "x-swagger-router-controller": "api_server.controllers.processing_model_controller", "responses": {"200": {"description": "List of processing models and their description", "schema": {"type": "object", "required": ["processing_models"], "properties": {"processing_models": {"type": "array", "items": {"$ref": "#/definitions/ProcessingModelDescription"}}}}}, "default": {"description": "Unexpected error.", "schema": {"$ref": "#/definitions/Problem"}}}}}}, "definitions": {"TokenResponse": {"type": "object", "properties": {"token": {"type": "string"}}, "required": ["token"]}, "ProjectDataIndexWithStatus": {"title": "ProjectDataIndexWithStatus", "description": "Project data index with elastic status", "type": "object", "properties": {"source": {"title": "ProjectDataIndexSource", "type": "object", "properties": {"proj_key": {"type": "string"}, "index_key": {"type": "string"}}, "required": ["proj_key", "index_key"]}, "name": {"type": "string"}, "description": {"type": "string"}, "schema_key": {"type": "string", "description": "Index's schema key", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}, "type": {"type": "string", "description": "Index type, user friendly format", "enum": ["View", "Document", "DB Record", "Generic", "Experiment"]}, "view_of": {"type": "object", "properties": {"index_key": {"type": "string"}, "elastic_id": {"type": "string"}, "proj_key": {"type": "string"}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "creation_date": {"type": "string"}, "record_properties": {"$ref": "#/definitions/ElasticIndexProperties"}, "provenance": {"type": "string"}}, "required": ["source", "name", "description", "type", "documents", "health", "status", "creation_date"]}, "ProjectDataIndexNonView": {"title": "ProjectDataIndexNonView", "description": "Object to create a project data index", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the Index", "minLength": 1, "maxLength": 254}, "schema_key": {"type": "string", "description": "Schema key", "minLength": 1, "maxLength": 64, "default": "generic", "enum": ["deepsearch-doc", "deepsearch-db", "generic"]}}, "required": ["name"]}, "ProjectDataIndexView": {"title": "ProjectDataIndexView", "description": "Object to create a project data index view", "type": "object", "properties": {"name": {"type": "string", "description": "Name of the data index view", "minLength": 1, "maxLength": 64}, "description": {"type": "string", "description": "Description of the index view", "minLength": 1, "maxLength": 254}, "view_of": {"type": "object", "title": "ProjectDataIndexViewOf", "properties": {"instance_id": {"type": "string", "description": "Instance id key, if the source is a data asset", "minLength": 1, "maxLength": 64}, "proj_key": {"type": "string", "description": "Project id key, if the source is a project data index", "minLength": 1, "maxLength": 64}, "index_key": {"type": "string", "description": "Data index key", "minLength": 1, "maxLength": 64}, "query_options": {"$ref": "#/definitions/ElasticIndexSearchQueryOptions"}}, "required": ["index_key", "query_options"]}}, "required": ["name", "view_of"]}, "ProjectDataIndexConversionSettings": {"title": "ProjectDataIndexConversionSettings", "description": "Specify the conversion settings to use.", "type": "object", "properties": {"type": {"title": "Type", "type": "string", "default": "direct", "enum": ["direct"]}, "ocr": {"type": "object", "title": "OCR Settings", "properties": {"enabled": {"title": "Enabled", "type": "boolean", "default": false}, "backend": {"title": "Backend", "type": "string"}, "backend_settings": {"title": "Backend Settings", "type": "object"}, "merge_mode": {"title": "Merge Mode", "type": "string"}}}, "assemble": {"title": "Assemble Settings", "type": "object", "required": ["mode", "include_incomplete_documents"], "properties": {"mode": {"type": "object", "required": ["page_elements", "tables"], "properties": {"page_elements": {"title": "Page Elements", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}, "tables": {"title": "Tables", "type": "array", "items": {"type": "string", "enum": ["H", "M", "None"]}}}}, "include_incomplete_documents": {"title": "Include Incomplete Documents", "type": "boolean"}}}, "metadata": {"title": "Collection Metadata Settings", "type": "object", "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"}}}, "page_labels": {"title": "Page Labels", "type": "object"}, "model_pipeline": {"title": "Model Pipeline Settings", "type": "object", "required": ["clusters", "page", "tables", "normalization"], "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"}]}, "page": {"title": "Page", "x-oneOf": [{"type": "object", "description": "Reference to a model configuration", "required": ["model_config_key", "proj_key"], "properties": {"model_config_key": {"title": "Model Config Key", "type": "string"}, "proj_key": {"title": "Proj Key", "type": "string"}, "name": {"title": "Name", "type": "string"}, "description": {"title": "Description", "type": "string"}}}, {"type": "object", "description": "Direct configuration of a model", "required": ["type", "config"], "properties": {"type": {"title": "Type", "type": "string"}, "config": {"title": "Config", "type": "string"}}}]}, "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"}]}, "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"}]}}}}}, "ProjectDataIndexS3Coordinates": {"title": "ProjectDataIndexCOSCoordinates", "description": "Coordinates to COS", "type": "object", "properties": {"host": {"title": "host", "type": "string"}, "port": {"title": "port", "type": "number"}, "ssl": {"title": "ssl", "type": "boolean"}, "verify_ssl": {"title": "verify_ssl", "type": "boolean"}, "access_key": {"title": "access_key", "type": "string"}, "secret_key": {"title": "secret_key", "type": "string"}, "bucket": {"title": "bucket", "type": "string"}, "location": {"title": "location", "type": "string"}, "key_prefix": {"title": "key_prefix", "type": "string"}}, "required": ["host", "port", "ssl", "verify_ssl", "access_key", "secret_key", "bucket", "location"]}, "error_response": {"type": "object", "properties": {"error_message": {"type": "string"}, "error_code": {"type": "string", "x-nullable": true}}, "required": ["error_message"]}, "Problem": {"type": "object", "properties": {"type": {"type": "string"}, "title": {"type": "string"}, "detail": {"type": "string"}, "status": {"type": "integer"}}, "additionalProperties": {}, "example": {"type": "ExampleError", "title": "An example title", "detail": "A descriptive message.", "status": 500, "may_have_extra_fields": true}}, "Bag": {"type": "object", "required": ["proj_key", "bag_key", "name", "slug", "timestamp", "bag_domain", "flavour", "bag_url", "public", "_svc_endpoint", "token"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "public": {"type": "boolean"}, "_svc_endpoint": {"type": "string"}, "token": {"type": "string"}}}, "BagFlavour": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}, "BagFlavourDefaultQuota": {"title": "BagFlavourDefaultQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "default_quota": {"type": "number"}}, "required": ["name", "display_name"]}, "BagFlavourFullData": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}, "is_from_deployment": {"type": "boolean"}, "project_specific": {"type": "boolean"}, "default_quota": {"type": "integer"}, "order": {"type": "number"}, "backend": {"type": "string"}, "config": {"type": "object"}}, "required": ["display_name", "description", "project_specific", "backend", "config"]}, "ProjectsFlavours": {"type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "flavours": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}}, "required": ["name"]}}}, "required": ["proj_key", "name", "flavours"]}, "ProjectsFlavoursQuota": {"title": "ProjectsFlavoursQuota", "type": "object", "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "quotas": {"type": "array", "items": {"$ref": "#/definitions/FlavoursQuota"}}}, "required": ["proj_key", "name", "quotas"]}, "FlavoursQuota": {"title": "FlavoursQuota", "type": "object", "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "quota": {"type": "integer"}}, "required": ["name", "display_name"]}, "SystemInfo": {"type": "object", "properties": {"allow_non_admins_to_make_resources_public": {"type": "boolean"}, "deployment": {"type": "object", "properties": {"name": {"type": "string"}, "disclaimer": {"type": "string"}, "should_show_warning": {"type": "boolean"}, "disable_kg_actions": {"type": "boolean"}, "linked_ccs_api": {"type": "object", "properties": {"uri": {"type": "string"}, "project_sync": {"type": "boolean"}}}}}, "toolkit": {"type": "object", "properties": {"name": {"type": "string"}, "host": {"type": "string"}, "verify_ssl": {"type": "boolean"}, "cli_command": {"type": "string"}, "required_version": {"type": "string", "x-nullable": true}}}, "api": {"type": "object", "properties": {"version": {"type": "string"}, "commit_hash": {"type": "string"}, "build_date": {"type": "integer"}}}}}, "SystemModulesConfiguration": {"type": "object", "required": ["df_template_variables", "linked_ccs_instances", "linked_elastic_instances"], "properties": {"df_template_variables": {"type": "array", "items": {"type": "object", "title": "WellKnownDfTemplateVariable", "required": ["description", "id", "type"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}, "type": {"$ref": "#/definitions/DataFlowTemplateVariable"}}}}, "linked_ccs_instances": {"type": "array", "items": {"type": "object", "title": "LinkedCcsInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}, "linked_elastic_instances": {"type": "array", "items": {"type": "object", "title": "LinkedElasticInstances", "required": ["description", "id"], "properties": {"description": {"type": "string"}, "id": {"type": "string"}}}}}}, "SystemModulesTasks": {"type": "object", "properties": {"tasks": {"type": "object", "additionalProperties": {"type": "object", "properties": {"schema": {"type": "object"}}}}}}, "BagCallback": {"type": "object", "properties": {"callback_url": {"type": "string"}}}, "KgcDataInput": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object", "additionalProperties": {}, "properties": {"config": {"type": "object", "additionalProperties": {}, "properties": {"coordinates": {"type": "object", "additionalProperties": {}, "properties": {"source": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}, "target": {"type": "object", "additionalProperties": {}, "properties": {"type": {"type": "string", "default": "bag", "enum": ["raw", "bag", "catalogue"]}, "bag_key": {"type": "string"}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection": {"type": "string"}, "public": {"type": "boolean"}}}}}}, "required": ["coordinates"]}}, "required": ["config"]}}}, "required": ["config", "data-flow"]}, "LoadKgcDataInput": {"type": "object", "properties": {"dataflow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}}, "target": {"type": "object", "properties": {"bag_key": {"type": "string"}, "save": {"type": "object"}}, "required": ["bag_key", "save"]}}, "required": ["dataflow", "target"]}, "Task": {"type": "object", "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}, "task_status": {"type": "string"}, "proj_key": {"type": "string"}, "error_reason": {"type": "string", "x-nullable": true}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}, "related_tasks": {"type": "array", "items": {"title": "RelatedTask", "type": "object", "required": ["task_id", "task_type"], "properties": {"task_id": {"type": "string"}, "task_type": {"type": "string"}}}}}, "required": ["task_id", "task_type", "task_status", "proj_key", "error_reason", "kind"]}, "CcsTask": {"title": "CcsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "ccs_project_key": {"type": "string"}, "ccs_collection_name": {"type": "string"}}, "required": ["task_id", "ccs_project_key", "ccs_collection_name"]}, "CpsTask": {"title": "CpsTask", "type": "object", "properties": {"task_id": {"type": "string"}, "task_status": {"type": "string"}, "task_type": {"type": "string"}}, "required": ["task_id", "task_status", "task_type"]}, "StorageSummaryTask": {"type": "object", "properties": {"task_id": {"type": "string"}, "proj_key": {"type": "string"}, "kg_key": {"type": "string"}, "dc_key": {"type": "string"}, "kind": {"type": "string", "enum": ["project_task", "celery_task"]}}, "required": ["task_id", "proj_key", "kind"]}, "StorageSummaryKG": {"type": "object", "properties": {"bag_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}, "categories_fraction": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "percentage": {"type": "number"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "color": {"type": "string"}}, "required": ["name", "percentage", "size_bytes_db", "size_converted_db"]}}}, "required": ["bag_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3", "categories_fraction"]}, "StorageSummaryDC": {"type": "object", "properties": {"dc_key": {"type": "string"}, "name": {"type": "string"}, "size_bytes_db": {"type": "number"}, "size_converted_db": {"type": "string"}, "size_bytes_s3": {"type": "number"}, "size_converted_s3": {"type": "string"}}, "required": ["dc_key", "name", "size_bytes_db", "size_converted_db", "size_bytes_s3", "size_converted_s3"]}, "DataCatalogue": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogCollection"}}, "topology": {"$ref": "#/definitions/DataCatalogTopology"}, "category_schemas": {"type": "array", "items": {"type": "object", "title": "DataCatalogCategorySchema", "required": ["key", "schema"], "properties": {"key": {"type": "string"}, "schema": {"type": "object", "additionalProperties": {}}}}}, "collections_data_flows": {"type": "array", "items": {"type": "object", "title": "DataCatalogDataFlow", "required": ["key", "data_flows"], "properties": {"key": {"type": "string"}, "data_flows": {"type": "array", "items": {"type": "object"}}}}}, "provenance_logs": {"type": "array", "items": {"type": "object", "title": "DataCatalogProvenanceLog", "required": ["user", "timestamp", "collection_name", "source"], "properties": {"user": {"type": "object", "title": "DataCatalogProvenanceLogUser", "properties": {"user_key": {"type": "string"}, "name": {"type": "string"}, "email": {"type": "string"}}, "required": ["user_key", "name", "email"]}, "timestamp": {"type": "number"}, "collection_name": {"type": "string", "x-nullable": true}, "source": {"type": "object", "title": "DataCatalogProvenanceLogSource", "x-nullable": true, "properties": {"elastic": {}, "mongo_s3": {}, "file": {}, "url": {}, "clone": {}, "ccs": {}}}}}}}, "required": ["name", "description", "dc_key", "proj_key", "created_by", "created_at", "copy_of", "public", "topology", "category_schemas", "collections_data_flows", "provenance_logs"]}, "DataCatalogSchema": {"type": "object", "properties": {"name": {"type": "string"}, "schema": {"type": "string"}}}, "DataCatalogCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "CloneDataCatalogResult": {"type": "object", "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "clone_task": {"$ref": "#/definitions/Task"}}, "required": ["data_catalogue", "clone_task"]}, "ProjectTask": {"type": "object", "properties": {"proj_key": {"type": "string"}, "user_key": {"type": "string"}, "task_type": {"type": "string"}, "task_id": {"type": "string"}, "task_status": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "started_at": {"type": "number", "format": "double", "x-nullable": true}, "completed_at": {"type": "number", "format": "double", "x-nullable": true}, "progress": {"type": "number", "format": "double"}, "meta": {"type": "object"}}}, "BagComponentStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "start_time": {"type": "number", "format": "double", "x-nullable": true}}, "required": ["status", "start_time"]}, "BagStatus": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "components": {"type": "object", "properties": {"kg": {"description": "Status of the Knowledge Graph and its API", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_api": {"description": "Status of the Erlenmeyer API for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}, "erlenmeyer_ui": {"description": "Status of the Erlenmeyer UI for this Graph", "allOf": [{"$ref": "#/definitions/BagComponentStatus"}]}}, "required": ["kg", "erlenmeyer_api", "erlenmeyer_ui"]}}, "required": ["status", "components"]}, "BagComponentStatusEnum": {"type": "string", "enum": ["LAUNCHING", "READY", "BUSY", "SUSPENDED", "SUSPENDING", "ERROR", "PROVISIONING", "PROVISIONING_FAILED", "UNKNOWN", "CHECKING", "PENDING_RESOURCES", "IDLE"]}, "DataFlowTemplate": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "DataFlowTemplateListItem": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlow": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string"}, "variables": {"type": "object", "additionalProperties": {"type": "object"}}, "template": {"type": "object"}, "proj_key": {"type": "string"}, "df_tpl_key": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "updated_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}}}, "DataFlowTemplateVariable": {"type": "string", "enum": ["string", "boolean", "number", "integer", "DataCatalogId", "DictionaryId", "KnowledgeGraphId", "ModelConfigurationId", "file", "SecretString", "ElasticId", "DataCatalogCollection", "DictionaryCollection", "KnowledgeGraphCollection", "CcsCollection", "DocumentSources"]}, "TakeSnapshotSettings": {"type": "object", "properties": {"flavour": {"type": "string"}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["flavour"]}, "KgSnapshot": {"type": "object", "properties": {"timestamp": {"type": "number", "format": "double"}, "data_flow": {"type": "object", "x-nullable": true}, "project_task_id": {"type": "string"}, "task_type": {"type": "string"}, "name": {"type": "string"}, "is_current": {"type": "boolean"}}}, "S3CoordinatesWithBackupKey": {"type": "object", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "backup_key": {"type": "string"}, "presigned": {"type": "object", "properties": {"url": {"type": "string"}, "fields": {"type": "object", "additionalProperties": {}}}, "required": ["url", "fields"]}}, "required": ["bucket", "backup_key"]}, "MongoCoordinates": {"type": "object", "properties": {"uri": {"type": "string"}, "database": {"type": "string"}}, "required": ["uri", "database"]}, "S3Coordinates": {"type": "object", "description": "If provided, the S3 data will be copied", "properties": {"host": {"type": "string"}, "port": {"type": "integer"}, "ssl": {"type": "boolean"}, "verifySSL": {"type": "boolean"}, "access-key": {"type": "string"}, "secret-key": {"type": "string"}, "bucket": {"type": "string"}, "location": {"type": "string"}, "key_prefix": {"type": "string"}}, "required": ["host", "port", "ssl", "verifySSL", "access-key", "secret-key", "bucket", "location", "key_prefix"]}, "MongoS3Coordinates": {"type": "object", "properties": {"mongo": {"$ref": "#/definitions/MongoCoordinates"}, "s3": {"$ref": "#/definitions/S3Coordinates"}}}, "CollectionListCoordinates": {"type": "object", "properties": {"collections": {"type": "array", "items": {"type": "string"}}}}, "MongoS3CoordinatesWithCollectionList": {"allOf": [{"$ref": "#/definitions/MongoS3Coordinates"}, {"$ref": "#/definitions/CollectionListCoordinates"}]}, "CpsPackage": {"type": "object", "properties": {"name": {"type": "string"}, "package_id": {"type": "string"}, "description": {"type": "string"}, "type": {"type": "string", "enum": ["model", "dictionary", "knowledge_graph", "data_catalog", "data_flow", "bundle"]}, "dependencies": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "package_id", "description", "type", "dependencies"]}, "EntityAnnotation": {"type": "object", "properties": {"match": {"type": "string"}, "range": {"type": "array", "description": "2-Tuple representing the low and high indexes of the matching substring", "items": {"type": "integer"}, "minItems": 2, "maxItems": 2}, "subtype": {"type": "string"}, "type": {"type": "string"}}, "required": ["match", "range", "type"]}, "RelationshipAnnotation": {"type": "object"}, "ObjectPropertyMap": {"type": "object"}, "AnnotatedText": {"type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedTable": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedImage": {"type": "object", "required": ["entities", "relationships", "properties"], "properties": {"text": {"type": "string"}, "entities": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}, "relationships": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}, "properties": {"$ref": "#/definitions/ObjectPropertyMap"}}}, "AnnotatedObject": {"type": "object", "minProperties": 1, "maxProperties": 1, "properties": {"text": {"title": "AnnotatedTextLines", "type": "object", "required": ["text", "entities", "relationships", "properties"], "properties": {"text": {"description": "Input text after clean up. The annotation indexes will be based on this text and not the input text.", "type": "string"}, "entities": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/EntityAnnotation"}}}}, "relationships": {"type": "array", "description": "One item per line on the original text.", "items": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/RelationshipAnnotation"}}}}, "properties": {"type": "array", "description": "One item per line on the original text.", "items": {"$ref": "#/definitions/ObjectPropertyMap"}}}}, "table": {"$ref": "#/definitions/AnnotatedTable"}, "image": {"$ref": "#/definitions/AnnotatedImage"}}}, "TopologyNode": {"type": "object", "properties": {"name": {"type": "string"}}, "required": ["name"]}, "TopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "source", "target"]}, "Topology": {"type": "object", "properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/TopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/TopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogTopologyNode": {"properties": {"name": {"type": "string"}, "data-fields": {"type": "array", "items": {"type": "string"}}}, "required": ["name", "data-fields"]}, "DataCatalogTopologyEdge": {"type": "object", "properties": {"name": {"type": "string"}, "source": {"type": "array", "items": {"type": "string"}}, "target": {"type": "array", "items": {"type": "string"}}, "source_field": {"type": "string"}, "target_field": {"type": "string"}}, "required": ["name", "source", "target", "source_field", "target_field"]}, "DataCatalogTopology": {"properties": {"categories": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyNode"}}, "edges": {"type": "array", "items": {"$ref": "#/definitions/DataCatalogTopologyEdge"}}}, "required": ["categories", "edges"]}, "DataCatalogImportResult": {"type": "object", "required": ["data_catalogue", "import_task"], "properties": {"data_catalogue": {"$ref": "#/definitions/DataCatalogue"}, "import_task": {"$ref": "#/definitions/Task"}}}, "ElasticCoordinates": {"type": "object", "required": ["hosts"], "properties": {"hosts": {"type": "array", "items": {"type": "string"}}, "ca_certificate_base64": {"type": "string"}, "dangerously_disable_ssl_validation": {"type": "boolean"}}}, "ModelConfiguration": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "public": {"type": "boolean"}, "configurations": {"type": "object", "properties": {"type": {"type": "string"}}, "required": ["type"], "additionalProperties": {}}, "supported_annotations": {"type": "object"}}, "required": ["name", "description", "model_config_key", "proj_key", "created_by", "created_at", "public"]}, "DictionaryCollectionObjectData": {"title": "DictionaryCollectionObjectData", "type": "array", "items": {"title": "DictionaryEntryWithId", "properties": {"_id": {"type": "string"}}, "required": ["_id"], "allOf": [{"$ref": "#/definitions/DictionaryEntry"}]}}, "DictionaryCollectionCsvData": {"title": "DictionaryCollectionCsvData", "type": "object", "properties": {"header": {"type": "string"}, "body": {"type": "string"}}, "required": ["header", "body"]}, "ProjectDefaultValues": {"type": "object", "properties": {"ccs_project": {"type": "object", "required": ["proj_key", "name"], "properties": {"proj_key": {"type": "string"}, "name": {"type": "string"}, "collection_name": {"type": "string"}}}, "dataflow": {"type": "object", "required": ["df_tpl_key", "name"], "properties": {"df_tpl_key": {"type": "string"}, "name": {"type": "string"}}}}}, "ProjectIntegrations": {"x-anyOf": [{"title": "Genai", "x-anyOf": [{"title": "GenAIWatsonx", "description": "GenAI integration for watsonx settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "watsonx", "const": "watsonx", "type": "string"}, "config": {"title": "GenAIWatsonxConfig", "description": "Config for watsonx", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_PROJECT_ID": {"title": "Project Id", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "project_id", "apikey"]}}, "required": ["config"]}, {"title": "GenAIBAM", "description": "GenAI integration for BAM settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "bam", "const": "bam", "type": "string"}, "config": {"title": "GenAIBAMConfig", "description": "Config for BAM", "type": "object", "properties": {"GENAI_API": {"title": "Endpoint", "type": "string"}, "GENAI_KEY": {"title": "Apikey", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["endpoint", "apikey"]}}, "required": ["config"]}, {"title": "GenAIHFInferenceApi", "description": "GenAI integration for Inference API settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "hf_api", "const": "hf_api", "type": "string"}, "config": {"title": "GenAIHFInferenceApiConfig", "description": "Config for HF Inference API", "type": "object", "properties": {"GENAI_HF_API_KEY": {"title": "Genai Hf Api Key", "type": "string", "writeOnly": true, "format": "password"}}, "required": ["GENAI_HF_API_KEY"]}}, "required": ["config"]}, {"title": "GenAIAWSBedrock", "description": "GenAI integration for AWS Bedrock settings", "type": "object", "properties": {"kind": {"title": "Kind", "default": "aws_bedrock", "const": "aws_bedrock", "type": "string"}, "config": {"title": "GenAIAWSBedrockConfig", "description": "Config for AWS Bedrock", "type": "object", "properties": {"GENAI_AWS_ACCESS_KEY": {"title": "Genai Aws Access Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_SECRET_KEY": {"title": "Genai Aws Secret Key", "type": "string", "writeOnly": true, "format": "password"}, "GENAI_AWS_REGION_NAME": {"title": "Genai Aws Region Name", "type": "string"}}, "required": ["GENAI_AWS_ACCESS_KEY", "GENAI_AWS_SECRET_KEY", "GENAI_AWS_REGION_NAME"]}}, "required": ["config"]}]}]}, "BagBackendAware": {"type": "object", "required": ["proj_key", "bag_key", "name", "description", "slug", "timestamp", "backend", "public"], "properties": {"proj_key": {"type": "string"}, "bag_key": {"type": "string"}, "name": {"type": "string"}, "description": {"type": "string"}, "slug": {"type": "string"}, "timestamp": {"type": "number", "format": "double"}, "backend": {"type": "object", "title": "BagBackends", "properties": {"kg_legacy_api": {"type": "object", "title": "BagKgLegacyApiBackend", "properties": {"bag_domain": {"type": "string"}, "flavour": {"type": "string"}, "bag_url": {"type": "string"}, "token": {"type": "string"}, "_svc_endpoint": {"type": "string"}}}, "kg_amqp": {"type": "object", "title": "BagAmqpBackend", "properties": {"flavour": {"type": "string"}}}}}, "public": {"type": "boolean"}, "last_coords_resolution": {"type": "number"}}}, "TakeSnapshotSettingsBackendAware": {"type": "object", "properties": {"backend_flavours": {"type": "object", "title": "BackendFlavour", "properties": {"kg_amqp": {"type": "string"}, "kg_legacy_api": {"type": "string"}}}, "name": {"type": "string"}, "load_into_kg_after_created": {"type": "boolean", "default": false}}, "required": ["backend_flavours"]}, "BagStatusBackendAware": {"type": "object", "properties": {"overall_status": {"$ref": "#/definitions/BagComponentStatusEnum"}, "kg_amqp": {"type": "object", "properties": {"status": {"$ref": "#/definitions/BagComponentStatusEnum"}}, "required": ["status"]}, "kg_legacy_api": {"$ref": "#/definitions/BagStatus"}}, "required": ["overall_status"]}, "AnnotatorSupportedAnnotationsParameters": {"type": "object", "properties": {"annotator": {"type": "string"}, "annotator_settings": {"type": "object"}}, "required": ["annotator"]}, "ModelSupportedAnnotationsParameters": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}, "required": ["model_config_key", "proj_key", "public"]}, "ElasticIndexSearchQueryOptions": {"type": "object", "properties": {"_source": {"type": "array", "items": {"type": "string"}}, "from": {"type": "number", "minimum": 0}, "size": {"type": "number", "minimum": 0, "maximum": 10000}, "query": {"type": "object", "additionalProperties": {}}, "aggs": {"type": "object"}, "sort": {"type": "array", "items": {"type": "object"}}}}, "ElasticIndexProperties": {"type": "object"}, "KibanaSavedQueriesResult": {"type": "object", "properties": {"description": {"type": "string"}, "fields": {"type": "array", "items": {"type": "string"}}, "query": {"type": "string"}, "title": {"type": "string"}}}, "AnnotatorParametersOrRef": {"type": "object", "properties": {"type": {"type": "string"}, "model_config_key": {"type": "string"}, "proj_key": {"type": "string"}, "public": {"type": "boolean"}}}, "DataCollection": {"type": "object", "required": ["name", "documents", "health", "status", "metadata"], "properties": {"name": {"type": "string"}, "documents": {"type": "number"}, "health": {"type": "string"}, "status": {"type": "string"}, "metadata": {"type": "object", "required": ["aliases", "created", "description", "source", "version", "type", "domain"], "properties": {"aliases": {"type": "array", "items": {"type": "string"}}, "created": {"type": "string", "format": "datetime"}, "description": {"type": "string"}, "source": {"type": "string"}, "storage": {"type": "string"}, "version": {"type": "string"}, "type": {"type": "string"}, "domain": {"type": "array", "items": {"type": "string"}}}}, "source": {"type": "object", "required": ["index_key"], "properties": {"index_key": {"type": "string"}, "proj_key": {"type": "string"}, "elastic_id": {"type": "string"}}}}}, "Dictionary": {"type": "object", "properties": {"name": {"type": "string"}, "description": {"type": "string", "x-nullable": true}, "dict_key": {"type": "string"}, "proj_key": {"type": "string"}, "created_by": {"type": "string"}, "created_at": {"type": "number", "format": "double"}, "copy_of": {"type": "string", "x-nullable": true}, "public": {"type": "boolean"}, "collections": {"type": "array", "items": {"$ref": "#/definitions/DictionaryCollection"}}}, "required": ["name", "description", "dict_key", "proj_key", "created_by", "created_at", "copy_of", "public"]}, "DictionaryEntry": {"type": "object", "additionalProperties": {}, "properties": {"_name": {"type": "string"}, "_synonyms": {"type": "array", "items": {"type": "string"}}}, "required": ["_name", "_synonyms"]}, "DictionaryCloneResult": {"type": "object", "properties": {"dictionary": {"$ref": "#/definitions/Dictionary"}, "clone_task": {"$ref": "#/definitions/Task"}}}, "DictionaryCollection": {"type": "object", "required": ["name", "item_count"], "properties": {"name": {"type": "string"}, "item_count": {"type": "integer"}}}, "DictionaryCollectionPatch": {"type": "object", "required": ["op", "path"], "properties": {"op": {"type": "string", "enum": ["add", "replace", "remove"]}, "path": {"type": "string", "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})$"}, "value": {"$ref": "#/definitions/DictionaryEntry"}}}, "CpsModelReference": {"type": "object", "properties": {"model_config_key": {"type": "string"}, "proj_key": {"type": "string"}}, "required": ["model_config_key", "proj_key"]}, "CcsCollectionReference": {"type": "object", "properties": {"proj_key": {"type": "string"}, "collection_name": {"type": "string"}, "language": {"type": "string"}}, "required": ["proj_key", "collection_name"]}, "ProcessingModelDataFlow": {"type": "object", "properties": {"config": {"type": "object"}, "data-flow": {"type": "array", "items": {"type": "object"}}}, "required": ["config", "data-flow"]}, "WorkFlow": {"type": "object"}, "ProcessingModel": {"type": "object", "required": ["dataflow"], "properties": {"dataflow": {"$ref": "#/definitions/ProcessingModelDataFlow"}, "variables": {"type": "object", "additionalProperties": {"type": "object", "title": "DataFlowVariableDefinition", "properties": {"type": {"type": "string"}}, "required": ["type"]}}}}, "CatalogReference": {"type": "object", "properties": {"dc_key": {"type": "string"}, "proj_key": {"type": "string"}, "collection_name": {"type": "string"}}, "required": ["dc_key", "collection_name"]}, "EntityMapping": {"type": "object", "additionalProperties": {"type": "string"}}, "ProcessingModelDescription": {"type": "object", "required": ["name", "display_name", "description"], "properties": {"name": {"type": "string"}, "display_name": {"type": "string"}, "description": {"type": "string"}}}}, "basePath": "/api/cps/public/v1"}
diff --git a/tools/swagger-client-generator/swagger-user.json b/tools/swagger-client-generator/swagger-user.json
index 3f2c5ea1..da2eec5a 100644
--- a/tools/swagger-client-generator/swagger-user.json
+++ b/tools/swagger-client-generator/swagger-user.json
@@ -1 +1 @@
-{"swagger": "2.0", "info": {"version": "1.2.0", "title": "User Management API"}, "schemes": ["http", "https"], "consumes": ["application/json"], "produces": ["application/json"], "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", "type": "apiKey", "name": "Authorization", "in": "header", "x-apikeyInfoFunc": "oidc_user_mngt.utils.connexion_auth.api_key_info"}, "UserAPIKey": {"description": "Login using the user credentials. Username is the email address. Password is\nthe API Key.\n", "type": "basic", "x-basicInfoFunc": "oidc_user_mngt.utils.connexion_auth.basic_auth_info"}}, "paths": {"/oidc/authenticate": {"get": {"tags": ["Oidc"], "description": "Redirect to the OIDC authenticate endpoint.", "produces": ["text/plain"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "authenticate", "responses": {"302": {"description": "Redirect to the OIDC authenticate endpoint"}}}}, "/oidc/token": {"get": {"tags": ["Oidc"], "description": "Retrieve the user access and identity tokens using either the code or the refresh_token.", "deprecated": true, "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "token", "parameters": [{"name": "code", "in": "query", "required": false, "type": "string", "description": "The oidc code response"}, {"name": "refresh_token", "in": "query", "required": false, "type": "string", "description": "The oidc code response"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/OidcTokenResponse"}}}}, "post": {"tags": ["Oidc"], "description": "Retrieve the user access and identity tokens using either the code or the refresh_token.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "create_tokens", "parameters": [{"name": "body", "in": "body", "schema": {"title": "CreateTokensRequestBody", "type": "object", "properties": {"code": {"type": "string", "description": "The oidc code response"}, "refresh_token": {"type": "string", "description": "The refresh token"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/OidcTokenResponse"}}}}}, "/oidc/register_user": {"post": {"tags": ["Oidc"], "description": "Register a new user, provided a valid access_token and id_token from the oidc provider.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.oidc", "operationId": "register_user", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "RegisterUserRequestBody", "properties": {"access_token": {"type": "string", "description": "OIDC access_token signed by the provider"}, "id_token": {"type": "string", "description": "OIDC id_token signed by the provider"}}, "required": ["access_token", "id_token"]}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/UserDetails"}}}}}, "/user/impersonate": {"post": {"tags": ["Users"], "security": [{"Bearer": []}, {"UserAPIKey": []}], "description": "Request an impersonate user token.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "impersonate_user_token", "parameters": [{"name": "body", "in": "body", "required": true, "schema": {"type": "object", "title": "ImpersonateUserTokenRequestBody", "required": ["target_user_key", "impersonate_secret"], "properties": {"target_user_key": {"type": "string"}, "impersonate_secret": {"type": "string"}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/TokenResponse"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission or the impersonate secret isn't valid.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/user/service_accounts": {"get": {"deprecated": true, "tags": ["Users"], "security": [{"Bearer": []}], "description": "List all service accounts of your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "service_accounts_list", "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccount"}}}}}, "post": {"deprecated": true, "tags": ["Users"], "security": [{"Bearer": []}], "description": "Create a new service accounts for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "service_accounts_create", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ServiceAccount"}}}}}, "/user/api_key": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Show the API Key for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "api_key_get", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ApiKey"}}}}, "post": {"tags": ["User"], "security": [{"Bearer": []}], "description": "Create an API Key for your user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "api_key_create", "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/ApiKey"}}}}}, "/user/token": {"post": {"tags": ["Users"], "security": [{"Bearer": []}, {"UserAPIKey": []}], "description": "Request a user API token", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "get_access_token", "parameters": [{"name": "options", "in": "body", "required": false, "schema": {"type": "object", "title": "GetAccessTokenRequestBody", "properties": {"admin": {"type": "boolean", "default": false}}}}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/AccessToken"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/user/search": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Search for users matching the email or name. Depending on the user's permissions, only owners and assignees from their projects may be shown.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "search", "parameters": [{"name": "term", "in": "query", "required": true, "type": "string", "description": "Search term"}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}}}, "/user/current": {"get": {"tags": ["Users"], "security": [{"Bearer": []}], "description": "Gets the current user's details.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.user", "operationId": "get_current_user_details", "parameters": [], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/UserDetails"}}}}}, "/projects": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all projects assigned to a user", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_projects", "parameters": [{"name": "role", "in": "query", "required": false, "type": "string", "description": "filter for the user role"}, {"name": "include_collaborators", "in": "query", "required": false, "type": "boolean", "default": true}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Create a new project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "create", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateProjectRequestBody", "properties": {"name": {"type": "string", "description": "Name of the project"}, "proj_key": {"type": "string", "description": "Internal project key to use. (use only if you really know what you are doing)"}}, "required": ["name"]}}], "responses": {"200": {"description": "New project details", "schema": {"$ref": "#/definitions/Project"}}}}}, "/projects/{proj_key}/is_authorized": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Provide user-key and project-key to coordinates a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "is_authorized", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "role", "in": "query", "required": false, "type": "string", "description": "The specific role to probe"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/delete": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Get a delete confirmation token for the provided project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "get_delete_confirmation_token", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "Confirmation token.", "schema": {"$ref": "#/definitions/TokenResponse"}}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Returns the details of the project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "details", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/Project"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "delete": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Delete a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "delete", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "confirmation_token", "in": "query", "required": true, "type": "string", "description": "The delete confirmation token"}], "responses": {"204": {"description": "Project deleted successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all users belonging to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_users", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "add_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "put": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "edit_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users_paginated": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List all users belonging to a cps project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_users_paginated", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 2, "type": "integer"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/users/{username}": {"delete": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Delete an user from a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "remove_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "username", "in": "path", "required": true, "type": "string", "description": "The username for the user"}], "responses": {"204": {"description": "User deleted from project successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project or user not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project, or the project only has one owner left.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/token": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "Request a token granting access to the current project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "get_project_token", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}], "responses": {"200": {"description": "OK", "schema": {"$ref": "#/definitions/AccessToken"}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/projects/{proj_key}/audits": {"get": {"tags": ["Projects"], "security": [{"Bearer": []}], "description": "List audits related to the project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.project", "operationId": "list_audits_in_project", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "user_key", "in": "query", "required": false, "type": "string"}, {"name": "type_", "in": "query", "type": "string", "required": false}, {"name": "search_term", "in": "query", "type": "string", "required": false}, {"name": "before", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "after", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "limit", "in": "query", "type": "integer", "default": 50}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["audits"], "properties": {"audits": {"type": "array", "items": {"$ref": "#/definitions/AuditRecord"}}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/permissions": {"get": {"tags": ["Settings"], "security": [{"Bearer": []}], "description": "Get the global permissions for users.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.global", "operationId": "global_permissions", "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "boolean"}}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/users/pending": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List pending user requests.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_pending_users", "parameters": [{"name": "term", "type": "string", "in": "query", "required": false}], "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/users/{user_key}/confirmation": {"post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Confirm a pending user.", "consumes": ["application/json"], "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "confirm_user", "parameters": [{"name": "user_key", "in": "path", "required": true, "type": "string"}], "responses": {"200": {"description": "OK"}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/all": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List all projects", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_all_projects", "responses": {"200": {"description": "OK", "schema": {"type": "array", "items": {"$ref": "#/definitions/Project"}}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/audits": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List audits globally", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "list_audits", "parameters": [{"name": "user_key", "in": "query", "required": false, "type": "string"}, {"name": "type_", "in": "query", "type": "string", "required": false}, {"name": "search_term", "in": "query", "type": "string", "required": false}, {"name": "before", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "after", "in": "query", "type": "string", "format": "datetime", "required": false}, {"name": "limit", "in": "query", "type": "integer", "default": 50}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "required": ["audits"], "properties": {"audits": {"type": "array", "items": {"$ref": "#/definitions/AuditRecord"}}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/{proj_key}/users": {"get": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "List all users belonging to a cps project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_list_users", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "page", "in": "query", "description": "page of the result list", "required": false, "type": "integer"}, {"name": "items_per_page", "in": "query", "description": "items on one page of the result list", "required": false, "default": 2, "type": "integer"}], "responses": {"200": {"description": "OK", "schema": {"type": "object", "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}}, "401": {"description": "Unauthorized.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User does not exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}, "post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Assign a new user to a project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_add_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "data", "in": "body", "required": true, "schema": {"$ref": "#/definitions/ProjectUserAssignment"}}], "responses": {"200": {"description": "User assigned to project.", "schema": {"$ref": "#/definitions/SuccessMessage"}}, "400": {"description": "Invalid new_user_type.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "403": {"description": "The user that's performing this operation does not have permission to assign the user.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "User that's going to be assigned doesn't exist, or the project doesn't exist.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "Reassigning the user would leave the project in an invalid state.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects/{proj_key}/users/{username}": {"delete": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Delete an user from a project.", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "admin_remove_user", "parameters": [{"name": "proj_key", "in": "path", "required": true, "type": "string", "description": "The project key"}, {"name": "username", "in": "path", "required": true, "type": "string", "description": "The username for the user"}], "responses": {"204": {"description": "User deleted from project successfully."}, "403": {"description": "The user that is executing this operation is not an owner of the project.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "404": {"description": "Project or user not found.", "schema": {"$ref": "#/definitions/ErrorResponse"}}, "409": {"description": "User not assigned to project, or the project only has one owner left.", "schema": {"$ref": "#/definitions/ErrorResponse"}}}}}, "/admin/projects": {"post": {"tags": ["Admin"], "security": [{"Bearer": []}], "description": "Create a new project", "produces": ["application/json"], "x-swagger-router-controller": "oidc_user_mngt.controllers.admin", "operationId": "create_project", "parameters": [{"name": "data", "in": "body", "required": true, "schema": {"type": "object", "title": "CreateProjectRequestBody", "properties": {"name": {"type": "string", "description": "Name of the project"}, "proj_key": {"type": "string", "description": "Internal project key to use. (use only if you really know what you are doing)"}}, "required": ["name"]}}], "responses": {"200": {"description": "New project details", "schema": {"$ref": "#/definitions/Project"}}}}}}, "definitions": {"ErrorResponse": {"type": "object", "properties": {"error": {"type": "string", "description": "Description of the error."}}, "required": ["error"]}, "UserDetails": {"type": "object", "properties": {"username": {"type": "string"}, "email": {"type": "string"}, "role": {"type": "string"}}}, "UserType": {"type": "string", "enum": ["assignee", "owner"]}, "ServiceAccount": {"type": "object", "required": ["user_key"], "properties": {"user_key": {"type": "string"}, "name": {"type": "string"}, "credentials": {"type": "object", "required": ["username", "password"], "properties": {"username": {"type": "string"}, "password": {"type": "string"}}}}}, "TokenResponse": {"type": "object", "properties": {"token": {"type": "string", "description": "The delete confirmation token."}}, "required": ["token"]}, "Project": {"type": "object", "properties": {"name": {"type": "string"}, "date": {"type": "string", "format": "datetime"}, "proj_key": {"type": "string"}, "role": {"$ref": "#/definitions/UserType"}}, "additionalProperties": {"type": "array", "items": {"$ref": "#/definitions/UserDetails"}}}, "SuccessMessage": {"type": "object", "properties": {"success": {"type": "string", "description": "Human readable message."}}, "required": ["success"]}, "ApiKey": {"type": "object", "required": ["api_key"], "properties": {"api_key": {"type": "string"}, "email": {"type": "string"}}}, "AccessToken": {"type": "object", "properties": {"access_token": {"type": "string"}}}, "ProjectUserAssignment": {"type": "object", "properties": {"username": {"type": "string", "description": "The username"}, "role": {"type": "string", "description": "The role to assign to the user"}, "force_role": {"type": "boolean", "default": true, "description": "If true, the role will be assigned also for existing users"}}, "required": ["username", "role"]}, "OidcTokenResponse": {"type": "object", "properties": {"access_token": {"type": "string"}, "id_token": {"type": "string"}, "refresh_token": {"type": "string"}}, "required": ["id_token", "refresh_token"]}, "AuditRecord": {"title": "AuditRecord", "type": "object", "properties": {"id": {"title": "Id", "type": "string"}, "timestamp": {"title": "Timestamp", "type": "string", "format": "datetime"}, "user_key": {"title": "User Key", "type": "string"}, "type": {"title": "Type", "type": "string"}, "message": {"title": "Message", "type": "string"}, "details": {"title": "Details", "type": "object"}, "proj_key": {"title": "Proj Key", "type": "string", "x-nullable": true}}, "required": ["id", "timestamp", "user_key", "type", "message", "details", "proj_key"]}}, "basePath": "/api/cps/user/v1"}
+{"openapi":"3.1.0","info":{"title":"Deep Search (DS) User API","description":"API for Deep Search.","version":"2.0.0"},"servers":[{"url":"/api/cps/user/v1"}],"paths":{"/admin/users/pending":{"get":{"tags":["Admin"],"summary":"List Pending Users","operationId":"list_pending_users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"term","in":"query","required":false,"schema":{"title":"Term"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{},"title":"Response List Pending Users"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/users/{user_key}/confirmation":{"post":{"tags":["Admin"],"summary":"Confirm User","operationId":"confirm_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_key","in":"path","required":true,"schema":{"title":"User Key"}},{"name":"admin_user","in":"query","required":true,"schema":{"title":"Admin User"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/projects/all":{"post":{"tags":["Admin"],"summary":"List All Projects","operationId":"list_all_projects","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{},"type":"array","title":"Response List All Projects"}}}}},"security":[{"HTTPBearer":[]}]}},"/admin/audits":{"post":{"tags":["Admin"],"summary":"List Audits","operationId":"list_audits","security":[{"HTTPBearer":[]}],"parameters":[{"name":"user_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Key"}},{"name":"type_","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type "}},{"name":"search_term","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Term"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/projects":{"post":{"tags":["Admin"],"summary":"Create Project","operationId":"create_project","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","title":"Response Create Project"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/admin/projects/{proj_key}/users":{"get":{"tags":["Admin"],"summary":"Admin List Users","operationId":"admin_list_users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"role","in":"query","required":false,"schema":{"title":"Role"}},{"name":"page","in":"query","required":false,"schema":{"title":"Page"}},{"name":"items_per_page","in":"query","required":false,"schema":{"title":"Items Per Page"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Admin"],"summary":"Admin Add User","operationId":"admin_add_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"title":"Proj Key"}},{"name":"data","in":"query","required":true,"schema":{"title":"Data"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminAddUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/admin/projects/{proj_key}/users/{username}":{"delete":{"tags":["Admin"],"summary":"Admin Remove User","operationId":"admin_remove_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"title":"Proj Key"}},{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/permissions":{"get":{"tags":["Global"],"summary":"Global Permissions","operationId":"global_permissions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalPermissionsResponse"}}}}}}},"/oidc/authenticate":{"get":{"tags":["OIDC"],"summary":"Authenticate","operationId":"authenticate","responses":{"302":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/oidc/token":{"get":{"tags":["OIDC"],"summary":"Token","operationId":"token","parameters":[{"name":"code","in":"query","required":false,"schema":{"title":"Code"}},{"name":"refresh_token","in":"query","required":false,"schema":{"title":"Refresh Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["OIDC"],"summary":"Create Tokens","operationId":"create_tokens","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/oidc/register_user":{"post":{"tags":["OIDC"],"summary":"Register User","operationId":"register_user","requestBody":{"content":{"application/json":{"schema":{"type":"object","title":"Data"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects":{"get":{"tags":["Project"],"summary":"List Projects","operationId":"list_projects","security":[{"HTTPBearer":[]}],"parameters":[{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}},{"name":"include_collaborators","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Collaborators"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProjectDetailsResponse"},"title":"Response List Projects"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Project"],"summary":"Create","operationId":"create","security":[{"HTTPBearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetailsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/is_authorized":{"get":{"tags":["Project"],"summary":"Is Authorized","operationId":"is_authorized","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"title":"Proj Key"}},{"name":"role","in":"query","required":false,"schema":{"title":"Role"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsAuthorizedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/delete":{"get":{"tags":["Project"],"summary":"Get Delete Confirmation Token","operationId":"get_delete_confirmation_token","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteConfirmationTokenReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}":{"get":{"tags":["Project"],"summary":"Details","operationId":"details","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDetailsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Project"],"summary":"Delete","operationId":"delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"confirmation_token","in":"query","required":true,"schema":{"type":"string","title":"Confirmation Token"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectDeleteReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/users":{"get":{"tags":["Project"],"summary":"List Users","operationId":"list_users","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCollaboratorsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Project"],"summary":"Add User","operationId":"add_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAddEditUserReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Project"],"summary":"Edit User","operationId":"edit_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectAddEditUserReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/users_paginated":{"get":{"tags":["Project"],"summary":"List Users Paginated","operationId":"list_users_paginated","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"page","in":"query","required":true,"schema":{"type":"integer","title":"Page"}},{"name":"items_per_page","in":"query","required":true,"schema":{"type":"integer","title":"Items Per Page"}},{"name":"role","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/users/{username}":{"delete":{"tags":["Project"],"summary":"Remove User","operationId":"remove_user","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"username","in":"path","required":true,"schema":{"type":"string","title":"Username"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/token":{"get":{"tags":["Project"],"summary":"Get Project Token","operationId":"get_project_token","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessTokenReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/projects/{proj_key}/audits":{"get":{"tags":["Project"],"summary":"List Audits In Project","operationId":"list_audits_in_project","security":[{"HTTPBearer":[]}],"parameters":[{"name":"proj_key","in":"path","required":true,"schema":{"type":"string","title":"Proj Key"}},{"name":"user_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Key"}},{"name":"type_","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type "}},{"name":"search_term","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Term"}},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Before"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"After"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/user/impersonate":{"post":{"tags":["Service Accounts"],"summary":"Impersonate User Token","operationId":"impersonate_user_token","security":[{"HTTPBearer":[]}],"parameters":[{"name":"body","in":"query","required":true,"schema":{"title":"Body"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImpersonateUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/user/service_accounts":{"get":{"tags":["Service Accounts"],"summary":"Service Accounts List","operationId":"service_accounts_list","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ServiceAccountsResponse"},"type":"array","title":"Response Service Accounts List"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Service Accounts"],"summary":"Service Accounts Create","operationId":"service_accounts_create","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceAccountsResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/user/api_key":{"get":{"tags":["Service Accounts"],"summary":"Api Key Get","operationId":"api_key_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserApiKeyResponse"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["Service Accounts"],"summary":"Api Key Create","operationId":"api_key_create","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserApiKeyResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/user/token":{"post":{"tags":["Service Accounts"],"summary":"Get Access Token","operationId":"get_access_token","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Options"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAccessTokenReponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]},{"HTTPBasic":[]}]}},"/user/current":{"get":{"tags":["Service Accounts"],"summary":"Get Current User Details","operationId":"get_current_user_details","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCurrentUserDetailsResponse"}}}}},"security":[{"HTTPBearer":[]}]}},"/user/search":{"get":{"tags":["Service Accounts"],"summary":"Search","operationId":"search","security":[{"HTTPBearer":[]}],"parameters":[{"name":"term","in":"query","required":true,"schema":{"title":"Term"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/UserDetailsResponse"},{"type":"null"}]},"title":"Response Search"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AdminAddUserResponse":{"properties":{"success":{"type":"string","title":"Success"}},"type":"object","required":["success"],"title":"AdminAddUserResponse"},"DeleteConfirmationTokenReponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"DeleteConfirmationTokenReponse"},"GetAccessTokenReponse":{"properties":{"access_token":{"type":"string","title":"Access Token"}},"type":"object","required":["access_token"],"title":"GetAccessTokenReponse"},"GetCurrentUserDetailsResponse":{"properties":{"user_key":{"type":"string","title":"User Key"},"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name"},"can_be_admin":{"type":"boolean","title":"Can Be Admin"},"is_admin":{"type":"boolean","title":"Is Admin"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}},"type":"object","required":["user_key","email","name","can_be_admin","is_admin","role"],"title":"GetCurrentUserDetailsResponse"},"GlobalPermissionsResponse":{"properties":{"search_any_user":{"type":"boolean","title":"Search Any User"},"disable_project_creation":{"type":"boolean","title":"Disable Project Creation","default":false},"match_users_by_email":{"type":"boolean","title":"Match Users By Email","default":false},"signup":{"type":"boolean","title":"Signup"},"strict_user_search_by_email":{"type":"boolean","title":"Strict User Search By Email","default":false}},"type":"object","required":["search_any_user","signup"],"title":"GlobalPermissionsResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImpersonateUserResponse":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"ImpersonateUserResponse"},"IsAuthorizedResponse":{"properties":{"authorized":{"type":"boolean","title":"Authorized"}},"type":"object","required":["authorized"],"title":"IsAuthorizedResponse"},"ListAuditsResponse":{"properties":{"audits":{"items":{"type":"object"},"type":"array","title":"Audits"}},"type":"object","required":["audits"],"title":"ListAuditsResponse"},"ListUsersResponse":{"properties":{"count":{"type":"integer","title":"Count"},"items_per_page":{"type":"integer","title":"Items Per Page"},"page":{"type":"integer","title":"Page"},"users":{"items":{"$ref":"#/components/schemas/UserResponseModel"},"type":"array","title":"Users"}},"type":"object","required":["count","items_per_page","page","users"],"title":"ListUsersResponse"},"ProjectAddEditUserReponse":{"properties":{"success":{"type":"string","title":"Success"}},"type":"object","required":["success"],"title":"ProjectAddEditUserReponse"},"ProjectCollaboratorsResponse":{"properties":{"owners":{"items":{},"type":"array","title":"Owners"},"editors":{"items":{},"type":"array","title":"Editors"},"viewers":{"items":{},"type":"array","title":"Viewers"}},"type":"object","required":["owners","editors","viewers"],"title":"ProjectCollaboratorsResponse"},"ProjectDeleteReponse":{"properties":{"success":{"type":"string","title":"Success"}},"type":"object","required":["success"],"title":"ProjectDeleteReponse"},"ProjectDetailsResponse":{"properties":{"owners":{"items":{},"type":"array","title":"Owners"},"editors":{"items":{},"type":"array","title":"Editors"},"viewers":{"items":{},"type":"array","title":"Viewers"},"name":{"type":"string","title":"Name"},"date":{"type":"string","title":"Date"},"proj_key":{"type":"string","title":"Proj Key"},"role":{"type":"string","title":"Role"}},"type":"object","required":["owners","editors","viewers","name","date","proj_key","role"],"title":"ProjectDetailsResponse"},"ServiceAccountsResponse":{"properties":{"user_key":{"type":"string","title":"User Key"},"name":{"type":"string","title":"Name"},"credentials":{"type":"object","title":"Credentials"}},"type":"object","required":["user_key","name","credentials"],"title":"ServiceAccountsResponse"},"UserApiKeyResponse":{"properties":{"email":{"type":"string","title":"Email"},"api_key":{"type":"string","title":"Api Key"}},"type":"object","required":["email","api_key"],"title":"UserApiKeyResponse"},"UserDetailsResponse":{"properties":{"user_key":{"type":"string","title":"User Key"},"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name"}},"type":"object","required":["user_key","email","name"],"title":"UserDetailsResponse"},"UserResponseModel":{"properties":{"_id":{"type":"string","title":"Id"},"email":{"type":"string","title":"Email"},"name":{"type":"string","title":"Name"},"role":{"type":"string","title":"Role"},"user_key":{"type":"string","title":"User Key"}},"type":"object","required":["email","name","role","user_key"],"title":"UserResponseModel"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"},"HTTPBasic":{"type":"http","scheme":"basic"}}}}
\ No newline at end of file