From 63a2a734219ccec3b0dac4aa78dee73d2cf8afdb Mon Sep 17 00:00:00 2001 From: Martin Weise <martin.weise@tuwien.ac.at> Date: Wed, 10 Aug 2022 15:54:02 +0200 Subject: [PATCH] Remove the idea files, added documentation to the website, added docker hub descriptions --- .gitignore | 10 + .idea/.gitignore | 8 - .idea/fda-docs.iml | 8 - .../inspectionProfiles/profiles_settings.xml | 6 - .idea/misc.xml | 4 - .idea/modules.xml | 8 - .idea/vcs.xml | 6 - Dockerfile | 12 +- Makefile | 17 +- docker-compose.yml | 2 +- dockerhub/.env.example | 2 + dockerhub/_header.md | 34 + dockerhub/client/Dockerhub.py | 46 + site/.gitkeep => dockerhub/client/__init__.py | 0 .../__pycache__/Dockerhub.cpython-39.pyc | Bin 0 -> 1986 bytes .../__pycache__/__init__.cpython-39.pyc | Bin 0 -> 151 bytes dockerhub/fda-discovery-service.md | 5 + dockerhub/fda-metadata-db.md | 12 + dockerhub/requirements.txt | 2 + dockerhub/response.py | 7 + docs/getting-started.md | 67 +- docs/images/interaction-gateway.svg | 3 + docs/operation/endpoints/authentication.md | 2449 ----------- docs/operation/endpoints/container.md | 2902 ------------- docs/operation/endpoints/database.md | 2320 ----------- docs/operation/endpoints/identifier.md | 3623 ----------------- docs/operation/endpoints/query.md | 1014 ----- docs/system.md | 218 +- mkdocs.yml | 8 +- swagger/api-authentication/.idea/.gitignore | 8 - .../.idea/api-authentication.iml | 14 - .../inspectionProfiles/profiles_settings.xml | 6 - swagger/api-authentication/.idea/misc.xml | 4 - swagger/api-authentication/.idea/modules.xml | 8 - swagger/api-authentication/.idea/vcs.xml | 6 - 35 files changed, 363 insertions(+), 12476 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/fda-docs.iml delete mode 100644 .idea/inspectionProfiles/profiles_settings.xml delete mode 100644 .idea/misc.xml delete mode 100644 .idea/modules.xml delete mode 100644 .idea/vcs.xml create mode 100644 dockerhub/.env.example create mode 100644 dockerhub/_header.md create mode 100644 dockerhub/client/Dockerhub.py rename site/.gitkeep => dockerhub/client/__init__.py (100%) create mode 100644 dockerhub/client/__pycache__/Dockerhub.cpython-39.pyc create mode 100644 dockerhub/client/__pycache__/__init__.cpython-39.pyc create mode 100644 dockerhub/fda-discovery-service.md create mode 100644 dockerhub/fda-metadata-db.md create mode 100644 dockerhub/requirements.txt create mode 100644 dockerhub/response.py create mode 100644 docs/images/interaction-gateway.svg delete mode 100644 docs/operation/endpoints/authentication.md delete mode 100644 docs/operation/endpoints/container.md delete mode 100644 docs/operation/endpoints/database.md delete mode 100644 docs/operation/endpoints/identifier.md delete mode 100644 docs/operation/endpoints/query.md delete mode 100644 swagger/api-authentication/.idea/.gitignore delete mode 100644 swagger/api-authentication/.idea/api-authentication.iml delete mode 100644 swagger/api-authentication/.idea/inspectionProfiles/profiles_settings.xml delete mode 100644 swagger/api-authentication/.idea/misc.xml delete mode 100644 swagger/api-authentication/.idea/modules.xml delete mode 100644 swagger/api-authentication/.idea/vcs.xml diff --git a/.gitignore b/.gitignore index 92b71ca..bd33985 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,16 @@ site/ node_modules/ *.bkp +## macOS +.DS_Store +.idea/ + +## Docker Hub +dockerhub/.env + +## Virtual Environment +venv/ + ## Core latex/pdflatex auxiliary files: *.aux *.lof diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 13566b8..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/.idea/fda-docs.iml b/.idea/fda-docs.iml deleted file mode 100644 index d0876a7..0000000 --- a/.idea/fda-docs.iml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<module type="PYTHON_MODULE" version="4"> - <component name="NewModuleRootManager"> - <content url="file://$MODULE_DIR$" /> - <orderEntry type="inheritedJdk" /> - <orderEntry type="sourceFolder" forTests="false" /> - </component> -</module> \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml deleted file mode 100644 index 105ce2d..0000000 --- a/.idea/inspectionProfiles/profiles_settings.xml +++ /dev/null @@ -1,6 +0,0 @@ -<component name="InspectionProjectProfileManager"> - <settings> - <option name="USE_PROJECT_PROFILE" value="false" /> - <version value="1.0" /> - </settings> -</component> \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index 65531ca..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.6" project-jdk-type="Python SDK" /> -</project> \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index d8854aa..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="ProjectModuleManager"> - <modules> - <module fileurl="file://$PROJECT_DIR$/.idea/fda-docs.iml" filepath="$PROJECT_DIR$/.idea/fda-docs.iml" /> - </modules> - </component> -</project> \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 94a25f7..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="VcsDirectoryMappings"> - <mapping directory="$PROJECT_DIR$" vcs="Git" /> - </component> -</project> \ No newline at end of file diff --git a/Dockerfile b/Dockerfile index 35d1443..8152733 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,13 +4,21 @@ ENV PYTHONUNBUFFERED=1 RUN apt-get update && apt-get install -y python3 python3-pip python3-cffi python3-brotli libpango-1.0-0 libpangoft2-1.0-0 -COPY ./requirements.txt ./requirements.txt +COPY requirements.txt ./requirements.txt RUN pip3 install -r ./requirements.txt RUN python3 --version RUN mkdocs --version -COPY ./docs ./docs +COPY ./docs/images ./docs/images +COPY ./docs/operation ./docs/operation +COPY ./docs/stylesheets ./docs/stylesheets +COPY ./docs/videos ./docs/videos +COPY ./docs/contact.md ./docs/contact.md +COPY ./docs/getting-started.md ./docs/getting-started.md +COPY ./docs/index.md ./docs/index.md +COPY ./docs/publications.md ./docs/publications.md +COPY ./docs/system.md ./docs/system.md COPY ./mkdocs.yml ./mkdocs.yml RUN echo 'plugins:\n\ diff --git a/Makefile b/Makefile index 82a7e80..b6617fc 100644 --- a/Makefile +++ b/Makefile @@ -1,20 +1,13 @@ -phony: +.PHONY: clean -all: +all: build + +clean: build: docker-compose build - -run: build docker-compose up sudo mv ./site/pdf/document.pdf ./site/pdf/documentation.pdf -docs: - widdershins --environment ./misc/env.json ./misc/api-authentication.yaml -o ./docs/operation/endpoints/authentication.md - widdershins --environment ./misc/env.json ./misc/api-container.yaml -o ./docs/operation/endpoints/container.md - widdershins --environment ./misc/env.json ./misc/api-database.yaml -o ./docs/operation/endpoints/database.md - widdershins --environment ./misc/env.json ./misc/api-identifier.yaml -o ./docs/operation/endpoints/identifier.md - widdershins --environment ./misc/env.json ./misc/api-query.yaml -o ./docs/operation/endpoints/query.md - -deploy: run +install: build sudo cp -r ./site/* /usr/share/nginx/html/ \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index ae77228..355ad34 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -14,7 +14,7 @@ services: build: . image: fda-docs-builder volumes: - - "./site:/site" + - ./site:/site networks: - fda-public environment: diff --git a/dockerhub/.env.example b/dockerhub/.env.example new file mode 100644 index 0000000..e3ac305 --- /dev/null +++ b/dockerhub/.env.example @@ -0,0 +1,2 @@ +USERNAME=... +PASSWORD=... \ No newline at end of file diff --git a/dockerhub/_header.md b/dockerhub/_header.md new file mode 100644 index 0000000..d23d951 --- /dev/null +++ b/dockerhub/_header.md @@ -0,0 +1,34 @@ +# Quick Reference + +* **Maintained by**: + + [the DBRepo Maintainers](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/graphs/master) + +* **Where to get help**: + + [the official documentation](https://dbrepo-docs.ossdip.at/), [IDCC'22 paper](https://doi.org/10.5281/zenodo.6637333), + [iPRES'21 paper](https://doi.org/10.17605/OSF.IO/B7NX5) + +# Supported tags and respective `Dockerfile` links + +* [`latest`](https://hub.docker.com/repository/docker/dbrepo/metadata-db/tags?page=1&ordering=last_updated&name=latest) + +# Quick reference (cont.) + +* **Where to file issues**: + + Send us an [email](https://tiss.tuwien.ac.at/person/287722.html) + +* **Supported architectures:** + + `amd64` + +* **Source of this description:** + + [docs repo's `dockerhub/` directory](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-docs/-/tree/master/dockerhub) + ([history](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-docs/-/commits/master/dockerhub)) + +# What is DBRepo? + +tbd + diff --git a/dockerhub/client/Dockerhub.py b/dockerhub/client/Dockerhub.py new file mode 100644 index 0000000..ce81fd0 --- /dev/null +++ b/dockerhub/client/Dockerhub.py @@ -0,0 +1,46 @@ +import requests as rq +import os +from py_dotenv import read_dotenv + +class Dockerhub: + """A simple Dockerhub client""" + baseurl = "https://hub.docker.com" + username = "" + registry = "registry-1.docker.io" + workpath = os.path.abspath(os.path.join(os.path.dirname(__file__), "..")) + headers = { + "Content-Type": "application/json", + "Authorization": None + } + + def __init__(self): + read_dotenv(self.workpath + "/.env") + self.username = os.getenv("USERNAME") + response = rq.post(self.baseurl + "/v2/users/login", { + "username": self.username, + "password": os.getenv("PASSWORD") + }) + if response.status_code == 200: + self.headers["Authorization"] = "Bearer " + response.json()["token"] + else: + raise "Failed to authenticate" + + + def modify_description(self, repository): + header = self.__read__(self.workpath + "/_header.md") + body = self.__read__(self.workpath + "/fda-" + repository + ".md") + response = rq.patch(self.baseurl + "/v2/repositories/" + self.username + "/" + repository + "/", headers=self.headers, + json={ + "description": "Official repository of DBRepo.", + "full_description": header + "\n\n" + body, + "registry": self.registry + }) + if response.status_code == 200: + return response.json() + else: + print(response) + + + def __read__(self, path): + with open(path, "r") as f: + return ' '.join([line for line in f.readlines()]) \ No newline at end of file diff --git a/site/.gitkeep b/dockerhub/client/__init__.py similarity index 100% rename from site/.gitkeep rename to dockerhub/client/__init__.py diff --git a/dockerhub/client/__pycache__/Dockerhub.cpython-39.pyc b/dockerhub/client/__pycache__/Dockerhub.cpython-39.pyc new file mode 100644 index 0000000000000000000000000000000000000000..6cf5575639fff1b79d6a06695052a1b88adc5607 GIT binary patch literal 1986 zcmYe~<>g{vU|@K@{d1B78w0~*5C<7EGcYhXFfcF_>oG7eq%fo~<}gGtf@!8GrWA%0 zrX1#6mM9iR26u)O<`k9|h7^`&rYP1F#$X0b)|ViY{4^PFaTlc~ro^Y@m!#&EC4&T! zF+0qP7zPH0RIu?;Oeu^}%qdJ!EGf)UtSKx}Y^m&791A$XBo~<EPUTt1n8Lb{X(3}2 zZwgxqdkV)KrYOD?&J?Z|hA93N?i8LDhA4p)-W0wThA6=l_Fx80{#%?b`N`R-MH!_@ zRg#Vh#hJMUIjIV8F@@xu%+$P+DzS``l7eC@ef^BmB)t@{4!z|3+*=G)B1Ng`nZ+eV zmAZy7iOl>eCOy3>fy9D>oXq6JlFa-({jB2rJU>mQDjw(jypq(s65Wu>g4A2Qj-@3T z`9+ykU`5G{NP)n_z`y_s2WL=Fr!X)ulrYpVWHF{NiZe7bGBT7fEnrSzTF6+#5YJM= zx`3^QA&WhQSsbK>1uVw`3X3^R3z=#eYZ$XQQrNPYieggOYZw=BE@VjIkYoU><x1hS zVaQ`i;c8+`VF+f><o2s#)z?eSD~sX?4R#IkbM$qs;@2-T(l0GeEh^T}$xqMBi{c1y z3=R(W4|36Dy2SyK$V<#kjp8UsEG{n3FG_iNf`NgdirpzSu_(1j;TCI2es*eJ5i3Yg z%q=l9CpAT(Bwr!1v?L=nuLKl6shZqHAn)GdD9<m-E=VlNxW$xTe2XnT6_h%P*cccX zZZQ=VMzIv+7nj^(Pf9FKEiKBq#a&#ISW;RXpPZkPdW!`Vz_-{lQWH~Bi;6XwZm|@n z=A_-?C`v6Z$j>WIUCB@+%)r3#%T_-W?33K`)Xd^k{eYtUtkmR^V*Rv~MBSA9<YIkD z<Yts6=|iGkAD$NU3My}L#K&jmWtPOp3xJ|U2ozt8e2hGdJd7-i9RE02xELjvs)P_) zV9Jw0{sXB7VNg)Oqqd2GfuV+B0Vv|Yk-LzwmI=;h5@)Dk6lVZM>_Wy`<`SkX<{E}9 zmJ}9n<gtn~q_9F&fM|v+wiLD+rWAH@h8jpx0A&H@6wY4eT9z7?ERGbeY^I{J8WvCz z2xchZs$l^oC0N9B>&HWaPcJv6iWM9pRm>o^ASeM8r55BDXO`p_Wu_ME|6<gylJieX z%S_Hp%u#?#RVw7CDY!TVr55DtRWWgKX);G~r=%7q7iAWJGC`C;T4_#BJdy|~ejvF= zlc@+4q(%G;3=Bn}z|rIe1va>ph%e#<iSjToFhsEyB$gy+6!C%tKnVk)OB}@I0}&wo zw^$2`GV@9_S&IZgTDTDIyTu0a;VqV={FKTfQ2c?D1%wa*B{ZSj{FKbJN@Q2cg5p{X z6myIMj1r7WOiYYij4Xdy{<E=hF>)|f$spnzQ!`4;gUU`01_lOjrgnp5YQ_}CW~P3P zTBa1H1&ojqvxaE_(?SLphGxcvjNuGS3@HpO3@i-I%!~}d42BHF76uHAU>M23$N-K# zR=-<}MZXvoFiH@Rg~1@_g9105p@t!r15_SNWGZ9{hU5sa*EN}LG3goHV#&$OO9cx+ z2ylRK+2mvvmn7%s7TAGG{Li3ps8U0CIX)f|NqROp`N@en#ddlK4VuiiSn>-}^KP+Z z<!9#I;smJ#*-@;?433*yEa2SEm<F*AltYU^mKI4cFfizV+|2^Aj**8EHB*7iiI3M5 z0wobp;S(Q!iz_}pH$SB`CpA9)7EgS9VQFFxRE9l1J|#anJ{~F2fYS@8nk!NR#W{Oo zQZdLOMJixkN@fvAE6DJ)Opt+)^al#UB2iExlK~MRCn7l;;dW4%gR*!rD9LazvOu96 z6B8rTKQ>klUJm{ukQz<4D2}4k!qU{@lHwvz;w}QYD2lV75?U{U3q`O}Z1&vZuz`5k R4peOvgE9jLBL^c7697hX>!APu literal 0 HcmV?d00001 diff --git a/dockerhub/client/__pycache__/__init__.cpython-39.pyc b/dockerhub/client/__pycache__/__init__.cpython-39.pyc new file mode 100644 index 0000000000000000000000000000000000000000..ec7ed6b8449c36d2259bc0e384ac7f6cb3d3ca8c GIT binary patch literal 151 zcmYe~<>g{vU|<ki^EnAbKL!!Vn2~{j!GVE+p_qk%fgyz<m_d`#ZzV$!NEku<ve6GM zPAw|d&n-{QEKb!AD9X=DO)e?cPfJPEP03F#)=$Y#&Q2}LC{5B&&dE&8E76aS&&<m# ZiI3MSsJz8tlbfGXnv-e=GW9dab^venBq9I+ literal 0 HcmV?d00001 diff --git a/dockerhub/fda-discovery-service.md b/dockerhub/fda-discovery-service.md new file mode 100644 index 0000000..098a83e --- /dev/null +++ b/dockerhub/fda-discovery-service.md @@ -0,0 +1,5 @@ +# How to use this image + +```console +$ docker run -p 9090:9090 -e SPRING_PROFILES_ACTIVE=docker +``` diff --git a/dockerhub/fda-metadata-db.md b/dockerhub/fda-metadata-db.md new file mode 100644 index 0000000..b7f734d --- /dev/null +++ b/dockerhub/fda-metadata-db.md @@ -0,0 +1,12 @@ +# How to use this image + +```console +$ docker run -v ./data:/var/lib/postgresql/data -p 5432:5432 -e POSTGRES_USER=postgres -e POSTGRES_PASSWORD=postgres -e POSTGRES_DB=fda +``` + +The environment variables come from the official [PostgreSQL](https://hub.docker.com/_/postgres) image. They are briefly +explained here: + +* `POSTGRES_USER` is used in conjunction with password to set a user and its password. +* `POSTGRES_PASSWORD` must not be empty or undefined. +* `POSTGRES_DB` is used to create a database with this name. diff --git a/dockerhub/requirements.txt b/dockerhub/requirements.txt new file mode 100644 index 0000000..1bfa49d --- /dev/null +++ b/dockerhub/requirements.txt @@ -0,0 +1,2 @@ +requests==2.28.1 +py-dotenv==0.1 \ No newline at end of file diff --git a/dockerhub/response.py b/dockerhub/response.py new file mode 100644 index 0000000..3f85fa9 --- /dev/null +++ b/dockerhub/response.py @@ -0,0 +1,7 @@ +from client.Dockerhub import Dockerhub + +dockerhub = Dockerhub() + +for component in ["discovery-service", "metadata-db"]: + response = dockerhub.modify_description(component) + print(response) diff --git a/docs/getting-started.md b/docs/getting-started.md index 8fe9167..c271285 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -12,10 +12,6 @@ hide: In this short getting started guide we show the dependencies to run the database repository and perform a small, local, test deployment for quickly trying out the features that the repository offers. -!!! danger "Production" - - Do not use this small, local, test deployment with production data. It is not secure for production. - ## Requirements ### Hardware @@ -29,69 +25,50 @@ For this small, local, test deployment any modern hardware would suffice, we rec ### Software -We currently only test RPM-based operating systems. Other systems in theory should also work, but no warranty whatsoever -is given that there might be some compatibility issues in the future. +=== "Linux" -1. [Rocky Linux](https://rockylinux.org/) 8.4+ + Install [Docker Desktop](https://docs.docker.com/desktop/install/linux-install/) for Linux -On the local machine, we need installed: +=== "Windows" -1. [Docker Engine](https://docs.docker.com/engine/install/centos/) 18.02.0+ -2. [Docker Compose](https://docs.docker.com/compose/install/) + Install [Docker Desktop](https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe) for Windows -And the following minimal software packages to operate the repository: +=== "macOS" -```console -dnf install make -``` + Install [Docker Desktop](https://desktop.docker.com/mac/main/amd64/Docker.dmg) for macOS ## Deployment -Next, clone the source code repository into your working directory: +Download the latest [`docker-compose.yml`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/raw/master/docker-compose.yml) +file and deploy the system using your command line. -```console -git clone https://github.com/fair-data-austria/dbrepo.git -``` +=== "Linux" -Start building the metadata database container and the remaining containers (in fast, parallel mode utilizing all cores -of your local machine): - -```console -docker-compose build fda-metadata-database -docker-compose build --parallel -``` - -The system is auto-configured for a small, local, test deployment. You only need to start all containers by executing: - -```console -docker-compose up -``` + ```console + docker-compose up + ``` -!!! bug "Some environments need additional configuration" +=== "Windows" - In some cluster environments, it is necessary to set Docker's MTU to the main interface MTU. Find out by executing - ```console - nmcli -f GENERAL device show eth0 | grep "MTU" + docker-compose up ``` - Having the wrong MTU set leads to the containers to not downloading the Maven dependencies and the containers are - stuck. This can quickly be solved through setting the correct MTU (e.g. 1450). +=== "macOS" - ```json title="/etc/docker/daemon.json" - { - "mtu": 1450 - } + ```console + docker-compose up ``` +The system is auto-configured for a small, local, test deployment. You only need to start all containers by executing: + ## Development We invite all open-source developers to help us fixing bugs and introducing features to the source code. Get involved by -sending a mail to Prof. [Andreas Rauber](mailto:andreas.rauber@tuwien.ac.at) -and Proj.Ass. [Martin Weise](mailto:martin.weise@tuwien.ac.at). Clone the repository and create a feature branch +sending a mail to Prof. Andreas Rauber and Projektass. Martin Weise. Clone the repository and create a feature branch from `dev` and implement your changes. -## Requirements +### Software We develop all packages with the following software requirements: @@ -102,7 +79,7 @@ We develop all packages with the following software requirements: 4. [Postgres](https://www.postgresql.org/) 12+ 5. [MariaDB](https://mariadb.org/) 10+ -## Building +### Building For local development you need to install the entities from the metadata database and the general DTOs that are exchanged between the services by installing the package: diff --git a/docs/images/interaction-gateway.svg b/docs/images/interaction-gateway.svg new file mode 100644 index 0000000..8ece7bb --- /dev/null +++ b/docs/images/interaction-gateway.svg @@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"> +<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="563px" height="308px" viewBox="-0.5 -0.5 563 308"><defs/><g><path d="M 274.32 75.37 L 274.3 103 L 274 136.84" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 274.32 70.12 L 277.82 77.12 L 274.32 75.37 L 270.82 77.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 102px; margin-left: 258px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/broker/**</div></div></div></foreignObject><text x="258" y="105" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/broker/**</text></switch></g><path d="M 242 157 L 242 147 L 40 147 L 40 75.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 40 70.12 L 43.5 77.12 L 40 75.37 L 36.5 77.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 95px; margin-left: 41px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;"><div style="text-align: left; font-size: 8px;">/api/container/**</div><div style="text-align: left; font-size: 8px;">/api/image/**</div></div></div></div></foreignObject><text x="41" y="97" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/container/**...</text></switch></g><path d="M 242 167 L 40 167 L 40 260.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 40 265.88 L 36.5 258.88 L 40 260.63 L 43.5 258.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 1px; height: 1px; padding-top: 239px; margin-left: 1px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: left;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/pid/**<br />/api/container/**/database/**/identifier/**</div></div></div></foreignObject><text x="1" y="241" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px">/api/pid/**...</text></switch></g><path d="M 262 137 L 262 127 L 160 127 L 160 75.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 160 70.12 L 163.5 77.12 L 160 75.37 L 156.5 77.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 90px; margin-left: 161px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/container/**/database/**</div></div></div></foreignObject><text x="161" y="92" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/container/**/database/**</text></switch></g><path d="M 302 177 L 302 187 L 402 187 L 402 260.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 402 265.88 L 398.5 258.88 L 402 260.63 L 405.5 258.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 220px; margin-left: 403px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/analyse/**</div></div></div></foreignObject><text x="403" y="222" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/analyse/**</text></switch></g><path d="M 262 177 L 262 187 L 160.7 187 L 160.72 257.47" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 160.72 262.72 L 157.22 255.72 L 160.72 257.47 L 164.22 255.72 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 218px; margin-left: 161px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;"><div style="text-align: left">/api/auth/**</div><div style="text-align: left">/api/user/**</div></div></div></div></foreignObject><text x="161" y="221" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/auth/**...</text></switch></g><path d="M 322 167 L 522 167 L 522 260.63" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 522 265.88 L 518.5 258.88 L 522 260.63 L 525.5 258.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 222px; margin-left: 523px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/units/**</div></div></div></foreignObject><text x="523" y="224" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/units/**</text></switch></g><path d="M 302 137 L 302 127 L 402 127 L 402 75.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 402 70.12 L 405.5 77.12 L 402 75.37 L 398.5 77.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe flex-start; width: 1px; height: 1px; padding-top: 108px; margin-left: 319px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: left;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/container/**/database/**/query/**<br style="font-size: 8px" />/api/container/**/database/**/table/**/data/**<br style="font-size: 8px" />/api/container/**/database/**/table/**/export/**<br style="font-size: 8px" />/api/container/**/database/**/table/**/query/**</div></div></div></foreignObject><text x="319" y="110" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px">/api/container/**/database/**/query/**...</text></switch></g><path d="M 322 147 L 521 147 L 521 75.37" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 521 70.12 L 524.5 77.12 L 521 75.37 L 517.5 77.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 137px; margin-left: 497px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/container/**/database/**/table/**</div></div></div></foreignObject><text x="497" y="139" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/container/**/database/**/table/**</text></switch></g><path d="M 282 183.37 L 282 197 L 282 180 L 282 200" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 282 178.12 L 285.5 185.12 L 282 183.37 L 278.5 185.12 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 209px; margin-left: 283px;"><div data-drawio-colors="color: #FFFFFF; background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; font-weight: bold; background-color: rgb(255, 255, 255); white-space: nowrap;"><font color="#000000">HTTP Request</font></div></div></div></foreignObject><text x="283" y="212" fill="#FFFFFF" font-family="Helvetica" font-size="11px" text-anchor="middle" font-weight="bold">HTTP Request</text></switch></g><rect x="242" y="137" width="80" height="40" rx="6" ry="6" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 157px; margin-left: 243px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Gateway<br />Service</div></div></div></foreignObject><text x="282" y="161" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Gateway...</text></switch></g><rect x="0" y="29" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 49px; margin-left: 1px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Container<br />Service</div></div></div></foreignObject><text x="40" y="53" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Container...</text></switch></g><rect x="120" y="29" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 49px; margin-left: 121px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Database Service</div></div></div></foreignObject><text x="160" y="53" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Database Serv...</text></switch></g><rect x="481" y="29" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 49px; margin-left: 482px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Table<br />Service</div></div></div></foreignObject><text x="521" y="53" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Table...</text></switch></g><rect x="362" y="29" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 49px; margin-left: 363px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Query<br />Service</div></div></div></foreignObject><text x="402" y="53" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Query...</text></switch></g><rect x="0" y="267" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 287px; margin-left: 1px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Identifier<br />Service</div></div></div></foreignObject><text x="40" y="291" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Identifier...</text></switch></g><rect x="362" y="267" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 287px; margin-left: 363px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Analyse<br />Service</div></div></div></foreignObject><text x="402" y="291" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Analyse...</text></switch></g><rect x="482" y="267" width="80" height="40" rx="6" ry="6" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 287px; margin-left: 483px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Units<br />Service</div></div></div></foreignObject><text x="522" y="291" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Units...</text></switch></g><path d="M 282 22.63 L 282 9 L 282 37 L 282 17" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 282 27.88 L 278.5 20.88 L 282 22.63 L 285.5 20.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 7px; margin-left: 283px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; background-color: rgb(255, 255, 255); white-space: nowrap;">AMQP Tuple</div></div></div></foreignObject><text x="283" y="10" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="middle" font-weight="bold">AMQP Tuple</text></switch></g><path d="M 290 69 L 290 103 L 289.74 130.47" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 289.69 135.72 L 286.26 128.69 L 289.74 130.47 L 293.26 128.76 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 84px; margin-left: 320px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 8px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; background-color: rgb(255, 255, 255); white-space: nowrap;">/api/container/{id}/database/{id}/table/{id}/data</div></div></div></foreignObject><text x="320" y="86" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="8px" text-anchor="middle">/api/container/{id}/database/{id}/table/{id}/data</text></switch></g><rect x="242" y="29" width="80" height="40" rx="6" ry="6" fill="rgb(255, 255, 255)" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 49px; margin-left: 243px;"><div data-drawio-colors="color: rgb(0, 0, 0); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Broker Service</div></div></div></foreignObject><text x="282" y="53" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="12px" text-anchor="middle">Broker Service</text></switch></g><rect x="120" y="267" width="80" height="40" rx="6" ry="6" fill="#007f7f" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 287px; margin-left: 121px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Authentication<br />Service</div></div></div></foreignObject><text x="160" y="291" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Authenticatio...</text></switch></g><path d="M 281 260.63 L 281 247 L 281 268 L 281 248" fill="none" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 281 265.88 L 277.5 258.88 L 281 260.63 L 284.5 258.88 Z" fill="rgb(0, 0, 0)" stroke="rgb(0, 0, 0)" stroke-miterlimit="10" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 1px; height: 1px; padding-top: 239px; margin-left: 283px;"><div data-drawio-colors="color: rgb(0, 0, 0); background-color: rgb(255, 255, 255); " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 11px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; pointer-events: all; font-weight: bold; background-color: rgb(255, 255, 255); white-space: nowrap;">JDBC</div></div></div></foreignObject><text x="283" y="242" fill="rgb(0, 0, 0)" font-family="Helvetica" font-size="11px" text-anchor="middle" font-weight="bold">JDBC</text></switch></g><rect x="241" y="267" width="80" height="40" rx="6" ry="6" fill="#fd7d25" stroke="rgb(0, 0, 0)" pointer-events="all"/><g transform="translate(-0.5 -0.5)"><switch><foreignObject pointer-events="none" width="100%" height="100%" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility" style="overflow: visible; text-align: left;"><div xmlns="http://www.w3.org/1999/xhtml" style="display: flex; align-items: unsafe center; justify-content: unsafe center; width: 78px; height: 1px; padding-top: 287px; margin-left: 242px;"><div data-drawio-colors="color: #FFFFFF; " style="box-sizing: border-box; font-size: 0px; text-align: center;"><div style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(255, 255, 255); line-height: 1.2; pointer-events: all; white-space: normal; overflow-wrap: normal;">Database</div></div></div></foreignObject><text x="281" y="291" fill="#FFFFFF" font-family="Helvetica" font-size="12px" text-anchor="middle">Database</text></switch></g></g><switch><g requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"/><a transform="translate(0,-5)" xlink:href="https://www.diagrams.net/doc/faq/svg-export-text-problems" target="_blank"><text text-anchor="middle" font-size="10px" x="50%" y="100%">Text is not SVG - cannot display</text></a></switch></svg> \ No newline at end of file diff --git a/docs/operation/endpoints/authentication.md b/docs/operation/endpoints/authentication.md deleted file mode 100644 index ffba93f..0000000 --- a/docs/operation/endpoints/authentication.md +++ /dev/null @@ -1,2449 +0,0 @@ ---- -title: Database Repository Authentication Service API v1.1.0-alpha -language_tabs: - - python: Python - - java: Java -toc_footers: - - <a - href="https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis">Wiki - Documentation</a> -includes: [] -search: true -highlight_theme: darkula -headingLevel: 2 - ---- - -<!-- Generator: Widdershins v4.0.1 --> - -<h1 id="database-repository-authentication-service-api">Database Repository Authentication Service API v1.1.0-alpha</h1> - -> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. - -Service that manages the authentication - -Base URLs: - -* <a href="http://localhost:9097">http://localhost:9097</a> - -Email: <a href="mailto:andreas.rauber@tuwien.ac.at">Prof. Andreas Rauber</a> -License: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a> - -# Authentication - -- HTTP Authentication, scheme: bearer - -<h1 id="database-repository-authentication-service-api-authentication-endpoint">authentication-endpoint</h1> - -## authenticateUser - -<a id="opIdauthenticateUser"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9097/api/auth', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9097/api/auth"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/auth` - -*Validate token* - -> Example responses - -> 200 Response - -<h3 id="authenticateuser-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[UserDto](#schemauserdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|417|[Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)|Expectation Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## authenticateUser_1 - -<a id="opIdauthenticateUser_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*' -} - -r = requests.post('http://localhost:9097/api/auth', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9097/api/auth"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/auth` - -*Create token* - -> Body parameter - -```json -{ - "username": "string", - "password": "string" -} -``` - -<h3 id="authenticateuser_1-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|body|body|[LoginRequestDto](#schemaloginrequestdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="authenticateuser_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[JwtResponseDto](#schemajwtresponsedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|417|[Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)|Expectation Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -<h1 id="database-repository-authentication-service-api-user-endpoint">user-endpoint</h1> - -## list - -<a id="opIdlist"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.get('http://localhost:9097/api/user', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9097/api/user"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/user` - -*List users* - -> Example responses - -> 200 Response - -<h3 id="list-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|417|[Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)|Expectation Failed|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="list-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[UserDto](#schemauserdto)]|false|none|none| -|» id|integer(int64)|false|none|none| -|» authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|»» authority|string|false|none|none| -|» username|string|true|none|none| -|» titlesBefore|string|true|none|none| -|» titlesAfter|string|true|none|none| -|» firstname|string|true|none|none| -|» lastname|string|true|none|none| -|» containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|»» id|integer(int64)|true|none|none| -|»» hash|string|true|none|none| -|»» name|string|true|none|none| -|»» state|string|true|none|none| -|»» databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|»»» id|integer(int64)|true|none|none| -|»»» name|string|true|none|none| -|»»» description|string|true|none|none| -|»»» publisher|string|false|none|none| -|»»» license|string|false|none|none| -|»»» contact|[UserDto](#schemauserdto)|false|none|none| -|»»» tables|[[TableDto](#schematabledto)]|true|none|none| -|»»»» id|integer(int64)|true|none|none| -|»»»» name|string|true|none|none| -|»»»» topic|string|true|none|none| -|»»»» description|string|true|none|none| -|»»»» separator|string|true|none|none| -|»»»» quote|string|true|none|none| -|»»»» created|string(date-time)|false|none|none| -|»»»» columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|»»»»» id|integer(int64)|true|none|none| -|»»»»» name|string|true|none|none| -|»»»»» unique|boolean|true|none|none| -|»»»»» references|string|false|none|none| -|»»»»» internal_name|string|true|none|none| -|»»»»» date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|»»»»»» id|integer(int64)|true|none|none| -|»»»»»» example|string|true|none|none| -|»»»»»» database_format|string|true|none|none| -|»»»»»» unix_format|string|true|none|none| -|»»»»»» created_at|string(date-time)|false|none|none| -|»»»»» auto_generated|boolean|true|none|none| -|»»»»» is_primary_key|boolean|true|none|none| -|»»»»» column_type|string|true|none|none| -|»»»»» column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|»»»»»» uri|string|true|none|none| -|»»»»»» name|string|true|none|none| -|»»»»»» created|string(date-time)|true|none|none| -|»»»»» decimal_digits_before|integer(int64)|false|none|none| -|»»»»» decimal_digits_after|integer(int64)|false|none|none| -|»»»»» is_null_allowed|boolean|true|none|none| -|»»»»» check_expression|string|false|none|none| -|»»»»» foreign_key|string|false|none|none| -|»»»»» enum_values|[string]|false|none|none| -|»»»» internal_name|string|true|none|none| -|»»»» null_element|string|true|none|none| -|»»»» skip_lines|integer(int64)|false|none|none| -|»»»» true_element|string|false|none|none| -|»»»» false_element|string|false|none|none| -|»»» exchange|string|true|none|none| -|»»» image|[ImageDto](#schemaimagedto)|true|none|none| -|»»»» id|integer(int64)|true|none|none| -|»»»» repository|string|true|none|none| -|»»»» tag|string|true|none|none| -|»»»» logo|string|false|none|none| -|»»»» dialect|string|true|none|none| -|»»»» hash|string|false|none|none| -|»»»» compiled|string(date-time)|false|none|none| -|»»»» size|integer|false|none|none| -|»»»» environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|»»»»» iid|integer(int64)|true|none|none| -|»»»»» key|string|true|none|none| -|»»»»» value|string|true|none|none| -|»»»»» type|string|false|none|none| -|»»»» driver_class|string|true|none|none| -|»»»» date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|»»»» jdbc_method|string|true|none|none| -|»»»» default_port|integer(int32)|true|none|none| -|»»» container|[ContainerDto](#schemacontainerdto)|true|none|none| -|»»» created|string(date-time)|false|none|none| -|»»» deleted|string(date-time)|false|none|none| -|»»» internal_name|string|true|none|none| -|»» image|[ImageDto](#schemaimagedto)|true|none|none| -|»» port|integer(int32)|true|none|none| -|»» created|string(date-time)|true|none|none| -|»» internal_name|string|true|none|none| -|»» ip_address|string|true|none|none| -|»» is_public|boolean|true|none|none| -|» databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|» identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|» email|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## register - -<a id="opIdregister"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*' -} - -r = requests.post('http://localhost:9097/api/user', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9097/api/user"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/user` - -*Create user* - -> Body parameter - -```json -{ - "username": "string", - "email": "string", - "password": "string" -} -``` - -<h3 id="register-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|body|body|[SignupRequestDto](#schemasignuprequestdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="register-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[UserDto](#schemauserdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|417|[Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)|Expectation Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -# Schemas - -<h2 id="tocS_ApiErrorDto">ApiErrorDto</h2> -<!-- backwards compatibility --> -<a id="schemaapierrordto"></a> -<a id="schema_ApiErrorDto"></a> -<a id="tocSapierrordto"></a> -<a id="tocsapierrordto"></a> - -```json -{ - "status": "100 CONTINUE", - "message": "string", - "code": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|status|string|true|none|none| -|message|string|true|none|none| -|code|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|status|100 CONTINUE| -|status|101 SWITCHING_PROTOCOLS| -|status|102 PROCESSING| -|status|103 CHECKPOINT| -|status|200 OK| -|status|201 CREATED| -|status|202 ACCEPTED| -|status|203 NON_AUTHORITATIVE_INFORMATION| -|status|204 NO_CONTENT| -|status|205 RESET_CONTENT| -|status|206 PARTIAL_CONTENT| -|status|207 MULTI_STATUS| -|status|208 ALREADY_REPORTED| -|status|226 IM_USED| -|status|300 MULTIPLE_CHOICES| -|status|301 MOVED_PERMANENTLY| -|status|302 FOUND| -|status|302 MOVED_TEMPORARILY| -|status|303 SEE_OTHER| -|status|304 NOT_MODIFIED| -|status|305 USE_PROXY| -|status|307 TEMPORARY_REDIRECT| -|status|308 PERMANENT_REDIRECT| -|status|400 BAD_REQUEST| -|status|401 UNAUTHORIZED| -|status|402 PAYMENT_REQUIRED| -|status|403 FORBIDDEN| -|status|404 NOT_FOUND| -|status|405 METHOD_NOT_ALLOWED| -|status|406 NOT_ACCEPTABLE| -|status|407 PROXY_AUTHENTICATION_REQUIRED| -|status|408 REQUEST_TIMEOUT| -|status|409 CONFLICT| -|status|410 GONE| -|status|411 LENGTH_REQUIRED| -|status|412 PRECONDITION_FAILED| -|status|413 PAYLOAD_TOO_LARGE| -|status|413 REQUEST_ENTITY_TOO_LARGE| -|status|414 URI_TOO_LONG| -|status|414 REQUEST_URI_TOO_LONG| -|status|415 UNSUPPORTED_MEDIA_TYPE| -|status|416 REQUESTED_RANGE_NOT_SATISFIABLE| -|status|417 EXPECTATION_FAILED| -|status|418 I_AM_A_TEAPOT| -|status|419 INSUFFICIENT_SPACE_ON_RESOURCE| -|status|420 METHOD_FAILURE| -|status|421 DESTINATION_LOCKED| -|status|422 UNPROCESSABLE_ENTITY| -|status|423 LOCKED| -|status|424 FAILED_DEPENDENCY| -|status|425 TOO_EARLY| -|status|426 UPGRADE_REQUIRED| -|status|428 PRECONDITION_REQUIRED| -|status|429 TOO_MANY_REQUESTS| -|status|431 REQUEST_HEADER_FIELDS_TOO_LARGE| -|status|451 UNAVAILABLE_FOR_LEGAL_REASONS| -|status|500 INTERNAL_SERVER_ERROR| -|status|501 NOT_IMPLEMENTED| -|status|502 BAD_GATEWAY| -|status|503 SERVICE_UNAVAILABLE| -|status|504 GATEWAY_TIMEOUT| -|status|505 HTTP_VERSION_NOT_SUPPORTED| -|status|506 VARIANT_ALSO_NEGOTIATES| -|status|507 INSUFFICIENT_STORAGE| -|status|508 LOOP_DETECTED| -|status|509 BANDWIDTH_LIMIT_EXCEEDED| -|status|510 NOT_EXTENDED| -|status|511 NETWORK_AUTHENTICATION_REQUIRED| - -<h2 id="tocS_ColumnDto">ColumnDto</h2> -<!-- backwards compatibility --> -<a id="schemacolumndto"></a> -<a id="schema_ColumnDto"></a> -<a id="tocScolumndto"></a> -<a id="tocscolumndto"></a> - -```json -{ - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|unique|boolean|true|none|none| -|references|string|false|none|none| -|internal_name|string|true|none|none| -|date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|auto_generated|boolean|true|none|none| -|is_primary_key|boolean|true|none|none| -|column_type|string|true|none|none| -|column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|decimal_digits_before|integer(int64)|false|none|none| -|decimal_digits_after|integer(int64)|false|none|none| -|is_null_allowed|boolean|true|none|none| -|check_expression|string|false|none|none| -|foreign_key|string|false|none|none| -|enum_values|[string]|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| - -<h2 id="tocS_ConceptDto">ConceptDto</h2> -<!-- backwards compatibility --> -<a id="schemaconceptdto"></a> -<a id="schema_ConceptDto"></a> -<a id="tocSconceptdto"></a> -<a id="tocsconceptdto"></a> - -```json -{ - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|uri|string|true|none|none| -|name|string|true|none|none| -|created|string(date-time)|true|none|none| - -<h2 id="tocS_ContainerDto">ContainerDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerdto"></a> -<a id="schema_ContainerDto"></a> -<a id="tocScontainerdto"></a> -<a id="tocscontainerdto"></a> - -```json -{ - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|hash|string|true|none|none| -|name|string|true|none|none| -|state|string|true|none|none| -|databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|port|integer(int32)|true|none|none| -|created|string(date-time)|true|none|none| -|internal_name|string|true|none|none| -|ip_address|string|true|none|none| -|is_public|boolean|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| - -<h2 id="tocS_DatabaseDto">DatabaseDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasedto"></a> -<a id="schema_DatabaseDto"></a> -<a id="tocSdatabasedto"></a> -<a id="tocsdatabasedto"></a> - -```json -{ - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|description|string|true|none|none| -|publisher|string|false|none|none| -|license|string|false|none|none| -|contact|[UserDto](#schemauserdto)|false|none|none| -|tables|[[TableDto](#schematabledto)]|true|none|none| -|exchange|string|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|container|[ContainerDto](#schemacontainerdto)|true|none|none| -|created|string(date-time)|false|none|none| -|deleted|string(date-time)|false|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_GrantedAuthorityDto">GrantedAuthorityDto</h2> -<!-- backwards compatibility --> -<a id="schemagrantedauthoritydto"></a> -<a id="schema_GrantedAuthorityDto"></a> -<a id="tocSgrantedauthoritydto"></a> -<a id="tocsgrantedauthoritydto"></a> - -```json -{ - "authority": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|authority|string|false|none|none| - -<h2 id="tocS_ImageDateDto">ImageDateDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedatedto"></a> -<a id="schema_ImageDateDto"></a> -<a id="tocSimagedatedto"></a> -<a id="tocsimagedatedto"></a> - -```json -{ - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|example|string|true|none|none| -|database_format|string|true|none|none| -|unix_format|string|true|none|none| -|created_at|string(date-time)|false|none|none| - -<h2 id="tocS_ImageDto">ImageDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedto"></a> -<a id="schema_ImageDto"></a> -<a id="tocSimagedto"></a> -<a id="tocsimagedto"></a> - -```json -{ - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|repository|string|true|none|none| -|tag|string|true|none|none| -|logo|string|false|none|none| -|dialect|string|true|none|none| -|hash|string|false|none|none| -|compiled|string(date-time)|false|none|none| -|size|integer|false|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|driver_class|string|true|none|none| -|date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|jdbc_method|string|true|none|none| -|default_port|integer(int32)|true|none|none| - -<h2 id="tocS_ImageEnvItemDto">ImageEnvItemDto</h2> -<!-- backwards compatibility --> -<a id="schemaimageenvitemdto"></a> -<a id="schema_ImageEnvItemDto"></a> -<a id="tocSimageenvitemdto"></a> -<a id="tocsimageenvitemdto"></a> - -```json -{ - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|iid|integer(int64)|true|none|none| -|key|string|true|none|none| -|value|string|true|none|none| -|type|string|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<h2 id="tocS_TableDto">TableDto</h2> -<!-- backwards compatibility --> -<a id="schematabledto"></a> -<a id="schema_TableDto"></a> -<a id="tocStabledto"></a> -<a id="tocstabledto"></a> - -```json -{ - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|topic|string|true|none|none| -|description|string|true|none|none| -|separator|string|true|none|none| -|quote|string|true|none|none| -|created|string(date-time)|false|none|none| -|columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|internal_name|string|true|none|none| -|null_element|string|true|none|none| -|skip_lines|integer(int64)|false|none|none| -|true_element|string|false|none|none| -|false_element|string|false|none|none| - -<h2 id="tocS_UserDto">UserDto</h2> -<!-- backwards compatibility --> -<a id="schemauserdto"></a> -<a id="schema_UserDto"></a> -<a id="tocSuserdto"></a> -<a id="tocsuserdto"></a> - -```json -{ - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|false|none|none| -|authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|username|string|true|none|none| -|titlesBefore|string|true|none|none| -|titlesAfter|string|true|none|none| -|firstname|string|true|none|none| -|lastname|string|true|none|none| -|containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|email|string|true|none|none| - -<h2 id="tocS_SignupRequestDto">SignupRequestDto</h2> -<!-- backwards compatibility --> -<a id="schemasignuprequestdto"></a> -<a id="schema_SignupRequestDto"></a> -<a id="tocSsignuprequestdto"></a> -<a id="tocssignuprequestdto"></a> - -```json -{ - "username": "string", - "email": "string", - "password": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|username|string|true|none|none| -|email|string|true|none|none| -|password|string|true|none|none| - -<h2 id="tocS_LoginRequestDto">LoginRequestDto</h2> -<!-- backwards compatibility --> -<a id="schemaloginrequestdto"></a> -<a id="schema_LoginRequestDto"></a> -<a id="tocSloginrequestdto"></a> -<a id="tocsloginrequestdto"></a> - -```json -{ - "username": "string", - "password": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|username|string|true|none|none| -|password|string|true|none|none| - -<h2 id="tocS_JwtResponseDto">JwtResponseDto</h2> -<!-- backwards compatibility --> -<a id="schemajwtresponsedto"></a> -<a id="schema_JwtResponseDto"></a> -<a id="tocSjwtresponsedto"></a> -<a id="tocsjwtresponsedto"></a> - -```json -{ - "token": "string", - "type": "string", - "id": 0, - "username": "string", - "email": "string", - "roles": [ - "string" - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|token|string|true|none|none| -|type|string|true|none|none| -|id|integer(int64)|true|none|none| -|username|string|true|none|none| -|email|string|true|none|none| -|roles|[string]|true|none|none| - diff --git a/docs/operation/endpoints/container.md b/docs/operation/endpoints/container.md deleted file mode 100644 index e22efa9..0000000 --- a/docs/operation/endpoints/container.md +++ /dev/null @@ -1,2902 +0,0 @@ ---- -title: Database Repository Container Service API v1.1.0-alpha -language_tabs: - - python: Python - - java: Java -toc_footers: - - <a - href="https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis">Wiki - Documentation</a> -includes: [] -search: true -highlight_theme: darkula -headingLevel: 2 - ---- - -<!-- Generator: Widdershins v4.0.1 --> - -<h1 id="database-repository-container-service-api">Database Repository Container Service API v1.1.0-alpha</h1> - -> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. - -Service that manages the containers - -Base URLs: - -* <a href="http://localhost:9091">http://localhost:9091</a> - -Email: <a href="mailto:andreas.rauber@tuwien.ac.at">Prof. Andreas Rauber</a> -License: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a> - -# Authentication - -- HTTP Authentication, scheme: bearer - -<h1 id="database-repository-container-service-api-image-endpoint">image-endpoint</h1> - -## findById - -<a id="opIdfindById"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9091/api/image/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/image/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/image/{id}` - -*Find some image* - -<h3 id="findbyid-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="findbyid-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ImageDto](#schemaimagedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -## update - -<a id="opIdupdate"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9091/api/image/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/image/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/image/{id}` - -*Update some image* - -> Body parameter - -```json -{ - "defaultPort": 1024, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "logo": "string", - "dialect": "string", - "driver_class": "string", - "jdbc_method": "string" -} -``` - -<h3 id="update-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|body|body|[ImageChangeDto](#schemaimagechangedto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="update-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ImageDto](#schemaimagedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## delete - -<a id="opIddelete"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.delete('http://localhost:9091/api/image/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/image/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("DELETE"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`DELETE /api/image/{id}` - -*Delete some image* - -<h3 id="delete-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="delete-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="delete-responseschema">Response Schema</h3> - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## findAll - -<a id="opIdfindAll"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9091/api/image', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/image"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/image` - -*Find all images* - -> Example responses - -> 200 Response - -<h3 id="findall-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="findall-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[ImageBriefDto](#schemaimagebriefdto)]|false|none|none| -|» id|integer(int64)|true|none|none| -|» repository|string|true|none|none| -|» logo|string|false|none|none| -|» tag|string|true|none|none| - -<aside class="success"> -This operation does not require authentication -</aside> - -## create - -<a id="opIdcreate"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9091/api/image', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/image"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/image` - -*Create image* - -> Body parameter - -```json -{ - "repository": "string", - "tag": "string", - "dialect": "string", - "logo": "string", - "local": true, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "jdbc_method": "string", - "default_port": 0 -} -``` - -<h3 id="create-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|body|body|[ImageCreateDto](#schemaimagecreatedto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="create-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ImageDto](#schemaimagedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -<h1 id="database-repository-container-service-api-container-endpoint">container-endpoint</h1> - -## findById_1 - -<a id="opIdfindById_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9091/api/container/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/container/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}` - -*Find some container* - -<h3 id="findbyid_1-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="findbyid_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ContainerDto](#schemacontainerdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -## modify - -<a id="opIdmodify"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9091/api/container/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/container/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/container/{id}` - -*Modify some container* - -> Body parameter - -```json -{ - "action": "ContainerActionTypeDto.START" -} -``` - -<h3 id="modify-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|body|body|[ContainerChangeDto](#schemacontainerchangedto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="modify-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ContainerBriefDto](#schemacontainerbriefdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## delete_1 - -<a id="opIddelete_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.delete('http://localhost:9091/api/container/{id}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/container/{id}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("DELETE"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`DELETE /api/container/{id}` - -*Delete some container* - -<h3 id="delete_1-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="delete_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="delete_1-responseschema">Response Schema</h3> - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## findAll_1 - -<a id="opIdfindAll_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9091/api/container', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/container"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container` - -*Find all containers* - -> Example responses - -> 200 Response - -<h3 id="findall_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="findall_1-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[ContainerBriefDto](#schemacontainerbriefdto)]|false|none|none| -|» id|integer(int64)|true|none|none| -|» hash|string|true|none|none| -|» name|string|true|none|none| -|» internal_name|string|true|none|none| -|» is_public|boolean|true|none|none| - -<aside class="success"> -This operation does not require authentication -</aside> - -## create_1 - -<a id="opIdcreate_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9091/api/container', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9091/api/container"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container` - -*Create container* - -> Body parameter - -```json -{ - "name": "string", - "repository": "string", - "tag": "string" -} -``` - -<h3 id="create_1-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|body|body|[ContainerCreateRequestDto](#schemacontainercreaterequestdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="create_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[ContainerBriefDto](#schemacontainerbriefdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|403|[Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)|Forbidden|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -# Schemas - -<h2 id="tocS_ApiErrorDto">ApiErrorDto</h2> -<!-- backwards compatibility --> -<a id="schemaapierrordto"></a> -<a id="schema_ApiErrorDto"></a> -<a id="tocSapierrordto"></a> -<a id="tocsapierrordto"></a> - -```json -{ - "status": "100 CONTINUE", - "message": "string", - "code": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|status|string|true|none|none| -|message|string|true|none|none| -|code|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|status|100 CONTINUE| -|status|101 SWITCHING_PROTOCOLS| -|status|102 PROCESSING| -|status|103 CHECKPOINT| -|status|200 OK| -|status|201 CREATED| -|status|202 ACCEPTED| -|status|203 NON_AUTHORITATIVE_INFORMATION| -|status|204 NO_CONTENT| -|status|205 RESET_CONTENT| -|status|206 PARTIAL_CONTENT| -|status|207 MULTI_STATUS| -|status|208 ALREADY_REPORTED| -|status|226 IM_USED| -|status|300 MULTIPLE_CHOICES| -|status|301 MOVED_PERMANENTLY| -|status|302 FOUND| -|status|302 MOVED_TEMPORARILY| -|status|303 SEE_OTHER| -|status|304 NOT_MODIFIED| -|status|305 USE_PROXY| -|status|307 TEMPORARY_REDIRECT| -|status|308 PERMANENT_REDIRECT| -|status|400 BAD_REQUEST| -|status|401 UNAUTHORIZED| -|status|402 PAYMENT_REQUIRED| -|status|403 FORBIDDEN| -|status|404 NOT_FOUND| -|status|405 METHOD_NOT_ALLOWED| -|status|406 NOT_ACCEPTABLE| -|status|407 PROXY_AUTHENTICATION_REQUIRED| -|status|408 REQUEST_TIMEOUT| -|status|409 CONFLICT| -|status|410 GONE| -|status|411 LENGTH_REQUIRED| -|status|412 PRECONDITION_FAILED| -|status|413 PAYLOAD_TOO_LARGE| -|status|413 REQUEST_ENTITY_TOO_LARGE| -|status|414 URI_TOO_LONG| -|status|414 REQUEST_URI_TOO_LONG| -|status|415 UNSUPPORTED_MEDIA_TYPE| -|status|416 REQUESTED_RANGE_NOT_SATISFIABLE| -|status|417 EXPECTATION_FAILED| -|status|418 I_AM_A_TEAPOT| -|status|419 INSUFFICIENT_SPACE_ON_RESOURCE| -|status|420 METHOD_FAILURE| -|status|421 DESTINATION_LOCKED| -|status|422 UNPROCESSABLE_ENTITY| -|status|423 LOCKED| -|status|424 FAILED_DEPENDENCY| -|status|425 TOO_EARLY| -|status|426 UPGRADE_REQUIRED| -|status|428 PRECONDITION_REQUIRED| -|status|429 TOO_MANY_REQUESTS| -|status|431 REQUEST_HEADER_FIELDS_TOO_LARGE| -|status|451 UNAVAILABLE_FOR_LEGAL_REASONS| -|status|500 INTERNAL_SERVER_ERROR| -|status|501 NOT_IMPLEMENTED| -|status|502 BAD_GATEWAY| -|status|503 SERVICE_UNAVAILABLE| -|status|504 GATEWAY_TIMEOUT| -|status|505 HTTP_VERSION_NOT_SUPPORTED| -|status|506 VARIANT_ALSO_NEGOTIATES| -|status|507 INSUFFICIENT_STORAGE| -|status|508 LOOP_DETECTED| -|status|509 BANDWIDTH_LIMIT_EXCEEDED| -|status|510 NOT_EXTENDED| -|status|511 NETWORK_AUTHENTICATION_REQUIRED| - -<h2 id="tocS_ImageChangeDto">ImageChangeDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagechangedto"></a> -<a id="schema_ImageChangeDto"></a> -<a id="tocSimagechangedto"></a> -<a id="tocsimagechangedto"></a> - -```json -{ - "defaultPort": 1024, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "logo": "string", - "dialect": "string", - "driver_class": "string", - "jdbc_method": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|defaultPort|integer(int32)|false|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|false|none|none| -|logo|string|true|none|none| -|dialect|string|true|none|none| -|driver_class|string|true|none|none| -|jdbc_method|string|true|none|none| - -<h2 id="tocS_ImageEnvItemDto">ImageEnvItemDto</h2> -<!-- backwards compatibility --> -<a id="schemaimageenvitemdto"></a> -<a id="schema_ImageEnvItemDto"></a> -<a id="tocSimageenvitemdto"></a> -<a id="tocsimageenvitemdto"></a> - -```json -{ - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|iid|integer(int64)|true|none|none| -|key|string|true|none|none| -|value|string|true|none|none| -|type|string|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<h2 id="tocS_ImageDateDto">ImageDateDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedatedto"></a> -<a id="schema_ImageDateDto"></a> -<a id="tocSimagedatedto"></a> -<a id="tocsimagedatedto"></a> - -```json -{ - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|example|string|true|none|none| -|database_format|string|true|none|none| -|unix_format|string|true|none|none| -|created_at|string(date-time)|false|none|none| - -<h2 id="tocS_ImageDto">ImageDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedto"></a> -<a id="schema_ImageDto"></a> -<a id="tocSimagedto"></a> -<a id="tocsimagedto"></a> - -```json -{ - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|repository|string|true|none|none| -|tag|string|true|none|none| -|logo|string|false|none|none| -|dialect|string|true|none|none| -|hash|string|false|none|none| -|compiled|string(date-time)|false|none|none| -|size|integer|false|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|driver_class|string|true|none|none| -|date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|jdbc_method|string|true|none|none| -|default_port|integer(int32)|true|none|none| - -<h2 id="tocS_ContainerChangeDto">ContainerChangeDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerchangedto"></a> -<a id="schema_ContainerChangeDto"></a> -<a id="tocScontainerchangedto"></a> -<a id="tocscontainerchangedto"></a> - -```json -{ - "action": "ContainerActionTypeDto.START" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|action|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|action|ContainerActionTypeDto.START| -|action|ContainerActionTypeDto.STOP| - -<h2 id="tocS_ContainerBriefDto">ContainerBriefDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerbriefdto"></a> -<a id="schema_ContainerBriefDto"></a> -<a id="tocScontainerbriefdto"></a> -<a id="tocscontainerbriefdto"></a> - -```json -{ - "id": 0, - "hash": "string", - "name": "string", - "internal_name": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|hash|string|true|none|none| -|name|string|true|none|none| -|internal_name|string|true|none|none| -|is_public|boolean|true|none|none| - -<h2 id="tocS_ImageCreateDto">ImageCreateDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagecreatedto"></a> -<a id="schema_ImageCreateDto"></a> -<a id="tocSimagecreatedto"></a> -<a id="tocsimagecreatedto"></a> - -```json -{ - "repository": "string", - "tag": "string", - "dialect": "string", - "logo": "string", - "local": true, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "jdbc_method": "string", - "default_port": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|repository|string|true|none|none| -|tag|string|true|none|none| -|dialect|string|true|none|none| -|logo|string|true|none|none| -|local|boolean|true|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|false|none|none| -|driver_class|string|true|none|none| -|jdbc_method|string|true|none|none| -|default_port|integer(int32)|true|none|none| - -<h2 id="tocS_ContainerCreateRequestDto">ContainerCreateRequestDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainercreaterequestdto"></a> -<a id="schema_ContainerCreateRequestDto"></a> -<a id="tocScontainercreaterequestdto"></a> -<a id="tocscontainercreaterequestdto"></a> - -```json -{ - "name": "string", - "repository": "string", - "tag": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|name|string|true|none|none| -|repository|string|true|none|none| -|tag|string|true|none|none| - -<h2 id="tocS_ImageBriefDto">ImageBriefDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagebriefdto"></a> -<a id="schema_ImageBriefDto"></a> -<a id="tocSimagebriefdto"></a> -<a id="tocsimagebriefdto"></a> - -```json -{ - "id": 0, - "repository": "string", - "logo": "string", - "tag": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|repository|string|true|none|none| -|logo|string|false|none|none| -|tag|string|true|none|none| - -<h2 id="tocS_ColumnDto">ColumnDto</h2> -<!-- backwards compatibility --> -<a id="schemacolumndto"></a> -<a id="schema_ColumnDto"></a> -<a id="tocScolumndto"></a> -<a id="tocscolumndto"></a> - -```json -{ - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|unique|boolean|true|none|none| -|references|string|false|none|none| -|internal_name|string|true|none|none| -|date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|auto_generated|boolean|true|none|none| -|is_primary_key|boolean|true|none|none| -|column_type|string|true|none|none| -|column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|decimal_digits_before|integer(int64)|false|none|none| -|decimal_digits_after|integer(int64)|false|none|none| -|is_null_allowed|boolean|true|none|none| -|check_expression|string|false|none|none| -|foreign_key|string|false|none|none| -|enum_values|[string]|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| - -<h2 id="tocS_ConceptDto">ConceptDto</h2> -<!-- backwards compatibility --> -<a id="schemaconceptdto"></a> -<a id="schema_ConceptDto"></a> -<a id="tocSconceptdto"></a> -<a id="tocsconceptdto"></a> - -```json -{ - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|uri|string|true|none|none| -|name|string|true|none|none| -|created|string(date-time)|true|none|none| - -<h2 id="tocS_ContainerDto">ContainerDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerdto"></a> -<a id="schema_ContainerDto"></a> -<a id="tocScontainerdto"></a> -<a id="tocscontainerdto"></a> - -```json -{ - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|hash|string|true|none|none| -|name|string|true|none|none| -|state|string|true|none|none| -|databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|port|integer(int32)|true|none|none| -|created|string(date-time)|true|none|none| -|internal_name|string|true|none|none| -|ip_address|string|true|none|none| -|is_public|boolean|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| - -<h2 id="tocS_DatabaseDto">DatabaseDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasedto"></a> -<a id="schema_DatabaseDto"></a> -<a id="tocSdatabasedto"></a> -<a id="tocsdatabasedto"></a> - -```json -{ - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|description|string|true|none|none| -|publisher|string|false|none|none| -|license|string|false|none|none| -|contact|[UserDto](#schemauserdto)|false|none|none| -|tables|[[TableDto](#schematabledto)]|true|none|none| -|exchange|string|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|container|[ContainerDto](#schemacontainerdto)|true|none|none| -|created|string(date-time)|false|none|none| -|deleted|string(date-time)|false|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_GrantedAuthorityDto">GrantedAuthorityDto</h2> -<!-- backwards compatibility --> -<a id="schemagrantedauthoritydto"></a> -<a id="schema_GrantedAuthorityDto"></a> -<a id="tocSgrantedauthoritydto"></a> -<a id="tocsgrantedauthoritydto"></a> - -```json -{ - "authority": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|authority|string|false|none|none| - -<h2 id="tocS_TableDto">TableDto</h2> -<!-- backwards compatibility --> -<a id="schematabledto"></a> -<a id="schema_TableDto"></a> -<a id="tocStabledto"></a> -<a id="tocstabledto"></a> - -```json -{ - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|topic|string|true|none|none| -|description|string|true|none|none| -|separator|string|true|none|none| -|quote|string|true|none|none| -|created|string(date-time)|false|none|none| -|columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|internal_name|string|true|none|none| -|null_element|string|true|none|none| -|skip_lines|integer(int64)|false|none|none| -|true_element|string|false|none|none| -|false_element|string|false|none|none| - -<h2 id="tocS_UserDto">UserDto</h2> -<!-- backwards compatibility --> -<a id="schemauserdto"></a> -<a id="schema_UserDto"></a> -<a id="tocSuserdto"></a> -<a id="tocsuserdto"></a> - -```json -{ - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|false|none|none| -|authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|username|string|true|none|none| -|titlesBefore|string|true|none|none| -|titlesAfter|string|true|none|none| -|firstname|string|true|none|none| -|lastname|string|true|none|none| -|containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|email|string|true|none|none| - diff --git a/docs/operation/endpoints/database.md b/docs/operation/endpoints/database.md deleted file mode 100644 index 89136d5..0000000 --- a/docs/operation/endpoints/database.md +++ /dev/null @@ -1,2320 +0,0 @@ ---- -title: Database Repository Database Service API v1.1.0-alpha -language_tabs: - - python: Python - - java: Java -toc_footers: - - <a - href="https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis">Wiki - Documentation</a> -includes: [] -search: true -highlight_theme: darkula -headingLevel: 2 - ---- - -<!-- Generator: Widdershins v4.0.1 --> - -<h1 id="database-repository-database-service-api">Database Repository Database Service API v1.1.0-alpha</h1> - -> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. - -Service that manages the databases - -Base URLs: - -* <a href="http://localhost:9092">http://localhost:9092</a> - -Email: <a href="mailto:andreas.rauber@tuwien.ac.at">Prof. Andreas Rauber</a> -License: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a> - -# Authentication - -- HTTP Authentication, scheme: bearer - -<h1 id="database-repository-database-service-api-container-database-endpoint">container-database-endpoint</h1> - -## findAll - -<a id="opIdfindAll"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9092/api/container/{id}/database', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9092/api/container/{id}/database"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database` - -*List databases* - -<h3 id="findall-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="findall-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|502|[Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)|Bad Gateway|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="findall-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[DatabaseBriefDto](#schemadatabasebriefdto)]|false|none|none| -|» id|integer(int64)|true|none|none| -|» name|string|true|none|none| -|» description|string|true|none|none| -|» engine|string|true|none|none| -|» created|string(date-time)|false|none|none| - -<aside class="success"> -This operation does not require authentication -</aside> - -## create - -<a id="opIdcreate"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9092/api/container/{id}/database', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9092/api/container/{id}/database"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container/{id}/database` - -*Create database* - -> Body parameter - -```json -{ - "name": "string", - "description": "string", - "is_public": true -} -``` - -<h3 id="create-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|body|body|[DatabaseCreateDto](#schemadatabasecreatedto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="create-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[DatabaseDto](#schemadatabasedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|502|[Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)|Bad Gateway|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## findById - -<a id="opIdfindById"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9092/api/container/{id}/database/{databaseId}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9092/api/container/{id}/database/{databaseId}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}` - -*List some database* - -<h3 id="findbyid-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="findbyid-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[DatabaseDto](#schemadatabasedto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|502|[Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)|Bad Gateway|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -## delete - -<a id="opIddelete"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.delete('http://localhost:9092/api/container/{id}/database/{databaseId}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9092/api/container/{id}/database/{databaseId}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("DELETE"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`DELETE /api/container/{id}/database/{databaseId}` - -*Delete some database* - -<h3 id="delete-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="delete-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|502|[Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)|Bad Gateway|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="delete-responseschema">Response Schema</h3> - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -# Schemas - -<h2 id="tocS_ApiErrorDto">ApiErrorDto</h2> -<!-- backwards compatibility --> -<a id="schemaapierrordto"></a> -<a id="schema_ApiErrorDto"></a> -<a id="tocSapierrordto"></a> -<a id="tocsapierrordto"></a> - -```json -{ - "status": "100 CONTINUE", - "message": "string", - "code": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|status|string|true|none|none| -|message|string|true|none|none| -|code|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|status|100 CONTINUE| -|status|101 SWITCHING_PROTOCOLS| -|status|102 PROCESSING| -|status|103 CHECKPOINT| -|status|200 OK| -|status|201 CREATED| -|status|202 ACCEPTED| -|status|203 NON_AUTHORITATIVE_INFORMATION| -|status|204 NO_CONTENT| -|status|205 RESET_CONTENT| -|status|206 PARTIAL_CONTENT| -|status|207 MULTI_STATUS| -|status|208 ALREADY_REPORTED| -|status|226 IM_USED| -|status|300 MULTIPLE_CHOICES| -|status|301 MOVED_PERMANENTLY| -|status|302 FOUND| -|status|302 MOVED_TEMPORARILY| -|status|303 SEE_OTHER| -|status|304 NOT_MODIFIED| -|status|305 USE_PROXY| -|status|307 TEMPORARY_REDIRECT| -|status|308 PERMANENT_REDIRECT| -|status|400 BAD_REQUEST| -|status|401 UNAUTHORIZED| -|status|402 PAYMENT_REQUIRED| -|status|403 FORBIDDEN| -|status|404 NOT_FOUND| -|status|405 METHOD_NOT_ALLOWED| -|status|406 NOT_ACCEPTABLE| -|status|407 PROXY_AUTHENTICATION_REQUIRED| -|status|408 REQUEST_TIMEOUT| -|status|409 CONFLICT| -|status|410 GONE| -|status|411 LENGTH_REQUIRED| -|status|412 PRECONDITION_FAILED| -|status|413 PAYLOAD_TOO_LARGE| -|status|413 REQUEST_ENTITY_TOO_LARGE| -|status|414 URI_TOO_LONG| -|status|414 REQUEST_URI_TOO_LONG| -|status|415 UNSUPPORTED_MEDIA_TYPE| -|status|416 REQUESTED_RANGE_NOT_SATISFIABLE| -|status|417 EXPECTATION_FAILED| -|status|418 I_AM_A_TEAPOT| -|status|419 INSUFFICIENT_SPACE_ON_RESOURCE| -|status|420 METHOD_FAILURE| -|status|421 DESTINATION_LOCKED| -|status|422 UNPROCESSABLE_ENTITY| -|status|423 LOCKED| -|status|424 FAILED_DEPENDENCY| -|status|425 TOO_EARLY| -|status|426 UPGRADE_REQUIRED| -|status|428 PRECONDITION_REQUIRED| -|status|429 TOO_MANY_REQUESTS| -|status|431 REQUEST_HEADER_FIELDS_TOO_LARGE| -|status|451 UNAVAILABLE_FOR_LEGAL_REASONS| -|status|500 INTERNAL_SERVER_ERROR| -|status|501 NOT_IMPLEMENTED| -|status|502 BAD_GATEWAY| -|status|503 SERVICE_UNAVAILABLE| -|status|504 GATEWAY_TIMEOUT| -|status|505 HTTP_VERSION_NOT_SUPPORTED| -|status|506 VARIANT_ALSO_NEGOTIATES| -|status|507 INSUFFICIENT_STORAGE| -|status|508 LOOP_DETECTED| -|status|509 BANDWIDTH_LIMIT_EXCEEDED| -|status|510 NOT_EXTENDED| -|status|511 NETWORK_AUTHENTICATION_REQUIRED| - -<h2 id="tocS_DatabaseCreateDto">DatabaseCreateDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasecreatedto"></a> -<a id="schema_DatabaseCreateDto"></a> -<a id="tocSdatabasecreatedto"></a> -<a id="tocsdatabasecreatedto"></a> - -```json -{ - "name": "string", - "description": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|name|string|true|none|none| -|description|string|true|none|none| -|is_public|boolean|true|none|none| - -<h2 id="tocS_ColumnDto">ColumnDto</h2> -<!-- backwards compatibility --> -<a id="schemacolumndto"></a> -<a id="schema_ColumnDto"></a> -<a id="tocScolumndto"></a> -<a id="tocscolumndto"></a> - -```json -{ - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|unique|boolean|true|none|none| -|references|string|false|none|none| -|internal_name|string|true|none|none| -|date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|auto_generated|boolean|true|none|none| -|is_primary_key|boolean|true|none|none| -|column_type|string|true|none|none| -|column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|decimal_digits_before|integer(int64)|false|none|none| -|decimal_digits_after|integer(int64)|false|none|none| -|is_null_allowed|boolean|true|none|none| -|check_expression|string|false|none|none| -|foreign_key|string|false|none|none| -|enum_values|[string]|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| - -<h2 id="tocS_ConceptDto">ConceptDto</h2> -<!-- backwards compatibility --> -<a id="schemaconceptdto"></a> -<a id="schema_ConceptDto"></a> -<a id="tocSconceptdto"></a> -<a id="tocsconceptdto"></a> - -```json -{ - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|uri|string|true|none|none| -|name|string|true|none|none| -|created|string(date-time)|true|none|none| - -<h2 id="tocS_ContainerDto">ContainerDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerdto"></a> -<a id="schema_ContainerDto"></a> -<a id="tocScontainerdto"></a> -<a id="tocscontainerdto"></a> - -```json -{ - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|hash|string|true|none|none| -|name|string|true|none|none| -|state|string|true|none|none| -|databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|port|integer(int32)|true|none|none| -|created|string(date-time)|true|none|none| -|internal_name|string|true|none|none| -|ip_address|string|true|none|none| -|is_public|boolean|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| - -<h2 id="tocS_DatabaseDto">DatabaseDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasedto"></a> -<a id="schema_DatabaseDto"></a> -<a id="tocSdatabasedto"></a> -<a id="tocsdatabasedto"></a> - -```json -{ - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|description|string|true|none|none| -|publisher|string|false|none|none| -|license|string|false|none|none| -|contact|[UserDto](#schemauserdto)|false|none|none| -|tables|[[TableDto](#schematabledto)]|true|none|none| -|exchange|string|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|container|[ContainerDto](#schemacontainerdto)|true|none|none| -|created|string(date-time)|false|none|none| -|deleted|string(date-time)|false|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_GrantedAuthorityDto">GrantedAuthorityDto</h2> -<!-- backwards compatibility --> -<a id="schemagrantedauthoritydto"></a> -<a id="schema_GrantedAuthorityDto"></a> -<a id="tocSgrantedauthoritydto"></a> -<a id="tocsgrantedauthoritydto"></a> - -```json -{ - "authority": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|authority|string|false|none|none| - -<h2 id="tocS_ImageDateDto">ImageDateDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedatedto"></a> -<a id="schema_ImageDateDto"></a> -<a id="tocSimagedatedto"></a> -<a id="tocsimagedatedto"></a> - -```json -{ - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|example|string|true|none|none| -|database_format|string|true|none|none| -|unix_format|string|true|none|none| -|created_at|string(date-time)|false|none|none| - -<h2 id="tocS_ImageDto">ImageDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedto"></a> -<a id="schema_ImageDto"></a> -<a id="tocSimagedto"></a> -<a id="tocsimagedto"></a> - -```json -{ - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|repository|string|true|none|none| -|tag|string|true|none|none| -|logo|string|false|none|none| -|dialect|string|true|none|none| -|hash|string|false|none|none| -|compiled|string(date-time)|false|none|none| -|size|integer|false|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|driver_class|string|true|none|none| -|date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|jdbc_method|string|true|none|none| -|default_port|integer(int32)|true|none|none| - -<h2 id="tocS_ImageEnvItemDto">ImageEnvItemDto</h2> -<!-- backwards compatibility --> -<a id="schemaimageenvitemdto"></a> -<a id="schema_ImageEnvItemDto"></a> -<a id="tocSimageenvitemdto"></a> -<a id="tocsimageenvitemdto"></a> - -```json -{ - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|iid|integer(int64)|true|none|none| -|key|string|true|none|none| -|value|string|true|none|none| -|type|string|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<h2 id="tocS_TableDto">TableDto</h2> -<!-- backwards compatibility --> -<a id="schematabledto"></a> -<a id="schema_TableDto"></a> -<a id="tocStabledto"></a> -<a id="tocstabledto"></a> - -```json -{ - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|topic|string|true|none|none| -|description|string|true|none|none| -|separator|string|true|none|none| -|quote|string|true|none|none| -|created|string(date-time)|false|none|none| -|columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|internal_name|string|true|none|none| -|null_element|string|true|none|none| -|skip_lines|integer(int64)|false|none|none| -|true_element|string|false|none|none| -|false_element|string|false|none|none| - -<h2 id="tocS_UserDto">UserDto</h2> -<!-- backwards compatibility --> -<a id="schemauserdto"></a> -<a id="schema_UserDto"></a> -<a id="tocSuserdto"></a> -<a id="tocsuserdto"></a> - -```json -{ - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|false|none|none| -|authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|username|string|true|none|none| -|titlesBefore|string|true|none|none| -|titlesAfter|string|true|none|none| -|firstname|string|true|none|none| -|lastname|string|true|none|none| -|containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|email|string|true|none|none| - -<h2 id="tocS_DatabaseBriefDto">DatabaseBriefDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasebriefdto"></a> -<a id="schema_DatabaseBriefDto"></a> -<a id="tocSdatabasebriefdto"></a> -<a id="tocsdatabasebriefdto"></a> - -```json -{ - "id": 0, - "name": "string", - "description": "string", - "engine": "string", - "created": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|description|string|true|none|none| -|engine|string|true|none|none| -|created|string(date-time)|false|none|none| - diff --git a/docs/operation/endpoints/identifier.md b/docs/operation/endpoints/identifier.md deleted file mode 100644 index 4976c64..0000000 --- a/docs/operation/endpoints/identifier.md +++ /dev/null @@ -1,3623 +0,0 @@ ---- -title: Database Repository Identifier Service API v1.1.0-alpha -language_tabs: - - python: Python - - java: Java -toc_footers: - - <a - href="https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis">Wiki - Documentation</a> -includes: [] -search: true -highlight_theme: darkula -headingLevel: 2 - ---- - -<!-- Generator: Widdershins v4.0.1 --> - -<h1 id="database-repository-identifier-service-api">Database Repository Identifier Service API v1.1.0-alpha</h1> - -> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. - -Service that manages the identifiers - -Base URLs: - -* <a href="http://localhost:9096">http://localhost:9096</a> - -Email: <a href="mailto:andreas.rauber@tuwien.ac.at">Prof. Andreas Rauber</a> -License: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a> - -# Authentication - -- HTTP Authentication, scheme: bearer - -<h1 id="database-repository-identifier-service-api-identifier-endpoint">identifier-endpoint</h1> - -## publish - -<a id="opIdpublish"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}', params={ - 'identiferId': '0' -}, headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}?identiferId=0"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/container/{id}/database/{databaseId}/identifier/{identiferId}` - -*Publish some identifier* - -<h3 id="publish-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|identiferId|query|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="publish-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="publish-responseschema">Response Schema</h3> - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## update - -<a id="opIdupdate"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}', params={ - 'identiferId': '0' -}, headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}?identiferId=0"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container/{id}/database/{databaseId}/identifier/{identiferId}` - -*Update some identifier* - -> Body parameter - -```json -{ - "id": 0, - "cid": 0, - "dbid": 0, - "qid": 0, - "title": "string", - "description": "string", - "visibility": "VisibilityTypeDto.EVERYONE", - "doi": "string", - "creators": [ - { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - } - ], - "created": "2019-08-24T14:15:22Z", - "last_modified": "2019-08-24T14:15:22Z" -} -``` - -<h3 id="update-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|identiferId|query|integer(int64)|true|none| -|body|body|[IdentifierDto](#schemaidentifierdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="update-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[IdentifierDto](#schemaidentifierdto)| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## delete - -<a id="opIddelete"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.delete('http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}', params={ - 'identiferId': '0' -}, headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/container/{id}/database/{databaseId}/identifier/{identiferId}?identiferId=0"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("DELETE"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`DELETE /api/container/{id}/database/{databaseId}/identifier/{identiferId}` - -*Delete some identifer* - -<h3 id="delete-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|identiferId|query|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="delete-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="delete-responseschema">Response Schema</h3> - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## findAll - -<a id="opIdfindAll"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9096/api/container/{id}/database/{databaseId}/identifier', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/container/{id}/database/{databaseId}/identifier"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}/identifier` - -*Find identifiers* - -<h3 id="findall-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|qid|query|integer(int64)|false|none| - -> Example responses - -> 200 Response - -<h3 id="findall-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="findall-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[IdentifierDto](#schemaidentifierdto)]|false|none|none| -|» id|integer(int64)|false|none|none| -|» cid|integer(int64)|true|none|none| -|» dbid|integer(int64)|true|none|none| -|» qid|integer(int64)|true|none|none| -|» title|string|true|none|none| -|» description|string|true|none|none| -|» visibility|string|true|none|none| -|» doi|string|false|none|none| -|» creators|[[UserDto](#schemauserdto)]|true|none|none| -|»» id|integer(int64)|false|none|none| -|»» authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|»»» authority|string|false|none|none| -|»» username|string|true|none|none| -|»» titlesBefore|string|true|none|none| -|»» titlesAfter|string|true|none|none| -|»» firstname|string|true|none|none| -|»» lastname|string|true|none|none| -|»» containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|»»» id|integer(int64)|true|none|none| -|»»» hash|string|true|none|none| -|»»» name|string|true|none|none| -|»»» state|string|true|none|none| -|»»» databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|»»»» id|integer(int64)|true|none|none| -|»»»» name|string|true|none|none| -|»»»» description|string|true|none|none| -|»»»» publisher|string|false|none|none| -|»»»» license|string|false|none|none| -|»»»» contact|[UserDto](#schemauserdto)|false|none|none| -|»»»» tables|[[TableDto](#schematabledto)]|true|none|none| -|»»»»» id|integer(int64)|true|none|none| -|»»»»» name|string|true|none|none| -|»»»»» topic|string|true|none|none| -|»»»»» description|string|true|none|none| -|»»»»» separator|string|true|none|none| -|»»»»» quote|string|true|none|none| -|»»»»» created|string(date-time)|false|none|none| -|»»»»» columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|»»»»»» id|integer(int64)|true|none|none| -|»»»»»» name|string|true|none|none| -|»»»»»» unique|boolean|true|none|none| -|»»»»»» references|string|false|none|none| -|»»»»»» internal_name|string|true|none|none| -|»»»»»» date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|»»»»»»» id|integer(int64)|true|none|none| -|»»»»»»» example|string|true|none|none| -|»»»»»»» database_format|string|true|none|none| -|»»»»»»» unix_format|string|true|none|none| -|»»»»»»» created_at|string(date-time)|false|none|none| -|»»»»»» auto_generated|boolean|true|none|none| -|»»»»»» is_primary_key|boolean|true|none|none| -|»»»»»» column_type|string|true|none|none| -|»»»»»» column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|»»»»»»» uri|string|true|none|none| -|»»»»»»» name|string|true|none|none| -|»»»»»»» created|string(date-time)|true|none|none| -|»»»»»» decimal_digits_before|integer(int64)|false|none|none| -|»»»»»» decimal_digits_after|integer(int64)|false|none|none| -|»»»»»» is_null_allowed|boolean|true|none|none| -|»»»»»» check_expression|string|false|none|none| -|»»»»»» foreign_key|string|false|none|none| -|»»»»»» enum_values|[string]|false|none|none| -|»»»»» internal_name|string|true|none|none| -|»»»»» null_element|string|true|none|none| -|»»»»» skip_lines|integer(int64)|false|none|none| -|»»»»» true_element|string|false|none|none| -|»»»»» false_element|string|false|none|none| -|»»»» exchange|string|true|none|none| -|»»»» image|[ImageDto](#schemaimagedto)|true|none|none| -|»»»»» id|integer(int64)|true|none|none| -|»»»»» repository|string|true|none|none| -|»»»»» tag|string|true|none|none| -|»»»»» logo|string|false|none|none| -|»»»»» dialect|string|true|none|none| -|»»»»» hash|string|false|none|none| -|»»»»» compiled|string(date-time)|false|none|none| -|»»»»» size|integer|false|none|none| -|»»»»» environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|»»»»»» iid|integer(int64)|true|none|none| -|»»»»»» key|string|true|none|none| -|»»»»»» value|string|true|none|none| -|»»»»»» type|string|false|none|none| -|»»»»» driver_class|string|true|none|none| -|»»»»» date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|»»»»» jdbc_method|string|true|none|none| -|»»»»» default_port|integer(int32)|true|none|none| -|»»»» container|[ContainerDto](#schemacontainerdto)|true|none|none| -|»»»» created|string(date-time)|false|none|none| -|»»»» deleted|string(date-time)|false|none|none| -|»»»» internal_name|string|true|none|none| -|»»» image|[ImageDto](#schemaimagedto)|true|none|none| -|»»» port|integer(int32)|true|none|none| -|»»» created|string(date-time)|true|none|none| -|»»» internal_name|string|true|none|none| -|»»» ip_address|string|true|none|none| -|»»» is_public|boolean|true|none|none| -|»» databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|»» identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|»» email|string|true|none|none| -|» created|string(date-time)|false|none|none| -|» last_modified|string(date-time)|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|visibility|VisibilityTypeDto.EVERYONE| -|visibility|VisibilityTypeDto.TRUSTED| -|visibility|VisibilityTypeDto.SELF| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<aside class="success"> -This operation does not require authentication -</aside> - -## create - -<a id="opIdcreate"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9096/api/container/{id}/database/{databaseId}/identifier', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/container/{id}/database/{databaseId}/identifier"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container/{id}/database/{databaseId}/identifier` - -*Create identifier* - -> Body parameter - -```json -{ - "id": 0, - "cid": 0, - "dbid": 0, - "qid": 0, - "title": "string", - "description": "string", - "visibility": "VisibilityTypeDto.EVERYONE", - "doi": "string", - "creators": [ - { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - } - ], - "created": "2019-08-24T14:15:22Z", - "last_modified": "2019-08-24T14:15:22Z" -} -``` - -<h3 id="create-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|body|body|[IdentifierDto](#schemaidentifierdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="create-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[IdentifierDto](#schemaidentifierdto)| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -<h1 id="database-repository-identifier-service-api-persistence-endpoint">persistence-endpoint</h1> - -## find - -<a id="opIdfind"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9096/api/pid/{pid}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9096/api/pid/{pid}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/pid/{pid}` - -*Find some identifier* - -<h3 id="find-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|pid|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="find-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[IdentifierDto](#schemaidentifierdto)| -|204|[No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)|No Content|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|406|[Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)|Not Acceptable|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| -|412|[Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)|Precondition Failed|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -# Schemas - -<h2 id="tocS_ApiErrorDto">ApiErrorDto</h2> -<!-- backwards compatibility --> -<a id="schemaapierrordto"></a> -<a id="schema_ApiErrorDto"></a> -<a id="tocSapierrordto"></a> -<a id="tocsapierrordto"></a> - -```json -{ - "status": "100 CONTINUE", - "message": "string", - "code": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|status|string|true|none|none| -|message|string|true|none|none| -|code|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|status|100 CONTINUE| -|status|101 SWITCHING_PROTOCOLS| -|status|102 PROCESSING| -|status|103 CHECKPOINT| -|status|200 OK| -|status|201 CREATED| -|status|202 ACCEPTED| -|status|203 NON_AUTHORITATIVE_INFORMATION| -|status|204 NO_CONTENT| -|status|205 RESET_CONTENT| -|status|206 PARTIAL_CONTENT| -|status|207 MULTI_STATUS| -|status|208 ALREADY_REPORTED| -|status|226 IM_USED| -|status|300 MULTIPLE_CHOICES| -|status|301 MOVED_PERMANENTLY| -|status|302 FOUND| -|status|302 MOVED_TEMPORARILY| -|status|303 SEE_OTHER| -|status|304 NOT_MODIFIED| -|status|305 USE_PROXY| -|status|307 TEMPORARY_REDIRECT| -|status|308 PERMANENT_REDIRECT| -|status|400 BAD_REQUEST| -|status|401 UNAUTHORIZED| -|status|402 PAYMENT_REQUIRED| -|status|403 FORBIDDEN| -|status|404 NOT_FOUND| -|status|405 METHOD_NOT_ALLOWED| -|status|406 NOT_ACCEPTABLE| -|status|407 PROXY_AUTHENTICATION_REQUIRED| -|status|408 REQUEST_TIMEOUT| -|status|409 CONFLICT| -|status|410 GONE| -|status|411 LENGTH_REQUIRED| -|status|412 PRECONDITION_FAILED| -|status|413 PAYLOAD_TOO_LARGE| -|status|413 REQUEST_ENTITY_TOO_LARGE| -|status|414 URI_TOO_LONG| -|status|414 REQUEST_URI_TOO_LONG| -|status|415 UNSUPPORTED_MEDIA_TYPE| -|status|416 REQUESTED_RANGE_NOT_SATISFIABLE| -|status|417 EXPECTATION_FAILED| -|status|418 I_AM_A_TEAPOT| -|status|419 INSUFFICIENT_SPACE_ON_RESOURCE| -|status|420 METHOD_FAILURE| -|status|421 DESTINATION_LOCKED| -|status|422 UNPROCESSABLE_ENTITY| -|status|423 LOCKED| -|status|424 FAILED_DEPENDENCY| -|status|425 TOO_EARLY| -|status|426 UPGRADE_REQUIRED| -|status|428 PRECONDITION_REQUIRED| -|status|429 TOO_MANY_REQUESTS| -|status|431 REQUEST_HEADER_FIELDS_TOO_LARGE| -|status|451 UNAVAILABLE_FOR_LEGAL_REASONS| -|status|500 INTERNAL_SERVER_ERROR| -|status|501 NOT_IMPLEMENTED| -|status|502 BAD_GATEWAY| -|status|503 SERVICE_UNAVAILABLE| -|status|504 GATEWAY_TIMEOUT| -|status|505 HTTP_VERSION_NOT_SUPPORTED| -|status|506 VARIANT_ALSO_NEGOTIATES| -|status|507 INSUFFICIENT_STORAGE| -|status|508 LOOP_DETECTED| -|status|509 BANDWIDTH_LIMIT_EXCEEDED| -|status|510 NOT_EXTENDED| -|status|511 NETWORK_AUTHENTICATION_REQUIRED| - -<h2 id="tocS_ColumnDto">ColumnDto</h2> -<!-- backwards compatibility --> -<a id="schemacolumndto"></a> -<a id="schema_ColumnDto"></a> -<a id="tocScolumndto"></a> -<a id="tocscolumndto"></a> - -```json -{ - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|unique|boolean|true|none|none| -|references|string|false|none|none| -|internal_name|string|true|none|none| -|date_format|[ImageDateDto](#schemaimagedatedto)|true|none|none| -|auto_generated|boolean|true|none|none| -|is_primary_key|boolean|true|none|none| -|column_type|string|true|none|none| -|column_concept|[ConceptDto](#schemaconceptdto)|true|none|none| -|decimal_digits_before|integer(int64)|false|none|none| -|decimal_digits_after|integer(int64)|false|none|none| -|is_null_allowed|boolean|true|none|none| -|check_expression|string|false|none|none| -|foreign_key|string|false|none|none| -|enum_values|[string]|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|column_type|ColumnTypeDto.ENUM| -|column_type|ColumnTypeDto.NUMBER| -|column_type|ColumnTypeDto.DECIMAL| -|column_type|ColumnTypeDto.STRING| -|column_type|ColumnTypeDto.TEXT| -|column_type|ColumnTypeDto.BOOLEAN| -|column_type|ColumnTypeDto.DATE| -|column_type|ColumnTypeDto.BLOB| - -<h2 id="tocS_ConceptDto">ConceptDto</h2> -<!-- backwards compatibility --> -<a id="schemaconceptdto"></a> -<a id="schema_ConceptDto"></a> -<a id="tocSconceptdto"></a> -<a id="tocsconceptdto"></a> - -```json -{ - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|uri|string|true|none|none| -|name|string|true|none|none| -|created|string(date-time)|true|none|none| - -<h2 id="tocS_ContainerDto">ContainerDto</h2> -<!-- backwards compatibility --> -<a id="schemacontainerdto"></a> -<a id="schema_ContainerDto"></a> -<a id="tocScontainerdto"></a> -<a id="tocscontainerdto"></a> - -```json -{ - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|hash|string|true|none|none| -|name|string|true|none|none| -|state|string|true|none|none| -|databases|[[DatabaseDto](#schemadatabasedto)]|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|port|integer(int32)|true|none|none| -|created|string(date-time)|true|none|none| -|internal_name|string|true|none|none| -|ip_address|string|true|none|none| -|is_public|boolean|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|state|ContainerStateDto.CREATED| -|state|ContainerStateDto.RESTARTING| -|state|ContainerStateDto.RUNNING| -|state|ContainerStateDto.PAUSED| -|state|ContainerStateDto.EXITED| -|state|ContainerStateDto.DEAD| - -<h2 id="tocS_DatabaseDto">DatabaseDto</h2> -<!-- backwards compatibility --> -<a id="schemadatabasedto"></a> -<a id="schema_DatabaseDto"></a> -<a id="tocSdatabasedto"></a> -<a id="tocsdatabasedto"></a> - -```json -{ - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": {}, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": {}, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - }, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|description|string|true|none|none| -|publisher|string|false|none|none| -|license|string|false|none|none| -|contact|[UserDto](#schemauserdto)|false|none|none| -|tables|[[TableDto](#schematabledto)]|true|none|none| -|exchange|string|true|none|none| -|image|[ImageDto](#schemaimagedto)|true|none|none| -|container|[ContainerDto](#schemacontainerdto)|true|none|none| -|created|string(date-time)|false|none|none| -|deleted|string(date-time)|false|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_GrantedAuthorityDto">GrantedAuthorityDto</h2> -<!-- backwards compatibility --> -<a id="schemagrantedauthoritydto"></a> -<a id="schema_GrantedAuthorityDto"></a> -<a id="tocSgrantedauthoritydto"></a> -<a id="tocsgrantedauthoritydto"></a> - -```json -{ - "authority": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|authority|string|false|none|none| - -<h2 id="tocS_IdentifierDto">IdentifierDto</h2> -<!-- backwards compatibility --> -<a id="schemaidentifierdto"></a> -<a id="schema_IdentifierDto"></a> -<a id="tocSidentifierdto"></a> -<a id="tocsidentifierdto"></a> - -```json -{ - "id": 0, - "cid": 0, - "dbid": 0, - "qid": 0, - "title": "string", - "description": "string", - "visibility": "VisibilityTypeDto.EVERYONE", - "doi": "string", - "creators": [ - { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": {}, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - {} - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" - } - ], - "created": "2019-08-24T14:15:22Z", - "last_modified": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|false|none|none| -|cid|integer(int64)|true|none|none| -|dbid|integer(int64)|true|none|none| -|qid|integer(int64)|true|none|none| -|title|string|true|none|none| -|description|string|true|none|none| -|visibility|string|true|none|none| -|doi|string|false|none|none| -|creators|[[UserDto](#schemauserdto)]|true|none|none| -|created|string(date-time)|false|none|none| -|last_modified|string(date-time)|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|visibility|VisibilityTypeDto.EVERYONE| -|visibility|VisibilityTypeDto.TRUSTED| -|visibility|VisibilityTypeDto.SELF| - -<h2 id="tocS_ImageDateDto">ImageDateDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedatedto"></a> -<a id="schema_ImageDateDto"></a> -<a id="tocSimagedatedto"></a> -<a id="tocsimagedatedto"></a> - -```json -{ - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|example|string|true|none|none| -|database_format|string|true|none|none| -|unix_format|string|true|none|none| -|created_at|string(date-time)|false|none|none| - -<h2 id="tocS_ImageDto">ImageDto</h2> -<!-- backwards compatibility --> -<a id="schemaimagedto"></a> -<a id="schema_ImageDto"></a> -<a id="tocSimagedto"></a> -<a id="tocsimagedto"></a> - -```json -{ - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|repository|string|true|none|none| -|tag|string|true|none|none| -|logo|string|false|none|none| -|dialect|string|true|none|none| -|hash|string|false|none|none| -|compiled|string(date-time)|false|none|none| -|size|integer|false|none|none| -|environment|[[ImageEnvItemDto](#schemaimageenvitemdto)]|true|none|none| -|driver_class|string|true|none|none| -|date_formats|[[ImageDateDto](#schemaimagedatedto)]|false|none|none| -|jdbc_method|string|true|none|none| -|default_port|integer(int32)|true|none|none| - -<h2 id="tocS_ImageEnvItemDto">ImageEnvItemDto</h2> -<!-- backwards compatibility --> -<a id="schemaimageenvitemdto"></a> -<a id="schema_ImageEnvItemDto"></a> -<a id="tocSimageenvitemdto"></a> -<a id="tocsimageenvitemdto"></a> - -```json -{ - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|iid|integer(int64)|true|none|none| -|key|string|true|none|none| -|value|string|true|none|none| -|type|string|false|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|type|USERNAME| -|type|PASSWORD| -|type|PRIVILEGED_USERNAME| -|type|PRIVILEGED_PASSWORD| - -<h2 id="tocS_TableDto">TableDto</h2> -<!-- backwards compatibility --> -<a id="schematabledto"></a> -<a id="schema_TableDto"></a> -<a id="tocStabledto"></a> -<a id="tocstabledto"></a> - -```json -{ - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|topic|string|true|none|none| -|description|string|true|none|none| -|separator|string|true|none|none| -|quote|string|true|none|none| -|created|string(date-time)|false|none|none| -|columns|[[ColumnDto](#schemacolumndto)]|true|none|none| -|internal_name|string|true|none|none| -|null_element|string|true|none|none| -|skip_lines|integer(int64)|false|none|none| -|true_element|string|false|none|none| -|false_element|string|false|none|none| - -<h2 id="tocS_UserDto">UserDto</h2> -<!-- backwards compatibility --> -<a id="schemauserdto"></a> -<a id="schema_UserDto"></a> -<a id="tocSuserdto"></a> -<a id="tocsuserdto"></a> - -```json -{ - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [], - "databases": [ - {} - ], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "databases": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [], - "identifiers": [ - {} - ], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "identifiers": [ - { - "id": 0, - "hash": "string", - "name": "string", - "state": "ContainerStateDto.CREATED", - "databases": [ - { - "id": 0, - "name": "string", - "description": "string", - "publisher": "string", - "license": "string", - "contact": { - "id": 0, - "authorities": [ - { - "authority": "string" - } - ], - "username": "string", - "titlesBefore": "string", - "titlesAfter": "string", - "firstname": "string", - "lastname": "string", - "containers": [ - {} - ], - "databases": [ - {} - ], - "identifiers": [], - "email": "string" - }, - "tables": [ - { - "id": 0, - "name": "string", - "topic": "string", - "description": "string", - "separator": "string", - "quote": "string", - "created": "2019-08-24T14:15:22Z", - "columns": [ - { - "id": 0, - "name": "string", - "unique": true, - "references": "string", - "internal_name": "string", - "date_format": { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - }, - "auto_generated": true, - "is_primary_key": true, - "column_type": "ColumnTypeDto.ENUM", - "column_concept": { - "uri": "string", - "name": "string", - "created": "2019-08-24T14:15:22Z" - }, - "decimal_digits_before": 0, - "decimal_digits_after": 0, - "is_null_allowed": true, - "check_expression": "string", - "foreign_key": "string", - "enum_values": [ - "string" - ] - } - ], - "internal_name": "string", - "null_element": "string", - "skip_lines": 0, - "true_element": "string", - "false_element": "string" - } - ], - "exchange": "string", - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "container": {}, - "created": "2019-08-24T14:15:22Z", - "deleted": "2019-08-24T14:15:22Z", - "internal_name": "string" - } - ], - "image": { - "id": 0, - "repository": "string", - "tag": "string", - "logo": "string", - "dialect": "string", - "hash": "string", - "compiled": "2019-08-24T14:15:22Z", - "size": 0, - "environment": [ - { - "iid": 0, - "key": "string", - "value": "string", - "type": "USERNAME" - } - ], - "driver_class": "string", - "date_formats": [ - { - "id": 0, - "example": "string", - "database_format": "string", - "unix_format": "string", - "created_at": "2019-08-24T14:15:22Z" - } - ], - "jdbc_method": "string", - "default_port": 0 - }, - "port": 0, - "created": "2019-08-24T14:15:22Z", - "internal_name": "string", - "ip_address": "string", - "is_public": true - } - ], - "email": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|false|none|none| -|authorities|[[GrantedAuthorityDto](#schemagrantedauthoritydto)]|false|none|none| -|username|string|true|none|none| -|titlesBefore|string|true|none|none| -|titlesAfter|string|true|none|none| -|firstname|string|true|none|none| -|lastname|string|true|none|none| -|containers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|databases|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|identifiers|[[ContainerDto](#schemacontainerdto)]|true|none|none| -|email|string|true|none|none| - diff --git a/docs/operation/endpoints/query.md b/docs/operation/endpoints/query.md deleted file mode 100644 index 63dfb3d..0000000 --- a/docs/operation/endpoints/query.md +++ /dev/null @@ -1,1014 +0,0 @@ ---- -title: Database Repository Query Service API v1.1.0-alpha -language_tabs: - - python: Python - - java: Java -toc_footers: - - <a - href="https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis">Wiki - Documentation</a> -includes: [] -search: true -highlight_theme: darkula -headingLevel: 2 - ---- - -<!-- Generator: Widdershins v4.0.1 --> - -<h1 id="database-repository-query-service-api">Database Repository Query Service API v1.1.0-alpha</h1> - -> Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu. - -Service that manages the queries - -Base URLs: - -* <a href="http://localhost:9093">http://localhost:9093</a> - -Email: <a href="mailto:andreas.rauber@tuwien.ac.at">Prof. Andreas Rauber</a> -License: <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a> - -# Authentication - -- HTTP Authentication, scheme: bearer - -<h1 id="database-repository-query-service-api-table-data-endpoint">table-data-endpoint</h1> - -## getAll_1 - -<a id="opIdgetAll_1"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}/table/{tableId}/data` - -*Find data* - -<h3 id="getall_1-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|tableId|path|integer(int64)|true|none| -|timestamp|query|string(date-time)|false|none| -|page|query|integer(int64)|false|none| -|size|query|integer(int64)|false|none| - -> Example responses - -> 200 Response - -<h3 id="getall_1-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[QueryResultDto](#schemaqueryresultdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -## insert - -<a id="opIdinsert"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container/{id}/database/{databaseId}/table/{tableId}/data` - -*Insert data* - -> Body parameter - -```json -{ - "data": { - "property1": {}, - "property2": {} - } -} -``` - -<h3 id="insert-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|tableId|path|integer(int64)|true|none| -|body|body|[TableCsvDto](#schematablecsvdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="insert-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|integer| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## getAll - -<a id="opIdgetAll"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.head('http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("HEAD"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`HEAD /api/container/{id}/database/{databaseId}/table/{tableId}/data` - -*Find data* - -<h3 id="getall-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|tableId|path|integer(int64)|true|none| -|timestamp|query|string(date-time)|false|none| -|page|query|integer(int64)|false|none| -|size|query|integer(int64)|false|none| - -> Example responses - -> 200 Response - -<h3 id="getall-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[QueryResultDto](#schemaqueryresultdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -## importCsv - -<a id="opIdimportCsv"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.post('http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data/import', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/data/import"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("POST"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`POST /api/container/{id}/database/{databaseId}/table/{tableId}/data/import` - -*Insert data from csv* - -> Body parameter - -```json -{ - "location": "string" -} -``` - -<h3 id="importcsv-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|tableId|path|integer(int64)|true|none| -|body|body|[ImportDto](#schemaimportdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="importcsv-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|integer| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -<h1 id="database-repository-query-service-api-store-endpoint">store-endpoint</h1> - -## findAll - -<a id="opIdfindAll"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9093/api/container/{id}/database/{databaseId}/query', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/query"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}/query` - -*Find queries* - -<h3 id="findall-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="findall-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<h3 id="findall-responseschema">Response Schema</h3> - -Status Code **200** - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|*anonymous*|[[QueryDto](#schemaquerydto)]|false|none|none| -|» id|integer(int64)|true|none|none| -|» cid|integer(int64)|true|none|none| -|» dbid|integer(int64)|true|none|none| -|» execution|string(date-time)|false|none|none| -|» query|string|true|none|none| -|» created|string(date-time)|true|none|none| -|» query_normalized|string|false|none|none| -|» query_hash|string|true|none|none| -|» result_hash|string|false|none|none| -|» result_number|integer(int64)|false|none|none| -|» last_modified|string(date-time)|false|none|none| - -<aside class="success"> -This operation does not require authentication -</aside> - -## find - -<a id="opIdfind"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*' -} - -r = requests.get('http://localhost:9093/api/container/{id}/database/{databaseId}/query/{queryId}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/query/{queryId}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}/query/{queryId}` - -*Find some query* - -<h3 id="find-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|queryId|path|integer(int64)|true|none| - -> Example responses - -> 200 Response - -<h3 id="find-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[QueryDto](#schemaquerydto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="success"> -This operation does not require authentication -</aside> - -<h1 id="database-repository-query-service-api-query-endpoint">query-endpoint</h1> - -## execute - -<a id="opIdexecute"></a> - -> Code samples - -```python -import requests -headers = { - 'Content-Type': 'application/json', - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9093/api/container/{id}/database/{databaseId}/query', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/query"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/container/{id}/database/{databaseId}/query` - -*Execute query* - -> Body parameter - -```json -{ - "statement": "string", - "tables": [ - { - "id": 0, - "name": "string", - "internal_name": "string" - } - ], - "columns": [ - [ - { - "id": 0, - "name": "string", - "internal_name": "string" - } - ] - ] -} -``` - -<h3 id="execute-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|page|query|integer(int64)|false|none| -|size|query|integer(int64)|false|none| -|body|body|[ExecuteStatementDto](#schemaexecutestatementdto)|true|none| - -> Example responses - -> 200 Response - -<h3 id="execute-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[QueryResultDto](#schemaqueryresultdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -## reExecute - -<a id="opIdreExecute"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.put('http://localhost:9093/api/container/{id}/database/{databaseId}/query/{queryId}', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/query/{queryId}"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("PUT"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`PUT /api/container/{id}/database/{databaseId}/query/{queryId}` - -*Re-execute some query* - -<h3 id="reexecute-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|queryId|path|integer(int64)|true|none| -|page|query|integer(int64)|false|none| -|size|query|integer(int64)|false|none| - -> Example responses - -> 200 Response - -<h3 id="reexecute-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[QueryResultDto](#schemaqueryresultdto)| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -<h1 id="database-repository-query-service-api-export-endpoint">export-endpoint</h1> - -## export - -<a id="opIdexport"></a> - -> Code samples - -```python -import requests -headers = { - 'Accept': '*/*', - 'Authorization': 'Bearer {access-token}' -} - -r = requests.get('http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/export', headers = headers) - -print(r.json()) - -``` - -```java -URL obj = new URL("http://localhost:9093/api/container/{id}/database/{databaseId}/table/{tableId}/export"); -HttpURLConnection con = (HttpURLConnection) obj.openConnection(); -con.setRequestMethod("GET"); -int responseCode = con.getResponseCode(); -BufferedReader in = new BufferedReader( - new InputStreamReader(con.getInputStream())); -String inputLine; -StringBuffer response = new StringBuffer(); -while ((inputLine = in.readLine()) != null) { - response.append(inputLine); -} -in.close(); -System.out.println(response.toString()); - -``` - -`GET /api/container/{id}/database/{databaseId}/table/{tableId}/export` - -*Export table* - -<h3 id="export-parameters">Parameters</h3> - -|Name|In|Type|Required|Description| -|---|---|---|---|---| -|id|path|integer(int64)|true|none| -|databaseId|path|integer(int64)|true|none| -|tableId|path|integer(int64)|true|none| -|timestamp|query|string(date-time)|false|none| - -> Example responses - -> 200 Response - -<h3 id="export-responses">Responses</h3> - -|Status|Meaning|Description|Schema| -|---|---|---|---| -|200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|OK|string| -|400|[Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)|Bad Request|[ApiErrorDto](#schemaapierrordto)| -|404|[Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)|Not Found|[ApiErrorDto](#schemaapierrordto)| -|405|[Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)|Method Not Allowed|[ApiErrorDto](#schemaapierrordto)| -|409|[Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)|Conflict|[ApiErrorDto](#schemaapierrordto)| - -<aside class="warning"> -To perform this operation, you must be authenticated by means of one of the following methods: -bearerAuth -</aside> - -# Schemas - -<h2 id="tocS_ApiErrorDto">ApiErrorDto</h2> -<!-- backwards compatibility --> -<a id="schemaapierrordto"></a> -<a id="schema_ApiErrorDto"></a> -<a id="tocSapierrordto"></a> -<a id="tocsapierrordto"></a> - -```json -{ - "status": "100 CONTINUE", - "message": "string", - "code": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|status|string|true|none|none| -|message|string|true|none|none| -|code|string|true|none|none| - -#### Enumerated Values - -|Property|Value| -|---|---| -|status|100 CONTINUE| -|status|101 SWITCHING_PROTOCOLS| -|status|102 PROCESSING| -|status|103 CHECKPOINT| -|status|200 OK| -|status|201 CREATED| -|status|202 ACCEPTED| -|status|203 NON_AUTHORITATIVE_INFORMATION| -|status|204 NO_CONTENT| -|status|205 RESET_CONTENT| -|status|206 PARTIAL_CONTENT| -|status|207 MULTI_STATUS| -|status|208 ALREADY_REPORTED| -|status|226 IM_USED| -|status|300 MULTIPLE_CHOICES| -|status|301 MOVED_PERMANENTLY| -|status|302 FOUND| -|status|302 MOVED_TEMPORARILY| -|status|303 SEE_OTHER| -|status|304 NOT_MODIFIED| -|status|305 USE_PROXY| -|status|307 TEMPORARY_REDIRECT| -|status|308 PERMANENT_REDIRECT| -|status|400 BAD_REQUEST| -|status|401 UNAUTHORIZED| -|status|402 PAYMENT_REQUIRED| -|status|403 FORBIDDEN| -|status|404 NOT_FOUND| -|status|405 METHOD_NOT_ALLOWED| -|status|406 NOT_ACCEPTABLE| -|status|407 PROXY_AUTHENTICATION_REQUIRED| -|status|408 REQUEST_TIMEOUT| -|status|409 CONFLICT| -|status|410 GONE| -|status|411 LENGTH_REQUIRED| -|status|412 PRECONDITION_FAILED| -|status|413 PAYLOAD_TOO_LARGE| -|status|413 REQUEST_ENTITY_TOO_LARGE| -|status|414 URI_TOO_LONG| -|status|414 REQUEST_URI_TOO_LONG| -|status|415 UNSUPPORTED_MEDIA_TYPE| -|status|416 REQUESTED_RANGE_NOT_SATISFIABLE| -|status|417 EXPECTATION_FAILED| -|status|418 I_AM_A_TEAPOT| -|status|419 INSUFFICIENT_SPACE_ON_RESOURCE| -|status|420 METHOD_FAILURE| -|status|421 DESTINATION_LOCKED| -|status|422 UNPROCESSABLE_ENTITY| -|status|423 LOCKED| -|status|424 FAILED_DEPENDENCY| -|status|425 TOO_EARLY| -|status|426 UPGRADE_REQUIRED| -|status|428 PRECONDITION_REQUIRED| -|status|429 TOO_MANY_REQUESTS| -|status|431 REQUEST_HEADER_FIELDS_TOO_LARGE| -|status|451 UNAVAILABLE_FOR_LEGAL_REASONS| -|status|500 INTERNAL_SERVER_ERROR| -|status|501 NOT_IMPLEMENTED| -|status|502 BAD_GATEWAY| -|status|503 SERVICE_UNAVAILABLE| -|status|504 GATEWAY_TIMEOUT| -|status|505 HTTP_VERSION_NOT_SUPPORTED| -|status|506 VARIANT_ALSO_NEGOTIATES| -|status|507 INSUFFICIENT_STORAGE| -|status|508 LOOP_DETECTED| -|status|509 BANDWIDTH_LIMIT_EXCEEDED| -|status|510 NOT_EXTENDED| -|status|511 NETWORK_AUTHENTICATION_REQUIRED| - -<h2 id="tocS_QueryResultDto">QueryResultDto</h2> -<!-- backwards compatibility --> -<a id="schemaqueryresultdto"></a> -<a id="schema_QueryResultDto"></a> -<a id="tocSqueryresultdto"></a> -<a id="tocsqueryresultdto"></a> - -```json -{ - "result": [ - { - "property1": {}, - "property2": {} - } - ], - "id": 0, - "resultNumber": 0 -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|result|[object]|true|none|none| -|» **additionalProperties**|object|false|none|none| -|id|integer(int64)|true|none|none| -|resultNumber|integer(int64)|false|none|none| - -<h2 id="tocS_ColumnBriefDto">ColumnBriefDto</h2> -<!-- backwards compatibility --> -<a id="schemacolumnbriefdto"></a> -<a id="schema_ColumnBriefDto"></a> -<a id="tocScolumnbriefdto"></a> -<a id="tocscolumnbriefdto"></a> - -```json -{ - "id": 0, - "name": "string", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_ExecuteStatementDto">ExecuteStatementDto</h2> -<!-- backwards compatibility --> -<a id="schemaexecutestatementdto"></a> -<a id="schema_ExecuteStatementDto"></a> -<a id="tocSexecutestatementdto"></a> -<a id="tocsexecutestatementdto"></a> - -```json -{ - "statement": "string", - "tables": [ - { - "id": 0, - "name": "string", - "internal_name": "string" - } - ], - "columns": [ - [ - { - "id": 0, - "name": "string", - "internal_name": "string" - } - ] - ] -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|statement|string|true|none|none| -|tables|[[TableBriefDto](#schematablebriefdto)]|true|none|none| -|columns|[array]|true|none|none| - -<h2 id="tocS_TableBriefDto">TableBriefDto</h2> -<!-- backwards compatibility --> -<a id="schematablebriefdto"></a> -<a id="schema_TableBriefDto"></a> -<a id="tocStablebriefdto"></a> -<a id="tocstablebriefdto"></a> - -```json -{ - "id": 0, - "name": "string", - "internal_name": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|name|string|true|none|none| -|internal_name|string|true|none|none| - -<h2 id="tocS_TableCsvDto">TableCsvDto</h2> -<!-- backwards compatibility --> -<a id="schematablecsvdto"></a> -<a id="schema_TableCsvDto"></a> -<a id="tocStablecsvdto"></a> -<a id="tocstablecsvdto"></a> - -```json -{ - "data": { - "property1": {}, - "property2": {} - } -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|data|object|true|none|none| -|» **additionalProperties**|object|false|none|none| - -<h2 id="tocS_ImportDto">ImportDto</h2> -<!-- backwards compatibility --> -<a id="schemaimportdto"></a> -<a id="schema_ImportDto"></a> -<a id="tocSimportdto"></a> -<a id="tocsimportdto"></a> - -```json -{ - "location": "string" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|location|string|true|none|none| - -<h2 id="tocS_QueryDto">QueryDto</h2> -<!-- backwards compatibility --> -<a id="schemaquerydto"></a> -<a id="schema_QueryDto"></a> -<a id="tocSquerydto"></a> -<a id="tocsquerydto"></a> - -```json -{ - "id": 0, - "cid": 0, - "dbid": 0, - "execution": "2019-08-24T14:15:22Z", - "query": "string", - "created": "2019-08-24T14:15:22Z", - "query_normalized": "string", - "query_hash": "string", - "result_hash": "string", - "result_number": 0, - "last_modified": "2019-08-24T14:15:22Z" -} - -``` - -### Properties - -|Name|Type|Required|Restrictions|Description| -|---|---|---|---|---| -|id|integer(int64)|true|none|none| -|cid|integer(int64)|true|none|none| -|dbid|integer(int64)|true|none|none| -|execution|string(date-time)|false|none|none| -|query|string|true|none|none| -|created|string(date-time)|true|none|none| -|query_normalized|string|false|none|none| -|query_hash|string|true|none|none| -|result_hash|string|false|none|none| -|result_number|integer(int64)|false|none|none| -|last_modified|string(date-time)|false|none|none| - diff --git a/docs/system.md b/docs/system.md index e5d8283..6c0adc1 100644 --- a/docs/system.md +++ b/docs/system.md @@ -7,24 +7,82 @@ hide: # System +!!! abstract "Abstract" + + Hello + ## Architecture The repository is designed as a microservice architecture to ensure scalability and the utilization of various technologies. The conceptualized microservices operate the basic database operations, data versioning as well as *findability*, *accessability*, *interoperability* and *reuseability* (FAIR). +## Database + +This container runs a relational database engine that allows data versioning and contains the Query Store, a special +table that stores all queries issued to the Researcher Database along with metadata. We store the queries here and not +in the metadata database level to ensure that they are preserved along with the original database for a regular backup +and archival together with the original database once the container is retired. + +### Container + +Currently, we only support databases with +the [MariaDB engine](https://hub.docker.com/_/mariadb?tab=tags&page=1&name=10.5&ordering=-name). +DBRepo creates a *root* user for managing the tables, inserting data, etc. and provides a *mariadb* user that is only +granted `select` access to all tables. The default passwords need to be changed at +[`AbstractSeeder.java`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/blob/master/fda-container-service/services/src/main/java/at/tuwien/seeder/impl/AbstractSeeder.java#L39-L51) + +### Query Store + +The Query Store is a special table (`qs_queries`) that stores all queries issued to the database via the HTTP API. It +stores meta-information about the queries directly in the database container: + <figure markdown> - -<figcaption>Microservice cloud architecture</figcaption> +| Name | Type | Constraint | Default | Comment | +|------------------|--------------|-------------|-------------------------|-------------------------------| +| id | bigint | primary key | nextval(qs_queries_seq) | | +| cid | bigint | | | Column ID | +| dbid | bigint | | | Database ID | +| created | datetime | | now() | | +| created_by | bigint | | | Creator User-ID | +| execution | datetime | | | | +| last_modified | datetime | | | | +| query | text | | | | +| query_normalized | text | | | removing *, randomness | +| query_hash | varchar(255) | | | sha256 hash of `query` field | +| result_hash | varchar(255) | | | sha256 hash of the result set | +| result_number | bigint | | | | + +<figcaption>Query Store table <code>qs_queries</code> schema</figcaption> </figure> +## Services + ### Discovery Service -This microservice allows service discovery and registration of containers that provide services. +This microservice allows service discovery and registration of containers that provide services. It configures +a [Spring Cloud Netflix Eureka Server](https://cloud.spring.io/spring-cloud-netflix/reference/html/) to discover +services. + +!!! debug "Debug Information" + + * Port(s): 9090 + * Swagger: not configured ### Gateway Service -Provides a single point of access to the *application programming interface* (API). +Provides a single point of access to the *application programming interface* (API) and configures +the [Spring Cloud Gateway](https://spring.io/projects/spring-cloud-gateway) to route traffic to the services. + +!!! debug "Debug Information" + + * Port(s): 9095 + * Swagger: not configured + +<figure markdown> + +<figcaption>Microservice cloud architecture</figcaption> +</figure> ### Authentication Service @@ -32,14 +90,52 @@ Very specific to the deployment of the organization. In our reference implementa markup language* (SAML) service provider and use our institutional SAML identity provider for obtaining account data through an encrypted channel. +The Authentication Service configures [Spring Boot Starter Security](https://spring.io/guides/gs/securing-web/) +with [Java JWT](https://github.com/auth0/java-jwt) for internal authentication once the user details are known in the +metadata database. By default, a token is valid for 24 hours and is used on all HTTP API endpoints. + +For the **HTTP API**, obtaining a new token can be done via, e.g. cURL. + +```console +$ curl -X POST -d '{"username":"username","password":"password"}' -H "Content-Type: application/json" https://dbrepo.ossdip.at/api/auth +``` + +Call a secured method by setting the JWT Token as [Bearer Token](https://www.rfc-editor.org/rfc/rfc6750.html) via, +e.g. cURL. + +```console +$ curl -X PUT -H "Authorization: Bearer TOKEN" -H "Content-Type: application/json" https://dbrepo.ossdip.at/api/auth +``` + +For the **AMQP API**, the Authentication Service also creates a dedicated user at the [Broker Service](#broker-service) +that has permissions for writing and configuring the RabbitMQ queues that feed into the database owned by this user. + +!!! debug "Debug Information" + + * Port(s): 9097 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9097/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/authentication-service](http://localhost:9097/v3/api-docs/authentication-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9097/v3/api-docs.yaml) + ### Metadata Database -is the core component of the project. It is a relational database that contains metadata about all researcher databases +It is the core component of the project. It is a relational database that contains metadata about all researcher databases created in the database repository like column names, check expressions, value enumerations or key/value constraints and relevant data for citing data sets. Additionally, the concept, e.g. URI of units of measurements of numerical columns is stored in the Metadata Database in order to provide semantic knowledge context. We use [PostgreSQL](https://www.postgresql.org/) for its rich capabilities in the reference implementation. +The default credentials are `postgres:postgres` for the database `fda`. Connect to the database via, e.g. *psql*. + +```console +$ psql -d fda -h localhost -p 5432 -U postgres -W +``` + +!!! debug "Debug Information" + + * Port(s): 5432 + * Swagger: not configured + ### Unit Service It is designed to map terms in the domain of units of measurement to controlled vocabulary, modelled in @@ -47,6 +143,34 @@ the [ontology of units of measure](https://github.com/HajoRijgersberg/OM). This units and provides a *uniform resource identifier* (URI) to the related concept, which will be stored in the system. Furthermore, there is a method for auto-completing text and listing a description as well as commonly used unit symbols. +The Unit Service reads units of measurement from [`om-2.ttl`](https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/blob/master/fda-units-service/onto/om-2.ttl) +and registers a unit. It is used to assign a unit of measurement to a table column. + +For the **HTTP API**, the Unit Service assigns a unit of measurement via, e.g. cURL. First the list of concepts can be +queried. + +```console +$ curl -X POST -d '{"offset":0,"ustring":"met"}' https://dbrepo.ossdip.at/api/units/suggest +``` + +Then the concept needs to be saved into the metadata database. + +```console +$ curl -X POST -d '{"name":"metre","uri":...}' https://dbrepo.ossdip.at/api/units/saveconcept +``` + +Then the column can be assigned to a table column. + +```console +$ curl -X POST -d '{"cdbid":1,"tid":1,"cid":1,"uri":...}' https://dbrepo.ossdip.at/api/units/savecolumnsconcept +``` + +!!! debug "Debug Information" + + * Port(s): 5010 + * Swagger UI: [/swagger-ui/](http://localhost:9097/swagger-ui/) + * Swagger API .json: [/api-units.json](http://localhost:9097/api-units.json) + ### Identifier Service This microservice is responsible for creating and resolving a *persistent identifier* (PID) attached to a query to @@ -55,40 +179,108 @@ and result set to allow equality checks of the originally obtained result set an the reference implementation we currently only use a numerical id column and plan to integrate *digital object identifier* (DOI) through our institutional library soon. +!!! debug "Debug Information" + + * Port(s): 9096 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9096/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/identifier-service](http://localhost:9096/v3/api-docs/identifier-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9096/v3/api-docs.yaml) + ### Search Service It processes search requests from the Gateway Service for full-text lookups in the Metadata Database. We use [Elasticsearch](https://www.elastic.co/) in the reference implementation. +The Search Service implements ElasticSearch and creates a retrievable index on all databases that is getting updated +with each save operation on databases in the metadata database. The database name can be queried with ElasticSearch +to e.g. match the term "Airquality" + +```console +$ curl http://localhost:9200/databaseindex/_search?q=name:Airquality +``` + +!!! debug "Debug Information" + + * Port(s): 9200, 9600 + * ElasticSearch: [/databaseindex](http://localhost:9000/databaseindex) + ### Container Service It is responsible for Docker container lifecycle operations and updating the local copy of the Docker images. +!!! debug "Debug Information" + + * Port(s): 9091 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9091/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/container-service](http://localhost:9091/v3/api-docs/container-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9091/v3/api-docs.yaml) + ### Database Service It creates the databases inside a Docker container and the Query Store. Currently we only support [MariaDB](https://mariadb.org/) images that allow table versioning with low programmatic effort. +!!! debug "Debug Information" + + * Port(s): 9092 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9092/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/database-service](http://localhost:9092/v3/api-docs/database-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9092/v3/api-docs.yaml) + ### Table Service This microservice handles table operations inside a database that is managed by the Database Service. We use [Hibernate](https://hibernate.org/orm/) for schema and data ingest operations. +!!! debug "Debug Information" + + * Port(s): 9094 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9094/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/table-service](http://localhost:9094/v3/api-docs/table-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9094/v3/api-docs.yaml) + ### Broker Service It holds exchanges and topics responsible for holding AMQP messages for later consumption. We use [RabbitMQ](https://www.rabbitmq.com/) in the reference implementation. +For the **HTTP API**, the Broker Service offers an endpoint to manage the AMQP users and their permissions on exchanges +and queues. This endpoint is reachable via the Gateway Service or at port 9098 directly. Internally this service just +parses commands to the [`rabbitmqctl`](https://www.rabbitmq.com/rabbitmqctl.8.html). + +For the **AMQP API**, the Broker Service can declare exchanges and queues. The AMQP endpoint listens to port 5672 for +regular declares and offers a management interface at port 15672. + +!!! debug "Debug Information" + + * Port(s): 9098, 5672, 15672 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9098/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/broker-service](http://localhost:9098/v3/api-docs/broker-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9098/v3/api-docs.yaml) + * RabbitMQ Management: [/#](http://localhost:15672/#) + ### Query Service It provides an interface to insert data into the tables created by the Table Service. It also allows for view-only, paginated and versioned query execution to the raw data and consumes messages in the message queue from the Broker Service. -### Portal +!!! debug "Debug Information" + + * Port(s): 9093 + * Swagger UI: [/swagger-ui/index.html](http://localhost:9093/swagger-ui/index.html) + * Swagger API .json: [/v3/api-docs/query-service](http://localhost:9093/v3/api-docs/query-service) + * Swagger API .yaml: [/v3/api-docs.yaml](http://localhost:9093/v3/api-docs.yaml) + +### FAIR Portal It provides a *graphical user interface* (GUI) for a researcher to interact with the database repository's API. +!!! debug "Debug Information" + + * Port(s): 3000 + * GUI: [/#](http://localhost:3000) + ### Analyse Service It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It @@ -96,14 +288,8 @@ recommends enumerations for columns and returns e.g. a list of potential primary to confirm these suggestions manually. Moreover, the *Analyze Service* determines basic statistical properties of numerical columns. -### User Database - -This container runs a relational database engine that allows data versioning and contains the Query Store, a special -table that stores all queries issued to the Researcher Database along with metadata. We store the queries here and not -in the metadata database level to ensure that they are preserved along with the original database for a regular backup -and archival together with the original database once the container is retired. - -### Technical +!!! debug "Debug Information" -We use Docker for deployment. The containers are packing all runtime dependencies, when starting them all necessary -files are already present. For running the infrastructure we use Docker Compose. + * Port(s): 5000 + * Swagger UI: [/swagger-ui/](http://localhost:5000/swagger-ui/) + * Swagger API .json: [/api-analyze.json](http://localhost:5000//api-analyze.json) diff --git a/mkdocs.yml b/mkdocs.yml index 83942a6..0048462 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -15,12 +15,6 @@ nav: - Operation: - operation/index.md - operation/production.md - - Endpoints: - - operation/endpoints/authentication.md - - operation/endpoints/container.md - - operation/endpoints/database.md - - operation/endpoints/identifier.md - - operation/endpoints/query.md - publications.md - contact.md extra_css: @@ -56,5 +50,7 @@ markdown_extensions: - admonition - pymdownx.details - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true - toc: permalink: True diff --git a/swagger/api-authentication/.idea/.gitignore b/swagger/api-authentication/.idea/.gitignore deleted file mode 100644 index 13566b8..0000000 --- a/swagger/api-authentication/.idea/.gitignore +++ /dev/null @@ -1,8 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# Datasource local storage ignored files -/dataSources/ -/dataSources.local.xml diff --git a/swagger/api-authentication/.idea/api-authentication.iml b/swagger/api-authentication/.idea/api-authentication.iml deleted file mode 100644 index 8e5446a..0000000 --- a/swagger/api-authentication/.idea/api-authentication.iml +++ /dev/null @@ -1,14 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<module type="PYTHON_MODULE" version="4"> - <component name="NewModuleRootManager"> - <content url="file://$MODULE_DIR$"> - <excludeFolder url="file://$MODULE_DIR$/venv" /> - </content> - <orderEntry type="inheritedJdk" /> - <orderEntry type="sourceFolder" forTests="false" /> - </component> - <component name="PyDocumentationSettings"> - <option name="format" value="PLAIN" /> - <option name="myDocStringFormat" value="Plain" /> - </component> -</module> \ No newline at end of file diff --git a/swagger/api-authentication/.idea/inspectionProfiles/profiles_settings.xml b/swagger/api-authentication/.idea/inspectionProfiles/profiles_settings.xml deleted file mode 100644 index 105ce2d..0000000 --- a/swagger/api-authentication/.idea/inspectionProfiles/profiles_settings.xml +++ /dev/null @@ -1,6 +0,0 @@ -<component name="InspectionProjectProfileManager"> - <settings> - <option name="USE_PROJECT_PROFILE" value="false" /> - <version value="1.0" /> - </settings> -</component> \ No newline at end of file diff --git a/swagger/api-authentication/.idea/misc.xml b/swagger/api-authentication/.idea/misc.xml deleted file mode 100644 index 274b23b..0000000 --- a/swagger/api-authentication/.idea/misc.xml +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.6 (api-authentication)" project-jdk-type="Python SDK" /> -</project> \ No newline at end of file diff --git a/swagger/api-authentication/.idea/modules.xml b/swagger/api-authentication/.idea/modules.xml deleted file mode 100644 index d391fb3..0000000 --- a/swagger/api-authentication/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="ProjectModuleManager"> - <modules> - <module fileurl="file://$PROJECT_DIR$/.idea/api-authentication.iml" filepath="$PROJECT_DIR$/.idea/api-authentication.iml" /> - </modules> - </component> -</project> \ No newline at end of file diff --git a/swagger/api-authentication/.idea/vcs.xml b/swagger/api-authentication/.idea/vcs.xml deleted file mode 100644 index b2bdec2..0000000 --- a/swagger/api-authentication/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project version="4"> - <component name="VcsDirectoryMappings"> - <mapping directory="$PROJECT_DIR$/../.." vcs="Git" /> - </component> -</project> \ No newline at end of file -- GitLab