diff --git a/.gitignore b/.gitignore index a4276591ea54386750651f549656d93d72915420..92b71ca913765254a0094b30c15b0c06c8124338 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,7 @@ ## Generated site/ +node_modules/ +*.bkp ## Core latex/pdflatex auxiliary files: *.aux diff --git a/Makefile b/Makefile index 6af6393a130e481ce6a80fb2729b98fd26400341..0ec51d0351b68ce892efb1d929f6dfb06d607df1 100644 --- a/Makefile +++ b/Makefile @@ -8,5 +8,12 @@ build: run: build docker-compose up +docs: + widdershins --environment ./misc/env.json ./misc/api-authentication.yaml -o ./docs/operation/authentication.md + widdershins --environment ./misc/env.json ./misc/api-container.yaml -o ./docs/operation/container.md + widdershins --environment ./misc/env.json ./misc/api-database.yaml -o ./docs/operation/database.md + widdershins --environment ./misc/env.json ./misc/api-identifier.yaml -o ./docs/operation/identifier.md + widdershins --environment ./misc/env.json ./misc/api-query.yaml -o ./docs/operation/query.md + deploy: run sudo cp -r ./site/* /usr/share/nginx/html/ \ No newline at end of file diff --git a/docs/contact.md b/docs/contact.md new file mode 100644 index 0000000000000000000000000000000000000000..43b98707a9adaf7ebcda309f72cc4be80bc2bd52 --- /dev/null +++ b/docs/contact.md @@ -0,0 +1,16 @@ +--- +hide: + +- navigation + +--- + +# Contact + +Ao.Univ.Prof. Dipl.-Ing. Dr.techn. Andreas Rauber<br /> +[Technische Universität Wien](https://ror.org/04d836q62)<br /> +[Information and Software Engineering Group](https://informatics.tuwien.ac.at/orgs/e194-01)<br /> +Favoritenstraße 9-11<br /> +A-1040 Vienna, Austria + +Mail: [andreas.rauber@tuwien.ac.at](mailto:andreas.rauber@tuwien.ac.at) \ No newline at end of file diff --git a/docs/images/dia_architecture.png b/docs/images/dia_architecture.png new file mode 100644 index 0000000000000000000000000000000000000000..0e8834ca8e13f7c1a43e50885aa0f3201ea27043 Binary files /dev/null and b/docs/images/dia_architecture.png differ diff --git a/docs/index.md b/docs/index.md index f9a337fb7bec4a727affa1c84688d0ff9f160e8d..756d9a15d65f77dc49f05f0f6d88e0d70aadf36c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,16 +14,17 @@ databases accessible in their collection. Challenges revolve around organizing, within databases and constitute a major technical burden as their internal representation greatly differs from static documents most digital repositories are designed for. +[Get Started](/getting-started){ .action-button .md-button .md-button--primary } + ## Application Areas We present a database repository system that allows researchers to ingest data into a central, versioned repository through common interfaces, provides efficient access to arbitrary subsets of data even when the underlying data store is evolving, allows reproducing of query results and supports findable-, accessible-, interoperable- and reusable data. -[Get Started](/getting-started){ .action-button .md-button .md-button--primary } [PDF](/pdf/document.pdf){ .action-button .md-button .md-button--secondary } - -## Demo - -Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at) +## More Information - \ No newline at end of file +- This documentation can be downloaded as [PDF](/pdf/document.pdf) +- Public demonstration instance [https://dbrepo.ossdip.at](https://dbrepo.ossdip.at) +- Join our [mailing list](https://lists.univie.ac.at/mailman/listinfo/fairdata_dbrepo) to receive bi-monthly updates + about the progress, new features and events! \ No newline at end of file diff --git a/docs/operation/authentication.md b/docs/operation/authentication.md new file mode 100644 index 0000000000000000000000000000000000000000..ffba93fdd0895b9af5bd2fde7de8f30ed6477cc3 --- /dev/null +++ b/docs/operation/authentication.md @@ -0,0 +1,2449 @@ +--- +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/container.md b/docs/operation/container.md new file mode 100644 index 0000000000000000000000000000000000000000..e22efa9bdb3da115cd1b45be516081e170b386a0 --- /dev/null +++ b/docs/operation/container.md @@ -0,0 +1,2902 @@ +--- +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/database.md b/docs/operation/database.md new file mode 100644 index 0000000000000000000000000000000000000000..89136d548179b0c4fdaaf1ff47390654351f9727 --- /dev/null +++ b/docs/operation/database.md @@ -0,0 +1,2320 @@ +--- +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/identifier.md b/docs/operation/identifier.md new file mode 100644 index 0000000000000000000000000000000000000000..4976c64a8d93e14edfb19177c7cddd12d4c633db --- /dev/null +++ b/docs/operation/identifier.md @@ -0,0 +1,3623 @@ +--- +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.md b/docs/operation/index.md similarity index 88% rename from docs/operation.md rename to docs/operation/index.md index f42b701d78149b4c231554dc1f1eb9d4d62ee9e4..01f6d415b16a99cb79e1e0b5a25a2b342a793588 100644 --- a/docs/operation.md +++ b/docs/operation/index.md @@ -1,10 +1,3 @@ ---- -hide: - -- navigation - ---- - # Operation ## Deploy diff --git a/docs/operation/query.md b/docs/operation/query.md new file mode 100644 index 0000000000000000000000000000000000000000..63dfb3d3011deae361be025847308bf8297c6c12 --- /dev/null +++ b/docs/operation/query.md @@ -0,0 +1,1014 @@ +--- +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 d6d5d5702cf33bb7a5579acb2208f09ca16a8f12..e5d8283d096ce5b2f97ff25a9957b606496e63da 100644 --- a/docs/system.md +++ b/docs/system.md @@ -9,6 +9,100 @@ hide: ## 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). + +<figure markdown> + +<figcaption>Microservice cloud architecture</figcaption> +</figure> + +### Discovery Service + +This microservice allows service discovery and registration of containers that provide services. + +### Gateway Service + +Provides a single point of access to the *application programming interface* (API). + +### Authentication Service + +Very specific to the deployment of the organization. In our reference implementation we implement a *security assertion +markup language* (SAML) service provider and use our institutional SAML identity provider for obtaining account data +through an encrypted channel. + +### Metadata Database + +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. + +### Unit Service + +It is designed to map terms in the domain of units of measurement to controlled vocabulary, modelled in +the [ontology of units of measure](https://github.com/HajoRijgersberg/OM). This service validates researcher provided in +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. + +### Identifier Service + +This microservice is responsible for creating and resolving a *persistent identifier* (PID) attached to a query to +obtain the metadata attached to it and allow re-execution of a query. We store both the query and hashes of the query +and result set to allow equality checks of the originally obtained result set and the currently obtained result set. In +the reference implementation we currently only use a numerical id column and plan to integrate *digital object +identifier* (DOI) through our institutional library soon. + +### 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. + +### Container Service + +It is responsible for Docker container lifecycle operations and updating the local copy of the Docker images. + +### 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. + +### 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. + +### 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. + +### 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 + +It provides a *graphical user interface* (GUI) for a researcher to interact with the database repository's API. + +### Analyse Service + +It suggests data types for the FAIR Portal when creating a table from a *comma separated values* (CSV) file. It +recommends enumerations for columns and returns e.g. a list of potential primary key candidates. The researcher is able +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 We use Docker for deployment. The containers are packing all runtime dependencies, when starting them all necessary diff --git a/misc/api-authentication.yaml b/misc/api-authentication.yaml new file mode 100644 index 0000000000000000000000000000000000000000..865b416ef51040269696b2b427d919964554fd1d --- /dev/null +++ b/misc/api-authentication.yaml @@ -0,0 +1,688 @@ +openapi: 3.0.1 +info: + title: Database Repository Authentication Service API + description: Service that manages the authentication + contact: + name: Prof. Andreas Rauber + email: andreas.rauber@tuwien.ac.at + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + version: 1.1.0-alpha +externalDocs: + description: Wiki Documentation + url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis +servers: +- url: http://localhost:9097 + description: Generated server url +paths: + /api/auth: + put: + tags: + - authentication-endpoint + summary: Validate token + operationId: authenticateUser + responses: + "417": + description: Expectation Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/UserDto' + security: + - bearerAuth: [] + post: + tags: + - authentication-endpoint + summary: Create token + operationId: authenticateUser_1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LoginRequestDto' + required: true + responses: + "417": + description: Expectation Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/JwtResponseDto' + /api/user: + get: + tags: + - user-endpoint + summary: List users + operationId: list + responses: + "417": + description: Expectation Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/UserDto' + security: + - bearerAuth: [] + post: + tags: + - user-endpoint + summary: Create user + operationId: register + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SignupRequestDto' + required: true + responses: + "417": + description: Expectation Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/UserDto' +components: + schemas: + ApiErrorDto: + required: + - code + - message + - status + type: object + properties: + status: + type: string + enum: + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED + message: + type: string + code: + type: string + ColumnDto: + required: + - auto_generated + - column_concept + - column_type + - date_format + - id + - internal_name + - is_null_allowed + - is_primary_key + - name + - unique + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + unique: + type: boolean + references: + type: string + internal_name: + type: string + date_format: + $ref: '#/components/schemas/ImageDateDto' + auto_generated: + type: boolean + is_primary_key: + type: boolean + column_type: + type: string + enum: + - ColumnTypeDto.ENUM + - ColumnTypeDto.NUMBER + - ColumnTypeDto.DECIMAL + - ColumnTypeDto.STRING + - ColumnTypeDto.TEXT + - ColumnTypeDto.BOOLEAN + - ColumnTypeDto.DATE + - ColumnTypeDto.BLOB + column_concept: + $ref: '#/components/schemas/ConceptDto' + decimal_digits_before: + type: integer + format: int64 + decimal_digits_after: + type: integer + format: int64 + is_null_allowed: + type: boolean + check_expression: + type: string + foreign_key: + type: string + enum_values: + type: array + items: + type: string + ConceptDto: + required: + - created + - name + - uri + type: object + properties: + uri: + type: string + name: + type: string + created: + type: string + format: date-time + ContainerDto: + required: + - created + - databases + - hash + - id + - image + - internal_name + - ip_address + - is_public + - name + - port + - state + type: object + properties: + id: + type: integer + format: int64 + hash: + type: string + name: + type: string + state: + type: string + enum: + - ContainerStateDto.CREATED + - ContainerStateDto.RESTARTING + - ContainerStateDto.RUNNING + - ContainerStateDto.PAUSED + - ContainerStateDto.EXITED + - ContainerStateDto.DEAD + databases: + type: array + items: + $ref: '#/components/schemas/DatabaseDto' + image: + $ref: '#/components/schemas/ImageDto' + port: + type: integer + format: int32 + created: + type: string + format: date-time + internal_name: + type: string + ip_address: + type: string + is_public: + type: boolean + DatabaseDto: + required: + - container + - description + - exchange + - id + - image + - internal_name + - name + - tables + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + publisher: + type: string + license: + type: string + contact: + $ref: '#/components/schemas/UserDto' + tables: + type: array + items: + $ref: '#/components/schemas/TableDto' + exchange: + type: string + image: + $ref: '#/components/schemas/ImageDto' + container: + $ref: '#/components/schemas/ContainerDto' + created: + type: string + format: date-time + deleted: + type: string + format: date-time + internal_name: + type: string + GrantedAuthorityDto: + type: object + properties: + authority: + type: string + ImageDateDto: + required: + - database_format + - example + - id + - unix_format + type: object + properties: + id: + type: integer + format: int64 + example: + type: string + database_format: + type: string + unix_format: + type: string + created_at: + type: string + format: date-time + ImageDto: + required: + - default_port + - dialect + - driver_class + - environment + - id + - jdbc_method + - repository + - tag + type: object + properties: + id: + type: integer + format: int64 + repository: + type: string + tag: + type: string + logo: + type: string + dialect: + type: string + hash: + type: string + compiled: + type: string + format: date-time + size: + type: integer + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + driver_class: + type: string + date_formats: + type: array + items: + $ref: '#/components/schemas/ImageDateDto' + jdbc_method: + type: string + default_port: + type: integer + format: int32 + ImageEnvItemDto: + required: + - iid + - key + - value + type: object + properties: + iid: + type: integer + format: int64 + key: + type: string + value: + type: string + type: + type: string + enum: + - USERNAME + - PASSWORD + - PRIVILEGED_USERNAME + - PRIVILEGED_PASSWORD + TableDto: + required: + - columns + - description + - id + - internal_name + - name + - null_element + - quote + - separator + - topic + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + topic: + type: string + description: + type: string + separator: + type: string + quote: + type: string + created: + type: string + format: date-time + columns: + type: array + items: + $ref: '#/components/schemas/ColumnDto' + internal_name: + type: string + null_element: + type: string + skip_lines: + type: integer + format: int64 + true_element: + type: string + false_element: + type: string + UserDto: + required: + - containers + - databases + - email + - firstname + - identifiers + - lastname + - titlesAfter + - titlesBefore + - username + type: object + properties: + id: + type: integer + format: int64 + authorities: + type: array + items: + $ref: '#/components/schemas/GrantedAuthorityDto' + username: + type: string + titlesBefore: + type: string + titlesAfter: + type: string + firstname: + type: string + lastname: + type: string + containers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + databases: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + identifiers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + email: + type: string + SignupRequestDto: + required: + - email + - password + - username + type: object + properties: + username: + type: string + email: + type: string + password: + type: string + LoginRequestDto: + required: + - password + - username + type: object + properties: + username: + type: string + password: + type: string + JwtResponseDto: + required: + - email + - id + - roles + - token + - type + - username + type: object + properties: + token: + type: string + type: + type: string + id: + type: integer + format: int64 + username: + type: string + email: + type: string + roles: + type: array + items: + type: string + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/misc/api-container.yaml b/misc/api-container.yaml new file mode 100644 index 0000000000000000000000000000000000000000..c41b9f54bc6f97dd44310ebf475bc4d7cd66b18c --- /dev/null +++ b/misc/api-container.yaml @@ -0,0 +1,1075 @@ +openapi: 3.0.1 +info: + title: Database Repository Container Service API + description: Service that manages the containers + contact: + name: Prof. Andreas Rauber + email: andreas.rauber@tuwien.ac.at + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + version: 1.1.0-alpha +externalDocs: + description: Wiki Documentation + url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis +servers: +- url: http://localhost:9091 + description: Generated server url +paths: + /api/image/{id}: + get: + tags: + - image-endpoint + summary: Find some image + operationId: findById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ImageDto' + put: + tags: + - image-endpoint + summary: Update some image + operationId: update + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageChangeDto' + required: true + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ImageDto' + security: + - bearerAuth: [] + delete: + tags: + - image-endpoint + summary: Delete some image + operationId: delete + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: object + security: + - bearerAuth: [] + /api/container/{id}: + get: + tags: + - container-endpoint + summary: Find some container + operationId: findById_1 + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ContainerDto' + put: + tags: + - container-endpoint + summary: Modify some container + operationId: modify + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContainerChangeDto' + required: true + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ContainerBriefDto' + security: + - bearerAuth: [] + delete: + tags: + - container-endpoint + summary: Delete some container + operationId: delete_1 + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: object + security: + - bearerAuth: [] + /api/image: + get: + tags: + - image-endpoint + summary: Find all images + operationId: findAll + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/ImageBriefDto' + post: + tags: + - image-endpoint + summary: Create image + operationId: create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImageCreateDto' + required: true + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ImageDto' + security: + - bearerAuth: [] + /api/container: + get: + tags: + - container-endpoint + summary: Find all containers + operationId: findAll_1 + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/ContainerBriefDto' + post: + tags: + - container-endpoint + summary: Create container + operationId: create_1 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ContainerCreateRequestDto' + required: true + responses: + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "403": + description: Forbidden + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/ContainerBriefDto' + security: + - bearerAuth: [] +components: + schemas: + ApiErrorDto: + required: + - code + - message + - status + type: object + properties: + status: + type: string + enum: + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED + message: + type: string + code: + type: string + ImageChangeDto: + required: + - dialect + - driver_class + - jdbc_method + - logo + type: object + properties: + defaultPort: + maximum: 65535 + minimum: 1024 + type: integer + format: int32 + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + logo: + type: string + dialect: + type: string + driver_class: + type: string + jdbc_method: + type: string + ImageEnvItemDto: + required: + - iid + - key + - value + type: object + properties: + iid: + type: integer + format: int64 + key: + type: string + value: + type: string + type: + type: string + enum: + - USERNAME + - PASSWORD + - PRIVILEGED_USERNAME + - PRIVILEGED_PASSWORD + ImageDateDto: + required: + - database_format + - example + - id + - unix_format + type: object + properties: + id: + type: integer + format: int64 + example: + type: string + database_format: + type: string + unix_format: + type: string + created_at: + type: string + format: date-time + ImageDto: + required: + - default_port + - dialect + - driver_class + - environment + - id + - jdbc_method + - repository + - tag + type: object + properties: + id: + type: integer + format: int64 + repository: + type: string + tag: + type: string + logo: + type: string + dialect: + type: string + hash: + type: string + compiled: + type: string + format: date-time + size: + type: integer + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + driver_class: + type: string + date_formats: + type: array + items: + $ref: '#/components/schemas/ImageDateDto' + jdbc_method: + type: string + default_port: + type: integer + format: int32 + ContainerChangeDto: + required: + - action + type: object + properties: + action: + type: string + enum: + - ContainerActionTypeDto.START + - ContainerActionTypeDto.STOP + ContainerBriefDto: + required: + - hash + - id + - internal_name + - is_public + - name + type: object + properties: + id: + type: integer + format: int64 + hash: + type: string + name: + type: string + internal_name: + type: string + is_public: + type: boolean + ImageCreateDto: + required: + - default_port + - dialect + - driver_class + - jdbc_method + - local + - logo + - repository + - tag + type: object + properties: + repository: + type: string + tag: + type: string + dialect: + type: string + logo: + type: string + local: + type: boolean + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + driver_class: + type: string + jdbc_method: + type: string + default_port: + type: integer + format: int32 + ContainerCreateRequestDto: + required: + - name + - repository + - tag + type: object + properties: + name: + type: string + repository: + type: string + tag: + type: string + ImageBriefDto: + required: + - id + - repository + - tag + type: object + properties: + id: + type: integer + format: int64 + repository: + type: string + logo: + type: string + tag: + type: string + ColumnDto: + required: + - auto_generated + - column_concept + - column_type + - date_format + - id + - internal_name + - is_null_allowed + - is_primary_key + - name + - unique + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + unique: + type: boolean + references: + type: string + internal_name: + type: string + date_format: + $ref: '#/components/schemas/ImageDateDto' + auto_generated: + type: boolean + is_primary_key: + type: boolean + column_type: + type: string + enum: + - ColumnTypeDto.ENUM + - ColumnTypeDto.NUMBER + - ColumnTypeDto.DECIMAL + - ColumnTypeDto.STRING + - ColumnTypeDto.TEXT + - ColumnTypeDto.BOOLEAN + - ColumnTypeDto.DATE + - ColumnTypeDto.BLOB + column_concept: + $ref: '#/components/schemas/ConceptDto' + decimal_digits_before: + type: integer + format: int64 + decimal_digits_after: + type: integer + format: int64 + is_null_allowed: + type: boolean + check_expression: + type: string + foreign_key: + type: string + enum_values: + type: array + items: + type: string + ConceptDto: + required: + - created + - name + - uri + type: object + properties: + uri: + type: string + name: + type: string + created: + type: string + format: date-time + ContainerDto: + required: + - created + - databases + - hash + - id + - image + - internal_name + - ip_address + - is_public + - name + - port + - state + type: object + properties: + id: + type: integer + format: int64 + hash: + type: string + name: + type: string + state: + type: string + enum: + - ContainerStateDto.CREATED + - ContainerStateDto.RESTARTING + - ContainerStateDto.RUNNING + - ContainerStateDto.PAUSED + - ContainerStateDto.EXITED + - ContainerStateDto.DEAD + databases: + type: array + items: + $ref: '#/components/schemas/DatabaseDto' + image: + $ref: '#/components/schemas/ImageDto' + port: + type: integer + format: int32 + created: + type: string + format: date-time + internal_name: + type: string + ip_address: + type: string + is_public: + type: boolean + DatabaseDto: + required: + - container + - description + - exchange + - id + - image + - internal_name + - name + - tables + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + publisher: + type: string + license: + type: string + contact: + $ref: '#/components/schemas/UserDto' + tables: + type: array + items: + $ref: '#/components/schemas/TableDto' + exchange: + type: string + image: + $ref: '#/components/schemas/ImageDto' + container: + $ref: '#/components/schemas/ContainerDto' + created: + type: string + format: date-time + deleted: + type: string + format: date-time + internal_name: + type: string + GrantedAuthorityDto: + type: object + properties: + authority: + type: string + TableDto: + required: + - columns + - description + - id + - internal_name + - name + - null_element + - quote + - separator + - topic + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + topic: + type: string + description: + type: string + separator: + type: string + quote: + type: string + created: + type: string + format: date-time + columns: + type: array + items: + $ref: '#/components/schemas/ColumnDto' + internal_name: + type: string + null_element: + type: string + skip_lines: + type: integer + format: int64 + true_element: + type: string + false_element: + type: string + UserDto: + required: + - containers + - databases + - email + - firstname + - identifiers + - lastname + - titlesAfter + - titlesBefore + - username + type: object + properties: + id: + type: integer + format: int64 + authorities: + type: array + items: + $ref: '#/components/schemas/GrantedAuthorityDto' + username: + type: string + titlesBefore: + type: string + titlesAfter: + type: string + firstname: + type: string + lastname: + type: string + containers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + databases: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + identifiers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + email: + type: string + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/misc/api-database.yaml b/misc/api-database.yaml new file mode 100644 index 0000000000000000000000000000000000000000..65b0c43d588c6c6c1c25996aaa91dc1ede027128 --- /dev/null +++ b/misc/api-database.yaml @@ -0,0 +1,707 @@ +openapi: 3.0.1 +info: + title: Database Repository Database Service API + description: Service that manages the databases + contact: + name: Prof. Andreas Rauber + email: andreas.rauber@tuwien.ac.at + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + version: 1.1.0-alpha +externalDocs: + description: Wiki Documentation + url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis +servers: +- url: http://localhost:9092 + description: Generated server url +paths: + /api/container/{id}/database: + get: + tags: + - container-database-endpoint + summary: List databases + operationId: findAll + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + responses: + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "502": + description: Bad Gateway + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/DatabaseBriefDto' + post: + tags: + - container-database-endpoint + summary: Create database + operationId: create + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseCreateDto' + required: true + responses: + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "502": + description: Bad Gateway + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/DatabaseDto' + security: + - bearerAuth: [] + /api/container/{id}/database/{databaseId}: + get: + tags: + - container-database-endpoint + summary: List some database + operationId: findById + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + responses: + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "502": + description: Bad Gateway + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/DatabaseDto' + delete: + tags: + - container-database-endpoint + summary: Delete some database + operationId: delete + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + responses: + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "502": + description: Bad Gateway + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: object + security: + - bearerAuth: [] +components: + schemas: + ApiErrorDto: + required: + - code + - message + - status + type: object + properties: + status: + type: string + enum: + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED + message: + type: string + code: + type: string + DatabaseCreateDto: + required: + - description + - is_public + - name + type: object + properties: + name: + type: string + description: + type: string + is_public: + type: boolean + ColumnDto: + required: + - auto_generated + - column_concept + - column_type + - date_format + - id + - internal_name + - is_null_allowed + - is_primary_key + - name + - unique + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + unique: + type: boolean + references: + type: string + internal_name: + type: string + date_format: + $ref: '#/components/schemas/ImageDateDto' + auto_generated: + type: boolean + is_primary_key: + type: boolean + column_type: + type: string + enum: + - ColumnTypeDto.ENUM + - ColumnTypeDto.NUMBER + - ColumnTypeDto.DECIMAL + - ColumnTypeDto.STRING + - ColumnTypeDto.TEXT + - ColumnTypeDto.BOOLEAN + - ColumnTypeDto.DATE + - ColumnTypeDto.BLOB + column_concept: + $ref: '#/components/schemas/ConceptDto' + decimal_digits_before: + type: integer + format: int64 + decimal_digits_after: + type: integer + format: int64 + is_null_allowed: + type: boolean + check_expression: + type: string + foreign_key: + type: string + enum_values: + type: array + items: + type: string + ConceptDto: + required: + - created + - name + - uri + type: object + properties: + uri: + type: string + name: + type: string + created: + type: string + format: date-time + ContainerDto: + required: + - created + - databases + - hash + - id + - image + - internal_name + - ip_address + - is_public + - name + - port + - state + type: object + properties: + id: + type: integer + format: int64 + hash: + type: string + name: + type: string + state: + type: string + enum: + - ContainerStateDto.CREATED + - ContainerStateDto.RESTARTING + - ContainerStateDto.RUNNING + - ContainerStateDto.PAUSED + - ContainerStateDto.EXITED + - ContainerStateDto.DEAD + databases: + type: array + items: + $ref: '#/components/schemas/DatabaseDto' + image: + $ref: '#/components/schemas/ImageDto' + port: + type: integer + format: int32 + created: + type: string + format: date-time + internal_name: + type: string + ip_address: + type: string + is_public: + type: boolean + DatabaseDto: + required: + - container + - description + - exchange + - id + - image + - internal_name + - name + - tables + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + publisher: + type: string + license: + type: string + contact: + $ref: '#/components/schemas/UserDto' + tables: + type: array + items: + $ref: '#/components/schemas/TableDto' + exchange: + type: string + image: + $ref: '#/components/schemas/ImageDto' + container: + $ref: '#/components/schemas/ContainerDto' + created: + type: string + format: date-time + deleted: + type: string + format: date-time + internal_name: + type: string + GrantedAuthorityDto: + type: object + properties: + authority: + type: string + ImageDateDto: + required: + - database_format + - example + - id + - unix_format + type: object + properties: + id: + type: integer + format: int64 + example: + type: string + database_format: + type: string + unix_format: + type: string + created_at: + type: string + format: date-time + ImageDto: + required: + - default_port + - dialect + - driver_class + - environment + - id + - jdbc_method + - repository + - tag + type: object + properties: + id: + type: integer + format: int64 + repository: + type: string + tag: + type: string + logo: + type: string + dialect: + type: string + hash: + type: string + compiled: + type: string + format: date-time + size: + type: integer + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + driver_class: + type: string + date_formats: + type: array + items: + $ref: '#/components/schemas/ImageDateDto' + jdbc_method: + type: string + default_port: + type: integer + format: int32 + ImageEnvItemDto: + required: + - iid + - key + - value + type: object + properties: + iid: + type: integer + format: int64 + key: + type: string + value: + type: string + type: + type: string + enum: + - USERNAME + - PASSWORD + - PRIVILEGED_USERNAME + - PRIVILEGED_PASSWORD + TableDto: + required: + - columns + - description + - id + - internal_name + - name + - null_element + - quote + - separator + - topic + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + topic: + type: string + description: + type: string + separator: + type: string + quote: + type: string + created: + type: string + format: date-time + columns: + type: array + items: + $ref: '#/components/schemas/ColumnDto' + internal_name: + type: string + null_element: + type: string + skip_lines: + type: integer + format: int64 + true_element: + type: string + false_element: + type: string + UserDto: + required: + - containers + - databases + - email + - firstname + - identifiers + - lastname + - titlesAfter + - titlesBefore + - username + type: object + properties: + id: + type: integer + format: int64 + authorities: + type: array + items: + $ref: '#/components/schemas/GrantedAuthorityDto' + username: + type: string + titlesBefore: + type: string + titlesAfter: + type: string + firstname: + type: string + lastname: + type: string + containers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + databases: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + identifiers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + email: + type: string + DatabaseBriefDto: + required: + - description + - engine + - id + - name + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + engine: + type: string + created: + type: string + format: date-time + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/misc/api-identifier.yaml b/misc/api-identifier.yaml new file mode 100644 index 0000000000000000000000000000000000000000..60dce27476ee4bae564622788ddda84013ce183e --- /dev/null +++ b/misc/api-identifier.yaml @@ -0,0 +1,870 @@ +openapi: 3.0.1 +info: + title: Database Repository Identifier Service API + description: Service that manages the identifiers + contact: + name: Prof. Andreas Rauber + email: andreas.rauber@tuwien.ac.at + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + version: 1.1.0-alpha +externalDocs: + description: Wiki Documentation + url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis +servers: +- url: http://localhost:9096 + description: Generated server url +paths: + /api/container/{id}/database/{databaseId}/identifier/{identiferId}: + put: + tags: + - identifier-endpoint + summary: Publish some identifier + operationId: publish + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: identiferId + in: query + required: true + schema: + type: integer + format: int64 + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: object + security: + - bearerAuth: [] + post: + tags: + - identifier-endpoint + summary: Update some identifier + operationId: update + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: identiferId + in: query + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdentifierDto' + required: true + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/IdentifierDto' + security: + - bearerAuth: [] + delete: + tags: + - identifier-endpoint + summary: Delete some identifer + operationId: delete + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: identiferId + in: query + required: true + schema: + type: integer + format: int64 + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: object + security: + - bearerAuth: [] + /api/container/{id}/database/{databaseId}/identifier: + get: + tags: + - identifier-endpoint + summary: Find identifiers + operationId: findAll + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: qid + in: query + required: false + schema: + type: integer + format: int64 + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/IdentifierDto' + post: + tags: + - identifier-endpoint + summary: Create identifier + operationId: create + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdentifierDto' + required: true + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/IdentifierDto' + security: + - bearerAuth: [] + /api/pid/{pid}: + get: + tags: + - persistence-endpoint + summary: Find some identifier + operationId: find + parameters: + - name: pid + in: path + required: true + schema: + type: integer + format: int64 + responses: + "406": + description: Not Acceptable + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "204": + description: No Content + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "412": + description: Precondition Failed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/IdentifierDto' +components: + schemas: + ApiErrorDto: + required: + - code + - message + - status + type: object + properties: + status: + type: string + enum: + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED + message: + type: string + code: + type: string + ColumnDto: + required: + - auto_generated + - column_concept + - column_type + - date_format + - id + - internal_name + - is_null_allowed + - is_primary_key + - name + - unique + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + unique: + type: boolean + references: + type: string + internal_name: + type: string + date_format: + $ref: '#/components/schemas/ImageDateDto' + auto_generated: + type: boolean + is_primary_key: + type: boolean + column_type: + type: string + enum: + - ColumnTypeDto.ENUM + - ColumnTypeDto.NUMBER + - ColumnTypeDto.DECIMAL + - ColumnTypeDto.STRING + - ColumnTypeDto.TEXT + - ColumnTypeDto.BOOLEAN + - ColumnTypeDto.DATE + - ColumnTypeDto.BLOB + column_concept: + $ref: '#/components/schemas/ConceptDto' + decimal_digits_before: + type: integer + format: int64 + decimal_digits_after: + type: integer + format: int64 + is_null_allowed: + type: boolean + check_expression: + type: string + foreign_key: + type: string + enum_values: + type: array + items: + type: string + ConceptDto: + required: + - created + - name + - uri + type: object + properties: + uri: + type: string + name: + type: string + created: + type: string + format: date-time + ContainerDto: + required: + - created + - databases + - hash + - id + - image + - internal_name + - ip_address + - is_public + - name + - port + - state + type: object + properties: + id: + type: integer + format: int64 + hash: + type: string + name: + type: string + state: + type: string + enum: + - ContainerStateDto.CREATED + - ContainerStateDto.RESTARTING + - ContainerStateDto.RUNNING + - ContainerStateDto.PAUSED + - ContainerStateDto.EXITED + - ContainerStateDto.DEAD + databases: + type: array + items: + $ref: '#/components/schemas/DatabaseDto' + image: + $ref: '#/components/schemas/ImageDto' + port: + type: integer + format: int32 + created: + type: string + format: date-time + internal_name: + type: string + ip_address: + type: string + is_public: + type: boolean + DatabaseDto: + required: + - container + - description + - exchange + - id + - image + - internal_name + - name + - tables + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + description: + type: string + publisher: + type: string + license: + type: string + contact: + $ref: '#/components/schemas/UserDto' + tables: + type: array + items: + $ref: '#/components/schemas/TableDto' + exchange: + type: string + image: + $ref: '#/components/schemas/ImageDto' + container: + $ref: '#/components/schemas/ContainerDto' + created: + type: string + format: date-time + deleted: + type: string + format: date-time + internal_name: + type: string + GrantedAuthorityDto: + type: object + properties: + authority: + type: string + IdentifierDto: + required: + - cid + - creators + - dbid + - description + - qid + - title + - visibility + type: object + properties: + id: + type: integer + format: int64 + cid: + type: integer + format: int64 + dbid: + type: integer + format: int64 + qid: + type: integer + format: int64 + title: + type: string + description: + type: string + visibility: + type: string + enum: + - VisibilityTypeDto.EVERYONE + - VisibilityTypeDto.TRUSTED + - VisibilityTypeDto.SELF + doi: + type: string + creators: + type: array + items: + $ref: '#/components/schemas/UserDto' + created: + type: string + format: date-time + last_modified: + type: string + format: date-time + ImageDateDto: + required: + - database_format + - example + - id + - unix_format + type: object + properties: + id: + type: integer + format: int64 + example: + type: string + database_format: + type: string + unix_format: + type: string + created_at: + type: string + format: date-time + ImageDto: + required: + - default_port + - dialect + - driver_class + - environment + - id + - jdbc_method + - repository + - tag + type: object + properties: + id: + type: integer + format: int64 + repository: + type: string + tag: + type: string + logo: + type: string + dialect: + type: string + hash: + type: string + compiled: + type: string + format: date-time + size: + type: integer + environment: + type: array + items: + $ref: '#/components/schemas/ImageEnvItemDto' + driver_class: + type: string + date_formats: + type: array + items: + $ref: '#/components/schemas/ImageDateDto' + jdbc_method: + type: string + default_port: + type: integer + format: int32 + ImageEnvItemDto: + required: + - iid + - key + - value + type: object + properties: + iid: + type: integer + format: int64 + key: + type: string + value: + type: string + type: + type: string + enum: + - USERNAME + - PASSWORD + - PRIVILEGED_USERNAME + - PRIVILEGED_PASSWORD + TableDto: + required: + - columns + - description + - id + - internal_name + - name + - null_element + - quote + - separator + - topic + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + topic: + type: string + description: + type: string + separator: + type: string + quote: + type: string + created: + type: string + format: date-time + columns: + type: array + items: + $ref: '#/components/schemas/ColumnDto' + internal_name: + type: string + null_element: + type: string + skip_lines: + type: integer + format: int64 + true_element: + type: string + false_element: + type: string + UserDto: + required: + - containers + - databases + - email + - firstname + - identifiers + - lastname + - titlesAfter + - titlesBefore + - username + type: object + properties: + id: + type: integer + format: int64 + authorities: + type: array + items: + $ref: '#/components/schemas/GrantedAuthorityDto' + username: + type: string + titlesBefore: + type: string + titlesAfter: + type: string + firstname: + type: string + lastname: + type: string + containers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + databases: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + identifiers: + type: array + items: + $ref: '#/components/schemas/ContainerDto' + email: + type: string + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/misc/api-query.yaml b/misc/api-query.yaml new file mode 100644 index 0000000000000000000000000000000000000000..523b684bced6b7b64faa6147a5bc456de9585128 --- /dev/null +++ b/misc/api-query.yaml @@ -0,0 +1,814 @@ +openapi: 3.0.1 +info: + title: Database Repository Query Service API + description: Service that manages the queries + contact: + name: Prof. Andreas Rauber + email: andreas.rauber@tuwien.ac.at + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + version: 1.1.0-alpha +externalDocs: + description: Wiki Documentation + url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis +servers: +- url: http://localhost:9093 + description: Generated server url +paths: + /api/container/{id}/database/{databaseId}/table/{tableId}/data: + get: + tags: + - table-data-endpoint + summary: Find data + operationId: getAll_1 + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: tableId + in: path + required: true + schema: + type: integer + format: int64 + - name: timestamp + in: query + required: false + schema: + type: string + format: date-time + - name: page + in: query + required: false + schema: + type: integer + format: int64 + - name: size + in: query + required: false + schema: + type: integer + format: int64 + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/QueryResultDto' + post: + tags: + - table-data-endpoint + summary: Insert data + operationId: insert + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: tableId + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/TableCsvDto' + required: true + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: integer + format: int32 + security: + - bearerAuth: [] + head: + tags: + - table-data-endpoint + summary: Find data + operationId: getAll + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: tableId + in: path + required: true + schema: + type: integer + format: int64 + - name: timestamp + in: query + required: false + schema: + type: string + format: date-time + - name: page + in: query + required: false + schema: + type: integer + format: int64 + - name: size + in: query + required: false + schema: + type: integer + format: int64 + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/QueryResultDto' + /api/container/{id}/database/{databaseId}/query: + get: + tags: + - store-endpoint + summary: Find queries + operationId: findAll + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/QueryDto' + put: + tags: + - query-endpoint + summary: Execute query + operationId: execute + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: page + in: query + required: false + schema: + type: integer + format: int64 + - name: size + in: query + required: false + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ExecuteStatementDto' + required: true + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/QueryResultDto' + security: + - bearerAuth: [] + /api/container/{id}/database/{databaseId}/query/{queryId}: + get: + tags: + - store-endpoint + summary: Find some query + operationId: find + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: queryId + in: path + required: true + schema: + type: integer + format: int64 + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/QueryDto' + put: + tags: + - query-endpoint + summary: Re-execute some query + operationId: reExecute + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: queryId + in: path + required: true + schema: + type: integer + format: int64 + - name: page + in: query + required: false + schema: + type: integer + format: int64 + - name: size + in: query + required: false + schema: + type: integer + format: int64 + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/QueryResultDto' + security: + - bearerAuth: [] + /api/container/{id}/database/{databaseId}/table/{tableId}/data/import: + post: + tags: + - table-data-endpoint + summary: Insert data from csv + operationId: importCsv + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: tableId + in: path + required: true + schema: + type: integer + format: int64 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ImportDto' + required: true + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: integer + format: int32 + security: + - bearerAuth: [] + /api/container/{id}/database/{databaseId}/table/{tableId}/export: + get: + tags: + - export-endpoint + summary: Export table + operationId: export + parameters: + - name: id + in: path + required: true + schema: + type: integer + format: int64 + - name: databaseId + in: path + required: true + schema: + type: integer + format: int64 + - name: tableId + in: path + required: true + schema: + type: integer + format: int64 + - name: timestamp + in: query + required: false + schema: + type: string + format: date-time + responses: + "404": + description: Not Found + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "400": + description: Bad Request + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "409": + description: Conflict + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "405": + description: Method Not Allowed + content: + '*/*': + schema: + $ref: '#/components/schemas/ApiErrorDto' + "200": + description: OK + content: + '*/*': + schema: + type: string + format: binary + security: + - bearerAuth: [] +components: + schemas: + ApiErrorDto: + required: + - code + - message + - status + type: object + properties: + status: + type: string + enum: + - 100 CONTINUE + - 101 SWITCHING_PROTOCOLS + - 102 PROCESSING + - 103 CHECKPOINT + - 200 OK + - 201 CREATED + - 202 ACCEPTED + - 203 NON_AUTHORITATIVE_INFORMATION + - 204 NO_CONTENT + - 205 RESET_CONTENT + - 206 PARTIAL_CONTENT + - 207 MULTI_STATUS + - 208 ALREADY_REPORTED + - 226 IM_USED + - 300 MULTIPLE_CHOICES + - 301 MOVED_PERMANENTLY + - 302 FOUND + - 302 MOVED_TEMPORARILY + - 303 SEE_OTHER + - 304 NOT_MODIFIED + - 305 USE_PROXY + - 307 TEMPORARY_REDIRECT + - 308 PERMANENT_REDIRECT + - 400 BAD_REQUEST + - 401 UNAUTHORIZED + - 402 PAYMENT_REQUIRED + - 403 FORBIDDEN + - 404 NOT_FOUND + - 405 METHOD_NOT_ALLOWED + - 406 NOT_ACCEPTABLE + - 407 PROXY_AUTHENTICATION_REQUIRED + - 408 REQUEST_TIMEOUT + - 409 CONFLICT + - 410 GONE + - 411 LENGTH_REQUIRED + - 412 PRECONDITION_FAILED + - 413 PAYLOAD_TOO_LARGE + - 413 REQUEST_ENTITY_TOO_LARGE + - 414 URI_TOO_LONG + - 414 REQUEST_URI_TOO_LONG + - 415 UNSUPPORTED_MEDIA_TYPE + - 416 REQUESTED_RANGE_NOT_SATISFIABLE + - 417 EXPECTATION_FAILED + - 418 I_AM_A_TEAPOT + - 419 INSUFFICIENT_SPACE_ON_RESOURCE + - 420 METHOD_FAILURE + - 421 DESTINATION_LOCKED + - 422 UNPROCESSABLE_ENTITY + - 423 LOCKED + - 424 FAILED_DEPENDENCY + - 425 TOO_EARLY + - 426 UPGRADE_REQUIRED + - 428 PRECONDITION_REQUIRED + - 429 TOO_MANY_REQUESTS + - 431 REQUEST_HEADER_FIELDS_TOO_LARGE + - 451 UNAVAILABLE_FOR_LEGAL_REASONS + - 500 INTERNAL_SERVER_ERROR + - 501 NOT_IMPLEMENTED + - 502 BAD_GATEWAY + - 503 SERVICE_UNAVAILABLE + - 504 GATEWAY_TIMEOUT + - 505 HTTP_VERSION_NOT_SUPPORTED + - 506 VARIANT_ALSO_NEGOTIATES + - 507 INSUFFICIENT_STORAGE + - 508 LOOP_DETECTED + - 509 BANDWIDTH_LIMIT_EXCEEDED + - 510 NOT_EXTENDED + - 511 NETWORK_AUTHENTICATION_REQUIRED + message: + type: string + code: + type: string + QueryResultDto: + required: + - id + - result + type: object + properties: + result: + type: array + items: + type: object + additionalProperties: + type: object + id: + type: integer + format: int64 + resultNumber: + type: integer + format: int64 + ColumnBriefDto: + required: + - id + - internal_name + - name + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + internal_name: + type: string + ExecuteStatementDto: + required: + - columns + - statement + - tables + type: object + properties: + statement: + type: string + tables: + type: array + items: + $ref: '#/components/schemas/TableBriefDto' + columns: + type: array + items: + type: array + items: + $ref: '#/components/schemas/ColumnBriefDto' + TableBriefDto: + required: + - id + - internal_name + - name + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + internal_name: + type: string + TableCsvDto: + required: + - data + type: object + properties: + data: + type: object + additionalProperties: + type: object + ImportDto: + required: + - location + type: object + properties: + location: + type: string + QueryDto: + required: + - cid + - created + - dbid + - id + - query + - query_hash + type: object + properties: + id: + type: integer + format: int64 + cid: + type: integer + format: int64 + dbid: + type: integer + format: int64 + execution: + type: string + format: date-time + query: + type: string + created: + type: string + format: date-time + query_normalized: + type: string + query_hash: + type: string + result_hash: + type: string + result_number: + type: integer + format: int64 + last_modified: + type: string + format: date-time + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT diff --git a/misc/diagrams.drawio b/misc/diagrams.drawio new file mode 100644 index 0000000000000000000000000000000000000000..71be41bb3c2fcc8cde6cf1e40bd985fe80fa3c3d --- /dev/null +++ b/misc/diagrams.drawio @@ -0,0 +1 @@ +<mxfile host="Electron" modified="2022-04-22T06:22:19.022Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/17.4.2 Chrome/100.0.4896.60 Electron/18.0.1 Safari/537.36" etag="kMcGUnc7b8fgl017WGgv" version="17.4.2" type="device" pages="2"><diagram id="31b32b95-0358-9bc7-6ba0-a27c054ed1a7" name="Page-1">7V1rk6I6E/4183WLu/DRC86xjqNTXuac/WShZJycRUIhzs68v/5NICiQ6OCKgCPW1qw24ZZ++kmn0zQPcnfz8ehb3tsTsoHzIAn2x4Pce5AkUZGkB/JPsD8jia62IsHahzZtdBBM4f8AFQpUuoM22KYaBgg5AfTSwhVyXbAKUjLL99HvdLNX5KTP6llrwAimK8thpf9AO3ijdyG1DvK/AFy/xWcWNSPasrRWv9Y+2rn0fC5yQbRlY8WHofe4fbNs9Dshks0HuesjFETfNh9d4JBujXss2q9/ZOv+kn3gBnl2oCp6t5wdvWt6XcFn3A3b33DjWPgO5M7+agXyI/DRL9BFDvLDhrIitVqdDt7yCh0nIX8NP0SO3IDX3nLg2sUyP+pMfGTLDygeyJlWyHEsbwuXDkidO9aKjCXsjdO+eAd+AD4SItoRjwBtQOB/4iZ0q6RQzX7GCKZK+n3QPlYyFb4lVK8bVGhRyK33Bz/0Pf5Cu5+vCplRxfO8Mxzg/YSROftnPPmbUQ2+MdJfb8EGH7QnJrrSAa9kC7l5iBHdpuIAeSf0kFKvbW3fgM3VdYjntJqpyLGWwOns4Z/dAZ93Sq9ejH9HahY1chbPWkF3PQyvvadytSrl1mpSay2O0uQCdKZ8bT4OjEyHQawNfcxaEBG9bNGOyJOaTCnji35lFbH2LRuCg5qTGqA9Lp1lkcds/RINxXYnqKydcRQmqQVoTGWtbDJ+GfTMCZZ2h+N5r7GyP9GhyOFKnWd16uU61Bgdtj3PwRoIrYk4BBsP9wW+mawqw/7a9/efWRtXS2nzlthB0Ox0BbFdnGVS6IWX+oy2kBJJbLAxJIeZ7Rto26QzGMzuN1wFHjE66Mjaklm0SBywiAUYfIsBy8B99S2ssN0q2PmAAAT473CFXc36wEXvdTVFauASqVAtDy46A5cny8We/qZedCL0OrLRa/AR4aNVHj4MBh89K7BCWCAf1Aghsqz2dLFBSIQQozyExMdIuieu5Xziu6/TCNNSFNkwGnxErM9xX6+GD5HBRw8Q/4N4rpZnLaGDO6dW3ki7JektocFKhJUSnVeRjc9NwWrnw+CzRvAwVUmUlQYeETxKdFZFNmY4NB/NUQExjH2f1TGMoTC6FK7jNgicqIbKUaZUhDLZYOIcz0zrNA50JUOVmlkHNfQSZx0iG/JiYNEEmnMHmqkGZY4GeYFntRDzZgNRjApvdantbE3IhpImWp3VhBqDPqmKIhbaRDbGQwP/wtTszieD2U9GM9bWi5aYX+EHod6OB3yIzwxIB+PDQ28Lng+iEwPt8XETbsIF6fj/Htys8a04cIn/wuUG/106aPVr9WZBF/9YEfJ7JVFvsLCwVSPiFf7Yvq+Pm3ESIQymtPDD1fiVhoHieZ+F5t7s8mMzDU2RXZziLQFrRQDTYHAH7DWIvSDkYyWvkWs55kHaSXsDK7SBK9YzAB8w+Dfx/Sdp8oOMi7ij/M9/6R7hj2ibpMbs0CapFFi2cqztlhw8Evehsz+6a7ONsDDR5D8QBJ8UExisCIsOtzNEZMEsGowYppNbeuRvss4JhlXf2kCHaOov4LwDAooM/gwWf92uYfT70SXSZkqGCpVTNIfHUH8F0gM+3ncN4maUt4juTgLOB44VwPdkIz6Awl1xF1ufiQYegm6wTRz5mQgS7oqaHu1EQUuC8cv2eKJ7ur0unGqPv0RXfID+/tZzWYPExtEoTWtOELo17/jrmnydT8nybSTGh01suQaRrzAgwm2XUPkucu3D/2+KtAsY/TNAa2mlMWxsZBcwbAIQuRSWi0Gz3JODUdPkdS1+zUOj+YhSqi9RyhniE78gymx7Q3solPjYoF/PfBl0zWnt2cwOA9l3zmeiXiKhyQ2hVURoSn0JLQNIRcgkAX/RXhYKJjQ2ssnPtKsLndnhkn5/5aCdfedkxouRXY3M1IbMKiIzjUNmetFklhsHbLTb7D2anIkfnvdRx+imJn8wk4HYJ328iNMQ741xmECCVqL/1DpJOcBZot8N25wRUiMdhmVxhDY3AeksAcXTrIK9Kcb9kbP4o/O5/SGii6J7HbB1rlsmx4GOa80bj65r1JQGN4nM2r7lwcVBcG8ciK+kOg5kc1oZyNztyqSiMHrgLkyKSgGOj8wJeY+Hw3ZnPGnPBi88D6hnvpjD8fOTOZrdmBNkg3fkkaBRqNkl8kMOX2AxcJD3HUjAOBt8aezJUmkcILNJqd3xaDYYzcfzKRd2z8Pxz9tFnBtAd4d2Www3z0G3tWxeBNJETaoMamx4G0OtP3icE5Ibjzhoe2qP2o/mbXOc+wrXOz98RPEb+TlnA0/SjcqAx2bLnuS4mTnFGx9vGHIxyQVgi7+u7w5sitiqDGxszLsH3scem857w4+XCxl9snnZR1Jv82syoSqDoypJK0BVbE2AZv6zn4hyUuC5E6B9FOWi6gwc34CmZk7mmKqf8BRIOAR9G0vaYzf/AMyoc+/8pwxLuVybusKo6IL1nGOZimreIa3m0VfT7Iri19FX5awxM8ZHMtaqUVky1qpVttgTs3rRIDlkt/58OPlsQwOSvCBpSVWBRPvGQ/QfUHg2vYOhdFHg+EpFDNAauzRb25mQdSgKROZDG7jyEV1jvfGZkHY2ZNKTbs7T7rp0nXmQXmhOR+MDFEXvnPXWONOnAh+g0CzGxge4JkiUynwAdnn7nn0AIU3ppToBORaMGyfg6k6Afi5mKnMCjCsFAhp+v4jf4wE/xe+Fp7DnLtTIJj/cMb/LejpZrEx+b7HJAA2/l87ve3uoP7/HWG0mefXid6lO/rtR6LO3jRNwTZBUthoQX03jBISTPOWHkfykXYL9qyhK8QnY5JnGJyjfJ5DOhVB1PsHpJ2san6Aiuuc8tlzdnM9gSaTxCeoJEr2y1YEWm0p3zz6BoKecglbmpVWlOgU5luUbp+DqToFyLoaqCwRfaTW44fvL+J7z+H8MgQr4PkeOyf3wvaxrP4TER6yS73PUsG34/up8r52LoeomgXozCawj33MSOyr075vEjtwxP4lTKPt6dN/kedSB7m8nzyN+trOh+1rRvc7J86jOvdebPI/84ZxS+V5v8j5qwPf6DeV9SI0p556pl2vKzXJtHUxZOhdDlZmy+o2fsDtbC9mH4FWDrcbGrwKmFfDYtMrGP5/Go8FsPAmrkWBla9aGPLge/eVULhmOHx9vr3IJUxV1g1wYIB+664WD1usvK5hw321XEypQzx9OvixEd63aJSob5qU1FzhYm5iPg+ksLt0kkJPE+HSX2yRAszBki4oNpt3xizm5tbpiDHDp6LWw4XaFsMY/F6n6T/eE4myhsTJhzMYVh+N27xg8t57lxlDrtIftUTdNocntPDsYz2+wWhQDXQdZ9mJp4WGe1B5ZYGR+XTnqeyE2W6GsTMSyAdfBaGZOjrNvd/z0NB8NuqnKebeKPUgOGnPnCm02O5fOC+4Jf9miZSXiT2NDc4NRf9LG4/u8O5tPmupLFw+HjC6vVn1JO/28RVPa/qGc0vaxA1RFaXsjrigdF0CUMyxRUGl7Iw5L7AstShmoXlbaPu7DBDHhKcdo2h9Png4zj6+mxd3xaGR2Z4OX8A2/tz1WBr7lbl+Rv4kqyuL5hUte8v1+a+8APmpC57yXXRVT6NvXFCtjyDxduqRh2bJYlpOyXhXLKrJ+JZYVuecpjGWPvqdN6LVn7e/z/iX6frfwUJ4Pt2BBJHfPm4qgX4s38U8foSAJTd/y3p6QDUiL/wM=</diagram><diagram id="SixR3OZ22FMnOk72hDml" name="Architecture">7V1be6I6F/41vZx5OKuXqOi4t6dR7Ex704dKpJlBwgbs4fv1X8JBgURrWxFs6YWVBULM+643K8lKvBI76+e+Z7gPI2QC+0rgzOcrsXslCAon41dieIkMohIbLA+akYnfGebwfyA2crF1A03gZy4MELID6GaNS+Q4YBlkbIbnoafsZStkZ5/qGhagDPOlYdPWX9AMHpLSNVInfgBoPcSPbonN6MTaSC6Ov4n/YJjoKWUStSux4yEURO/Wzx1gk7pL6iX6XG/P2e3zPeAEx3zg9/O182f039Mamv/8d2uJP2/+/PMtvsujYW/iLxwXNnhJasB/gmvbcPBRe/sVOHIQeOgv6CAbeeGFIhf+4TMraNsp+yr8I3bkBCm7JDQa7Ta2Gza0HGzzomrEdza8IKYCud8S2bbh+vDeBplnJ4DgqmzH3wN4AXjeW0H8ttoxXQFag8B7wZdkP/CSOXpKg660IuNDBnAlZlvMNGt74x0Y+E2MxxuwaSgUOOp0QOFj+G5E/BV8Bvh+bRd4EJcAkGrGj8GeAqY7U/shWONidPlUxS9xDYXnMgCbhv9Abhge5LDbYm0b98BuG8u/loc2jrkP9hhNnkDlu8YSOpaOXGwRsQGuQydM/nfh2sIVZsN7/Arv1/h14wPPJ0e4nJZnBMC8M6EFA8O+A8/k+wJnCfzv/qN1kJjvpM1+z9nLJVnOkElscBSdFI4mU2I7PZdkiktzbTyfzL40nXzg+MirLm34plIubQSKNYOxrs3Gmk7xBtdEwKaDDVbkDKktiBtWNTYHBLC9RNhPnSxODgpbpnSTE5v2UCn5AGFRXHo+xyplx6phWPauXATm6aalwUBVLApV8fVG34ZRg08x34QelgeICII+2hB7GvMMbK8gQEOGpd3EUh6wsEp5/PFxxD6PLsp/hSTczYQNNLSCXBS2EoVtr6vWznoygHm6IeebLOeVCwKYbshV17UxVqFTko7Q2sW1hr9jHvSwZrfIvM9pmXjSKpHrAWjtDser73bwLc9yJA2LOkU+jPUo8fuEvMPceVyPJqkMit3bE+cjUsKjuKVvinRLLzBoxRelG3RfY+CsPANDu1kGGw8QKgHvEeIwu0LEanY7iiTUxDpALLlkYjUoYo0MBwfm62pJFNdti61uzaQDTGqUzCSeHqyag+XGg8FLhYikyQIvSjWRDhCpVTaR6G7tUOtr4+7H4+Rt7VYxVJYo1IvsC+VR52jUeZnVNyoMdrrfu4gGgiojHh2hJQt1K3SARi2+bPGge9gUgerRk4+NnhwYNWeNpshKUVMwfIPCFpgWSAQWecEDspBj2NrO2s7KB+6PwyUtJeAZBr9T72/IJd+JI+Ea9F5+x58ID6JzgnwVT42pZF4T25a24fvk5pG5B+3t3R2TvggbU5f8AUHwEvPC2AQIm3ZfZ4jC0XT+IA0Yaoap1TPW0CYA/gD2IyDqkeNgi+Zgp9Nq9XpREePLpORbpY4jLAgA72AdBhFtvCU4dF08dYsfa4FDNxQkNo89YBsBfMwWj0XK8KMYIeMldYGLoBP4qTtPiSGlhPnZgbhF7R15vdAUD1/f5A5dj99EJd650/arf8DDmpSczrS5ps46P7SyJqeOn0Ai/+PpoyNmrihXUsI/ypXE4gKDoqQ7RzVGV/Gs81Z868O6naLOUdAepct5RTtCp7OSWJRqHyPOH5TfqqqqmFNJ/hVVzV/fUq72qiT9aZ79tG1xo0Yq/lTOC04gt0n11Y5RO8Ybww2J4w47Rj7nhfuIYyRPO5tjiLVjVM0xXg3YBelYD1I+6EEfy6Khhwwms746Htyq+mAyvhIUm3S47z38ziLveoOZ9ksdDkuKf8tNzvK3Y/q9FfTAk2HbcYi9t3tZYGBdVMBMdbaUslO95IMCCOx79FRr3xuGMkiFYVsyhHoOOfyoyrGbZrElMSPe7S0i+aWa5rcGHGLSazwmsj5Zu08nPkym2niuq51/aWHuDBdzvcLjEuvU1HrPcOHdzlAPU4SUynW/zqi6jW8/l6sn5+dqZHW9m28r3u8tjknFLGz9BTVbVPj6i3cgJrZa2V6FQAMm8zRivHSCaI4JGSOYw4KBLfPJYtbRGKIxGQ7V9mSGg71rrbLSYYJH5JIxzRDte+SFTcYdNgMbuZ9TQfa75H4+Sq/S8Zz6QWeDdiZjfTBeTBbzhIkmfEyo2NWmw8nNSBvryUmC/O78JbDTCaCzQRsfU9O10UvNSnIXRagULemgCtOyN+gvZpkeb4p5I3Ws9rULZ+YKWhsvTMT+1IHXOwgqNF9vxs9JUDor9aBu6tocn+xfMDUT0QyAj99aNSnxGSlJ76gIKemp8K52PZnOKYJd8PIdLoc7nZN4dDLZWxBPQdpi5RyeIIGIWZxWif2786+vP0H/jm82j+vgiS2hIMySFLN04zCcLPB/brbAjcQId+K40aAzm8y12fWgo9UO+gYHbR2OEyjwBZEBfjKjcnrsyxyQOb/Dvgeh/DwthRifpHFm83GLajUZCbm4LzG8uS1rrKXc6TNjtxqUhH5ruPRQvHKv6tNoBzxyf883t2sLvW1LUygmhPvvdrhxb+fS0piK8uLPtfL3ds0I4Wr5OCQfvMLaZ6co/WBCRodo08lMV8uafD+Fh3+ibt1+L7sUSWCsNqs1IQuYnM2FOGtMwcaMDgPbs8m/FZ75rUUh8rOLUYUjlpHVqlCxUIGnp9v6qq79Um9qXaiuLuzJnq6mLiRj0LUuHNmDEJqly4JIRwvqQv/xvRaFyoqCeFHBglgHC6+JQqPEYUk2ZnSsMOhqY33QG9TdiCorw2WFC3SmTa0M2Ul+rmqDCyKdfKKr7WF1U0NrURD3rKyoqCjUsxCviIJc5iwmGzN6GuLnQpvVAwsVFoWLmoZIcmhqUThWFCow4CjTo0GLOek+cN2y0k7r7IZ3Zjcc8MoKagh76dPX0pATpDMqHB1ZsNerKUWltEm0howm44E+mYUZ7bh8irEm2YfRKyP7fTjp9y8v+x3m9i/vrZEDA+RhxbmzkWW9mgXP3MmzujHKAY89djWbJNFkPWcCvEQPpMcptgxWzrT+YK4nC4o48uSEyc69n6ZynrD0srjBvDO5DqPty6Z43BTemdBfIsyXl7vMqqQvz/f8OrnSCc8YJCY/sLSf9Z3JaLQYDzqZdXSXSlfyc25ewtklWq83ThzcfXmmbpepVIWpjB8IGfdmKlbgRUdfzMiaiHo5xOkFi0K9sPUQ7OSJEgP+i9yfotEkuzgfF/KfYosKJmp0xJ/eb4ykNuf3qIimJvUb4sW4Z/A1l06kdh6DJi4sfnvneugRH3gXObrwpuD/jKtf2cOpbybt9XT81Xn66DqfkJklbmfBLC2dfoOjnrmudVmb/Yymi2ivgK/NTBzm+wFwTBLXu5vUngOfiaglbmvBLC0dpM+1zmIWNux1TP5BzM+whwA7mqPXo58vCD//qPthj1NyiX6iXPrUvUB3klIDihUdi6mn7yO3quDUG7u0XysF+LAINHM5fVUQAXokd6TpalfV1at6tv6TzNbv+yGGakqGWMcNO2zk/Bpj5m/LnTflj44bFuOBXocMlQ0ZxIsKGaTa//f3GySlVbb/M7Kpoh++qxWgsgogXZYC0BNBX1cB8p2GKigAPedBtqFVB+N6iWCVRUC4KBGoRw522LTyC38qIAL0yAEZNWir83pFYIU1oCJDAfjQQyhInet7hvswQiYgV/wf</diagram></mxfile> \ No newline at end of file diff --git a/misc/env.json b/misc/env.json new file mode 100644 index 0000000000000000000000000000000000000000..4184042e21739ba19a2de3b157c55a8f595ef387 --- /dev/null +++ b/misc/env.json @@ -0,0 +1,9 @@ +{ + "language_tabs": [ + { + "python": "Python" + },{ + "java": "Java" + } + ] +} diff --git a/mkdocs.yml b/mkdocs.yml index 8b880aedaeac42e1a86f9c1e61e85e5e5d4064e3..e9e846c30d9fdc99ff5db92d729131267e234d09 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,22 +2,25 @@ site_name: Database Repository repo_url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services repo_name: fda-services site_author: FAIR Data Austria -copyright: CC-BY 4.0 +copyright: CC-BY 4.0 Technische Universität Wien & Universität Wien extra: homepage: https://dbrepo.tuwien.ac.at social: - icon: fontawesome/brands/gitlab link: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services - - icon: fontawesome/brands/twitter - link: https://twitter.com/RDMTUWien - - icon: fontawesome/solid/globe - link: https://forschungsdaten.at/fda/ nav: - Home: index.md - getting-started.md - system.md - - operation.md + - Operation: + - operation/index.md + - operation/authentication.md + - operation/container.md + - operation/database.md + - operation/identifier.md + - operation/query.md - publications.md + - contact.md extra_css: - stylesheets/extra.css theme: diff --git a/package.json b/package.json new file mode 100644 index 0000000000000000000000000000000000000000..8aef71a1affe3010ef35a726efd3e1a1d3fbf049 --- /dev/null +++ b/package.json @@ -0,0 +1,12 @@ +{ + "name": "fda-docs", + "version": "1.0.0", + "main": "index.js", + "repository": "git@gitlab.phaidra.org:fair-data-austria-db-repository/fda-docs.git", + "author": "Martin Weise <martin.weise@tuwien.ac.at>", + "license": "Apache 2", + "private": true, + "dependencies": { + "widdershins": "^4.0.1" + } +} diff --git a/yarn.lock b/yarn.lock new file mode 100644 index 0000000000000000000000000000000000000000..c1974665c10d89e3b19ef53af0017fc36a91a8eb --- /dev/null +++ b/yarn.lock @@ -0,0 +1,1270 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@babel/code-frame@^7.0.0": + version "7.16.7" + resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.16.7.tgz#44416b6bd7624b998f5b1af5d470856c40138789" + integrity sha512-iAXqUn8IIeBTNd72xsFlgaXHkMBMt6y4HJp1tIaK465CWLT/fG1aqB7ykr95gHHmlBdGbFeWWfyB4NJJ0nmeIg== + dependencies: + "@babel/highlight" "^7.16.7" + +"@babel/helper-validator-identifier@^7.16.7": + version "7.16.7" + resolved "https://registry.yarnpkg.com/@babel/helper-validator-identifier/-/helper-validator-identifier-7.16.7.tgz#e8c602438c4a8195751243da9031d1607d247cad" + integrity sha512-hsEnFemeiW4D08A5gUAZxLBTXpZ39P+a+DGDsHw1yxqyQ/jzFEnxf5uTEGp+3bzAbNOxU1paTgYS4ECU/IgfDw== + +"@babel/highlight@^7.16.7": + version "7.17.9" + resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.17.9.tgz#61b2ee7f32ea0454612def4fccdae0de232b73e3" + integrity sha512-J9PfEKCbFIv2X5bjTMiZu6Vf341N05QIY+d6FvVKynkG1S7G0j3I0QoRtWIrXhZ+/Nlb5Q0MzqL7TokEJ5BNHg== + dependencies: + "@babel/helper-validator-identifier" "^7.16.7" + chalk "^2.0.0" + js-tokens "^4.0.0" + +"@babel/runtime@^7.0.0": + version "7.17.9" + resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.17.9.tgz#d19fbf802d01a8cb6cf053a64e472d42c434ba72" + integrity sha512-lSiBBvodq29uShpWGNbgFdKYNiFDo5/HIYsaCEY9ff4sb10x9jizo2+pRrSyF4jKZCXqgzuqBOQKbUm90gQwJg== + dependencies: + regenerator-runtime "^0.13.4" + +"@exodus/schemasafe@^1.0.0-rc.2": + version "1.0.0-rc.6" + resolved "https://registry.yarnpkg.com/@exodus/schemasafe/-/schemasafe-1.0.0-rc.6.tgz#7985f681564cff4ffaebb5896eb4be20af3aae7a" + integrity sha512-dDnQizD94EdBwEj/fh3zPRa/HWCS9O5au2PuHhZBbuM3xWHxuaKzPBOEWze7Nn0xW68MIpZ7Xdyn1CoCpjKCuQ== + +"@types/json-schema@^7.0.7": + version "7.0.11" + resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3" + integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ== + +ajv@^5.5.2: + version "5.5.2" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-5.5.2.tgz#73b5eeca3fab653e3d3f9422b341ad42205dc965" + integrity sha1-c7Xuyj+rZT49P5Qis0GtQiBdyWU= + dependencies: + co "^4.6.0" + fast-deep-equal "^1.0.0" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.3.0" + +ajv@^6.12.3: + version "6.12.6" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +ansi-regex@^2.0.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-2.1.1.tgz#c3b33ab5ee360d86e0e628f0468ae7ef27d654df" + integrity sha1-w7M6te42DYbg5ijwRorn7yfWVN8= + +ansi-regex@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-3.0.1.tgz#123d6479e92ad45ad897d4054e3c7ca7db4944e1" + integrity sha512-+O9Jct8wf++lXxxFc4hc8LsjaSq0HFzzL7cVsw8pRDIPdjKD2mT4ytDZlLuSBZ4cLKZFXIrMGO7DbQCtMJJMKw== + +ansi-regex@^5.0.1: + version "5.0.1" + resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304" + integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ== + +ansi-styles@^2.2.1: + version "2.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-2.2.1.tgz#b432dd3358b634cf75e1e4664368240533c1ddbe" + integrity sha1-tDLdM1i2NM914eRmQ2gkBTPB3b4= + +ansi-styles@^3.2.1: + version "3.2.1" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-3.2.1.tgz#41fbb20243e50b12be0f04b8dedbf07520ce841d" + integrity sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA== + dependencies: + color-convert "^1.9.0" + +ansi-styles@^4.0.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/ansi-styles/-/ansi-styles-4.3.0.tgz#edd803628ae71c04c85ae7a0906edad34b648937" + integrity sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg== + dependencies: + color-convert "^2.0.1" + +argparse@^1.0.7: + version "1.0.10" + resolved "https://registry.yarnpkg.com/argparse/-/argparse-1.0.10.tgz#bcd6791ea5ae09725e17e5ad988134cd40b3d911" + integrity sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg== + dependencies: + sprintf-js "~1.0.2" + +asynckit@^0.4.0: + version "0.4.0" + resolved "https://registry.yarnpkg.com/asynckit/-/asynckit-0.4.0.tgz#c79ed97f7f34cb8f2ba1bc9790bcc366474b4b79" + integrity sha1-x57Zf380y48robyXkLzDZkdLS3k= + +better-ajv-errors@^0.6.1, better-ajv-errors@^0.6.7: + version "0.6.7" + resolved "https://registry.yarnpkg.com/better-ajv-errors/-/better-ajv-errors-0.6.7.tgz#b5344af1ce10f434fe02fc4390a5a9c811e470d1" + integrity sha512-PYgt/sCzR4aGpyNy5+ViSQ77ognMnWq7745zM+/flYO4/Yisdtp9wDQW2IKCyVYPUxQt3E/b5GBSwfhd1LPdlg== + dependencies: + "@babel/code-frame" "^7.0.0" + "@babel/runtime" "^7.0.0" + chalk "^2.4.1" + core-js "^3.2.1" + json-to-ast "^2.0.3" + jsonpointer "^4.0.1" + leven "^3.1.0" + +call-me-maybe@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/call-me-maybe/-/call-me-maybe-1.0.1.tgz#26d208ea89e37b5cbde60250a15f031c16a4d66b" + integrity sha1-JtII6onje1y95gJQoV8DHBak1ms= + +camelcase@^5.0.0: + version "5.3.1" + resolved "https://registry.yarnpkg.com/camelcase/-/camelcase-5.3.1.tgz#e3c9b31569e106811df242f715725a1f4c494320" + integrity sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg== + +chalk@^1.1.1: + version "1.1.3" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98" + integrity sha1-qBFcVeSnAv5NFQq9OHKCKn4J/Jg= + dependencies: + ansi-styles "^2.2.1" + escape-string-regexp "^1.0.2" + has-ansi "^2.0.0" + strip-ansi "^3.0.0" + supports-color "^2.0.0" + +chalk@^2.0.0, chalk@^2.4.1: + version "2.4.2" + resolved "https://registry.yarnpkg.com/chalk/-/chalk-2.4.2.tgz#cd42541677a54333cf541a49108c1432b44c9424" + integrity sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ== + dependencies: + ansi-styles "^3.2.1" + escape-string-regexp "^1.0.5" + supports-color "^5.3.0" + +cliui@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-4.1.0.tgz#348422dbe82d800b3022eef4f6ac10bf2e4d1b49" + integrity sha512-4FG+RSG9DL7uEwRUZXZn3SS34DiDPfzP0VOiEwtUWlE+AR2EIg+hSyvrIgUUfhdgR/UkAeW2QHgeP+hWrXs7jQ== + dependencies: + string-width "^2.1.1" + strip-ansi "^4.0.0" + wrap-ansi "^2.0.0" + +cliui@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-6.0.0.tgz#511d702c0c4e41ca156d7d0e96021f23e13225b1" + integrity sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^6.2.0" + +cliui@^7.0.2: + version "7.0.4" + resolved "https://registry.yarnpkg.com/cliui/-/cliui-7.0.4.tgz#a0265ee655476fc807aea9df3df8df7783808b4f" + integrity sha512-OcRE68cOsVMXp1Yvonl/fzkQOyjLSu/8bhPDfQt0e0/Eb283TKP20Fs2MqoPsr9SwA595rRCA+QMzYc9nBP+JQ== + dependencies: + string-width "^4.2.0" + strip-ansi "^6.0.0" + wrap-ansi "^7.0.0" + +co@^4.6.0: + version "4.6.0" + resolved "https://registry.yarnpkg.com/co/-/co-4.6.0.tgz#6ea6bdf3d853ae54ccb8e47bfa0bf3f9031fb184" + integrity sha1-bqa989hTrlTMuOR7+gvz+QMfsYQ= + +code-error-fragment@0.0.230: + version "0.0.230" + resolved "https://registry.yarnpkg.com/code-error-fragment/-/code-error-fragment-0.0.230.tgz#d736d75c832445342eca1d1fedbf17d9618b14d7" + integrity sha512-cadkfKp6932H8UkhzE/gcUqhRMNf8jHzkAN7+5Myabswaghu4xABTgPHDCjW+dBAJxj/SpkTYokpzDqY4pCzQw== + +code-point-at@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77" + integrity sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c= + +color-convert@^1.9.0: + version "1.9.3" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-1.9.3.tgz#bb71850690e1f136567de629d2d5471deda4c1e8" + integrity sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg== + dependencies: + color-name "1.1.3" + +color-convert@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/color-convert/-/color-convert-2.0.1.tgz#72d3a68d598c9bdb3af2ad1e84f21d896abd4de3" + integrity sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ== + dependencies: + color-name "~1.1.4" + +color-name@1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.3.tgz#a7d0558bd89c42f795dd42328f740831ca53bc25" + integrity sha1-p9BVi9icQveV3UIyj3QIMcpTvCU= + +color-name@~1.1.4: + version "1.1.4" + resolved "https://registry.yarnpkg.com/color-name/-/color-name-1.1.4.tgz#c2a09a87acbde69543de6f63fa3995c826c536a2" + integrity sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA== + +combined-stream@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/combined-stream/-/combined-stream-1.0.8.tgz#c3d45a8b34fd730631a110a8a2520682b31d5a7f" + integrity sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg== + dependencies: + delayed-stream "~1.0.0" + +commander@^2.9.0: + version "2.20.3" + resolved "https://registry.yarnpkg.com/commander/-/commander-2.20.3.tgz#fd485e84c03eb4881c20722ba48035e8531aeb33" + integrity sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ== + +core-js@^3.2.1: + version "3.22.2" + resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.22.2.tgz#3ea0a245b0895fa39d1faa15fe75d91ade504a01" + integrity sha512-Z5I2vzDnEIqO2YhELVMFcL1An2CIsFe9Q7byZhs8c/QxummxZlAHw33TUHbIte987LkisOgL0LwQ1P9D6VISnA== + +cross-spawn@^6.0.0: + version "6.0.5" + resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-6.0.5.tgz#4a5ec7c64dfae22c3a14124dbacdee846d80cbc4" + integrity sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ== + dependencies: + nice-try "^1.0.4" + path-key "^2.0.1" + semver "^5.5.0" + shebang-command "^1.2.0" + which "^1.2.9" + +debug@^2.2.0: + version "2.6.9" + resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" + integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== + dependencies: + ms "2.0.0" + +decamelize@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/decamelize/-/decamelize-1.2.0.tgz#f6534d15148269b20352e7bee26f501f9a191290" + integrity sha1-9lNNFRSCabIDUue+4m9QH5oZEpA= + +delayed-stream@~1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619" + integrity sha1-3zrhmayt+31ECqrgsp4icrJOxhk= + +dot@^1.1.3: + version "1.1.3" + resolved "https://registry.yarnpkg.com/dot/-/dot-1.1.3.tgz#351360e00a748bce9a1f8f27c00c394a7e4e1e9f" + integrity sha512-/nt74Rm+PcfnirXGEdhZleTwGC2LMnuKTeeTIlI82xb5loBBoXNYzr2ezCroPSMtilK8EZIfcNZwOcHN+ib1Lg== + +duplexer@~0.1.1: + version "0.1.2" + resolved "https://registry.yarnpkg.com/duplexer/-/duplexer-0.1.2.tgz#3abe43aef3835f8ae077d136ddce0f276b0400e6" + integrity sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg== + +emoji-regex@^8.0.0: + version "8.0.0" + resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-8.0.0.tgz#e818fd69ce5ccfcb404594f842963bf53164cc37" + integrity sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A== + +end-of-stream@^1.1.0: + version "1.4.4" + resolved "https://registry.yarnpkg.com/end-of-stream/-/end-of-stream-1.4.4.tgz#5ae64a5f45057baf3626ec14da0ca5e4b2431eb0" + integrity sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q== + dependencies: + once "^1.4.0" + +entities@~2.0.0: + version "2.0.3" + resolved "https://registry.yarnpkg.com/entities/-/entities-2.0.3.tgz#5c487e5742ab93c15abb5da22759b8590ec03b7f" + integrity sha512-MyoZ0jgnLvB2X3Lg5HqpFmn1kybDiIfEQmKzTb5apr51Rb+T3KdmMiqa70T+bhGnyv7bQ6WMj2QMHpGMmlrUYQ== + +es6-promise@^3.2.1: + version "3.3.1" + resolved "https://registry.yarnpkg.com/es6-promise/-/es6-promise-3.3.1.tgz#a08cdde84ccdbf34d027a1451bc91d4bcd28a613" + integrity sha1-oIzd6EzNvzTQJ6FFG8kdS80ophM= + +escalade@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/escalade/-/escalade-3.1.1.tgz#d8cfdc7000965c5a0174b4a82eaa5c0552742e40" + integrity sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw== + +escape-string-regexp@^1.0.2, escape-string-regexp@^1.0.5: + version "1.0.5" + resolved "https://registry.yarnpkg.com/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz#1b61c0562190a8dff6ae3bb2cf0200ca130b86d4" + integrity sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ= + +event-stream@3.3.4: + version "3.3.4" + resolved "https://registry.yarnpkg.com/event-stream/-/event-stream-3.3.4.tgz#4ab4c9a0f5a54db9338b4c34d86bfce8f4b35571" + integrity sha1-SrTJoPWlTbkzi0w02Gv86PSzVXE= + dependencies: + duplexer "~0.1.1" + from "~0" + map-stream "~0.1.0" + pause-stream "0.0.11" + split "0.3" + stream-combiner "~0.0.4" + through "~2.3.1" + +execa@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/execa/-/execa-1.0.0.tgz#c6236a5bb4df6d6f15e88e7f017798216749ddd8" + integrity sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA== + dependencies: + cross-spawn "^6.0.0" + get-stream "^4.0.0" + is-stream "^1.1.0" + npm-run-path "^2.0.0" + p-finally "^1.0.0" + signal-exit "^3.0.0" + strip-eof "^1.0.0" + +fast-deep-equal@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-1.1.0.tgz#c053477817c86b51daa853c81e059b733d023614" + integrity sha1-wFNHeBfIa1HaqFPIHgWbcz0CNhQ= + +fast-deep-equal@^3.1.1: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fast-safe-stringify@^2.0.7: + version "2.1.1" + resolved "https://registry.yarnpkg.com/fast-safe-stringify/-/fast-safe-stringify-2.1.1.tgz#c406a83b6e70d9e35ce3b30a81141df30aeba884" + integrity sha512-W+KJc2dmILlPplD/H4K9l9LcAHAfPtP6BY84uVLXQ6Evcz9Lcg33Y2z1IVblT6xdY54PXYVHEv+0Wpq8Io6zkA== + +find-up@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-3.0.0.tgz#49169f1d7993430646da61ecc5ae355c21c97b73" + integrity sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg== + dependencies: + locate-path "^3.0.0" + +find-up@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/find-up/-/find-up-4.1.0.tgz#97afe7d6cdc0bc5928584b7c8d7b16e8a9aa5d19" + integrity sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw== + dependencies: + locate-path "^5.0.0" + path-exists "^4.0.0" + +foreach@^2.0.4: + version "2.0.5" + resolved "https://registry.yarnpkg.com/foreach/-/foreach-2.0.5.tgz#0bee005018aeb260d0a3af3ae658dd0136ec1b99" + integrity sha1-C+4AUBiusmDQo6865ljdATbsG5k= + +form-data@3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/form-data/-/form-data-3.0.0.tgz#31b7e39c85f1355b7139ee0c647cf0de7f83c682" + integrity sha512-CKMFDglpbMi6PyN+brwB9Q/GOw0eAnsrEZDgcsH5Krhz5Od/haKHAX0NmQfha2zPPz0JpWzA7GJHGSnvCRLWsg== + dependencies: + asynckit "^0.4.0" + combined-stream "^1.0.8" + mime-types "^2.1.12" + +from@~0: + version "0.1.7" + resolved "https://registry.yarnpkg.com/from/-/from-0.1.7.tgz#83c60afc58b9c56997007ed1a768b3ab303a44fe" + integrity sha1-g8YK/Fi5xWmXAH7Rp2izqzA6RP4= + +fs-readfile-promise@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/fs-readfile-promise/-/fs-readfile-promise-2.0.1.tgz#80023823981f9ffffe01609e8be668f69ae49e70" + integrity sha1-gAI4I5gfn//+AWCei+Zo9prknnA= + dependencies: + graceful-fs "^4.1.2" + +fs-writefile-promise@^1.0.3: + version "1.0.3" + resolved "https://registry.yarnpkg.com/fs-writefile-promise/-/fs-writefile-promise-1.0.3.tgz#e02f9b58ffc255ed822adc7a01114f445d48d063" + integrity sha1-4C+bWP/CVe2CKtx6ARFPRF1I0GM= + dependencies: + mkdirp-promise "^1.0.0" + pinkie-promise "^1.0.0" + +get-caller-file@^1.0.1: + version "1.0.3" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-1.0.3.tgz#f978fa4c90d1dfe7ff2d6beda2a515e713bdcf4a" + integrity sha512-3t6rVToeoZfYSGd8YoLFR2DJkiQrIiUrGcjvFX2mDw3bn6k2OtwHN0TNCLbBO+w8qTvimhDkv+LSscbJY1vE6w== + +get-caller-file@^2.0.1, get-caller-file@^2.0.5: + version "2.0.5" + resolved "https://registry.yarnpkg.com/get-caller-file/-/get-caller-file-2.0.5.tgz#4f94412a82db32f36e3b0b9741f8a97feb031f7e" + integrity sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg== + +get-own-enumerable-property-symbols@^3.0.0: + version "3.0.2" + resolved "https://registry.yarnpkg.com/get-own-enumerable-property-symbols/-/get-own-enumerable-property-symbols-3.0.2.tgz#b5fde77f22cbe35f390b4e089922c50bce6ef664" + integrity sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g== + +get-stream@^4.0.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-4.1.0.tgz#c1b255575f3dc21d59bfc79cd3d2b46b1c3a54b5" + integrity sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w== + dependencies: + pump "^3.0.0" + +graceful-fs@^4.1.2: + version "4.2.10" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.10.tgz#147d3a006da4ca3ce14728c7aefc287c367d7a6c" + integrity sha512-9ByhssR2fPVsNZj478qUUbKfmL0+t5BDVyjShtyZZLiK7ZDAArFFfopyOTj0M05wE2tJPisA4iTnnXl2YoPvOA== + +grapheme-splitter@^1.0.4: + version "1.0.4" + resolved "https://registry.yarnpkg.com/grapheme-splitter/-/grapheme-splitter-1.0.4.tgz#9cf3a665c6247479896834af35cf1dbb4400767e" + integrity sha512-bzh50DW9kTPM00T8y4o8vQg89Di9oLJVLW/KaOGIXJWP/iqCN6WKYkbNOF04vFLJhwcpYUh9ydh/+5vpOqV4YQ== + +har-schema@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92" + integrity sha1-qUwiJOvKwEeCoNkDVSHyRzW37JI= + +har-validator@^5.0.0: + version "5.1.5" + resolved "https://registry.yarnpkg.com/har-validator/-/har-validator-5.1.5.tgz#1f0803b9f8cb20c0fa13822df1ecddb36bde1efd" + integrity sha512-nmT2T0lljbxdQZfspsno9hgrG3Uir6Ks5afism62poxqBM6sDnMEuPmzTq8XN0OEwqKLLdh1jQI3qyE66Nzb3w== + dependencies: + ajv "^6.12.3" + har-schema "^2.0.0" + +has-ansi@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/has-ansi/-/has-ansi-2.0.0.tgz#34f5049ce1ecdf2b0649af3ef24e45ed35416d91" + integrity sha1-NPUEnOHs3ysGSa8+8k5F7TVBbZE= + dependencies: + ansi-regex "^2.0.0" + +has-flag@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-3.0.0.tgz#b5d454dc2199ae225699f3467e5a07f3b955bafd" + integrity sha1-tdRU3CGZriJWmfNGfloH87lVuv0= + +highlightjs@^9.12.0: + version "9.16.2" + resolved "https://registry.yarnpkg.com/highlightjs/-/highlightjs-9.16.2.tgz#07ea6cc7c93340fc440734fb7abf28558f1f0fe1" + integrity sha512-FK1vmMj8BbEipEy8DLIvp71t5UsC7n2D6En/UfM/91PCwmOpj6f2iu0Y0coRC62KSRHHC+dquM2xMULV/X7NFg== + +http2-client@^1.2.5: + version "1.3.5" + resolved "https://registry.yarnpkg.com/http2-client/-/http2-client-1.3.5.tgz#20c9dc909e3cc98284dd20af2432c524086df181" + integrity sha512-EC2utToWl4RKfs5zd36Mxq7nzHHBuomZboI0yYL6Y0RmBgT7Sgkq4rQ0ezFTYoIsSs7Tm9SJe+o2FcAg6GBhGA== + +httpsnippet@^1.19.0: + version "1.25.0" + resolved "https://registry.yarnpkg.com/httpsnippet/-/httpsnippet-1.25.0.tgz#c7efaef9e3b980c6ba03652a45efcb0b8480a1d0" + integrity sha512-jobE6S923cLuf5BPG6Jf+oLBRkPzv2RPp0dwOHcWwj/t9FwV/t9hyZ46kpT3Q5DHn9iFNmGhrcmmFUBqyjoTQg== + dependencies: + chalk "^1.1.1" + commander "^2.9.0" + debug "^2.2.0" + event-stream "3.3.4" + form-data "3.0.0" + fs-readfile-promise "^2.0.1" + fs-writefile-promise "^1.0.3" + har-validator "^5.0.0" + pinkie-promise "^2.0.0" + stringify-object "^3.3.0" + +invert-kv@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/invert-kv/-/invert-kv-2.0.0.tgz#7393f5afa59ec9ff5f67a27620d11c226e3eec02" + integrity sha512-wPVv/y/QQ/Uiirj/vh3oP+1Ww+AWehmi1g5fFWGPF6IpCBCDVrhgHRMvrLfdYcwDh3QJbGXDW4JAuzxElLSqKA== + +is-fullwidth-code-point@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-1.0.0.tgz#ef9e31386f031a7f0d643af82fde50c457ef00cb" + integrity sha1-754xOG8DGn8NZDr4L95QxFfvAMs= + dependencies: + number-is-nan "^1.0.0" + +is-fullwidth-code-point@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz#a3b30a5c4f199183167aaab93beefae3ddfb654f" + integrity sha1-o7MKXE8ZkYMWeqq5O+764937ZU8= + +is-fullwidth-code-point@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz#f116f8064fe90b3f7844a38997c0b75051269f1d" + integrity sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg== + +is-obj@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/is-obj/-/is-obj-1.0.1.tgz#3e4729ac1f5fde025cd7d83a896dab9f4f67db0f" + integrity sha1-PkcprB9f3gJc19g6iW2rn09n2w8= + +is-regexp@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/is-regexp/-/is-regexp-1.0.0.tgz#fd2d883545c46bac5a633e7b9a09e87fa2cb5069" + integrity sha1-/S2INUXEa6xaYz57mgnof6LLUGk= + +is-stream@^1.1.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/is-stream/-/is-stream-1.1.0.tgz#12d4a3dd4e68e0b79ceb8dbc84173ae80d91ca44" + integrity sha1-EtSj3U5o4Lec6428hBc66A2RykQ= + +isexe@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/isexe/-/isexe-2.0.0.tgz#e8fbf374dc556ff8947a10dcb0572d633f2cfa10" + integrity sha1-6PvzdNxVb/iUehDcsFctYz8s+hA= + +jgexml@latest: + version "0.4.4" + resolved "https://registry.yarnpkg.com/jgexml/-/jgexml-0.4.4.tgz#428c6afc753c8cd9c29d6860262d1f4a44febef8" + integrity sha512-j0AzSWT7LXy3s3i1cdv5NZxUtscocwiBxgOLiEBfitCehm8STdXVrcOlbAWsJFLCq1elZYpQlGqA9k8Z+n9iJA== + +js-tokens@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-4.0.0.tgz#19203fb59991df98e3a287050d4647cdeaf32499" + integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ== + +json-pointer@0.6.2: + version "0.6.2" + resolved "https://registry.yarnpkg.com/json-pointer/-/json-pointer-0.6.2.tgz#f97bd7550be5e9ea901f8c9264c9d436a22a93cd" + integrity sha512-vLWcKbOaXlO+jvRy4qNd+TI1QUPZzfJj1tpJ3vAXDych5XJf93ftpUKe5pKCrzyIIwgBJcOcCVRUfqQP25afBw== + dependencies: + foreach "^2.0.4" + +json-schema-traverse@^0.3.0: + version "0.3.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.3.1.tgz#349a6d44c53a51de89b40805c5d5e59b417d3340" + integrity sha1-NJptRMU6Ud6JtAgFxdXlm0F9M0A= + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +json-to-ast@^2.0.3: + version "2.1.0" + resolved "https://registry.yarnpkg.com/json-to-ast/-/json-to-ast-2.1.0.tgz#041a9fcd03c0845036acb670d29f425cea4faaf9" + integrity sha512-W9Lq347r8tA1DfMvAGn9QNcgYm4Wm7Yc+k8e6vezpMnRT+NHbtlxgNBXRVjXe9YM6eTn6+p/MKOlV/aABJcSnQ== + dependencies: + code-error-fragment "0.0.230" + grapheme-splitter "^1.0.4" + +jsonpointer@^4.0.1: + version "4.1.0" + resolved "https://registry.yarnpkg.com/jsonpointer/-/jsonpointer-4.1.0.tgz#501fb89986a2389765ba09e6053299ceb4f2c2cc" + integrity sha512-CXcRvMyTlnR53xMcKnuMzfCA5i/nfblTnnr74CZb6C4vG39eu6w51t7nKmU5MfLfbTgGItliNyjO/ciNPDqClg== + +lcid@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/lcid/-/lcid-2.0.0.tgz#6ef5d2df60e52f82eb228a4c373e8d1f397253cf" + integrity sha512-avPEb8P8EGnwXKClwsNUgryVjllcRqtMYa49NTsbQagYuT1DcXnl1915oxWjoyGrXR6zH/Y0Zc96xWsPcoDKeA== + dependencies: + invert-kv "^2.0.0" + +leven@^3.1.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/leven/-/leven-3.1.0.tgz#77891de834064cccba82ae7842bb6b14a13ed7f2" + integrity sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A== + +linkify-it@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-2.2.0.tgz#e3b54697e78bf915c70a38acd78fd09e0058b1cf" + integrity sha512-GnAl/knGn+i1U/wjBz3akz2stz+HrHLsxMwHQGofCDfPvlf+gDKN58UtfmUquTY4/MXeE2x7k19KQmeoZi94Iw== + dependencies: + uc.micro "^1.0.1" + +locate-path@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-3.0.0.tgz#dbec3b3ab759758071b58fe59fc41871af21400e" + integrity sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A== + dependencies: + p-locate "^3.0.0" + path-exists "^3.0.0" + +locate-path@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/locate-path/-/locate-path-5.0.0.tgz#1afba396afd676a6d42504d0a67a3a7eb9f62aa0" + integrity sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g== + dependencies: + p-locate "^4.1.0" + +map-age-cleaner@^0.1.1: + version "0.1.3" + resolved "https://registry.yarnpkg.com/map-age-cleaner/-/map-age-cleaner-0.1.3.tgz#7d583a7306434c055fe474b0f45078e6e1b4b92a" + integrity sha512-bJzx6nMoP6PDLPBFmg7+xRKeFZvFboMrGlxmNj9ClvX53KrmvM5bXFXEWjbz4cz1AFn+jWJ9z/DJSz7hrs0w3w== + dependencies: + p-defer "^1.0.0" + +map-stream@~0.1.0: + version "0.1.0" + resolved "https://registry.yarnpkg.com/map-stream/-/map-stream-0.1.0.tgz#e56aa94c4c8055a16404a0674b78f215f7c8e194" + integrity sha1-5WqpTEyAVaFkBKBnS3jyFffI4ZQ= + +markdown-it-emoji@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/markdown-it-emoji/-/markdown-it-emoji-1.4.0.tgz#9bee0e9a990a963ba96df6980c4fddb05dfb4dcc" + integrity sha1-m+4OmpkKljupbfaYDE/dsF37Tcw= + +markdown-it@^10.0.0: + version "10.0.0" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-10.0.0.tgz#abfc64f141b1722d663402044e43927f1f50a8dc" + integrity sha512-YWOP1j7UbDNz+TumYP1kpwnP0aEa711cJjrAQrzd0UXlbJfc5aAq0F/PZHjiioqDC1NKgvIMX+o+9Bk7yuM2dg== + dependencies: + argparse "^1.0.7" + entities "~2.0.0" + linkify-it "^2.0.0" + mdurl "^1.0.1" + uc.micro "^1.0.5" + +mdurl@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-1.0.1.tgz#fe85b2ec75a59037f2adfec100fd6c601761152e" + integrity sha1-/oWy7HWlkDfyrf7BAP1sYBdhFS4= + +mem@^4.0.0: + version "4.3.0" + resolved "https://registry.yarnpkg.com/mem/-/mem-4.3.0.tgz#461af497bc4ae09608cdb2e60eefb69bff744178" + integrity sha512-qX2bG48pTqYRVmDB37rn/6PT7LcR8T7oAX3bf99u1Tt1nzxYfxkgqDwUwolPlXweM0XzBOBFzSx4kfp7KP1s/w== + dependencies: + map-age-cleaner "^0.1.1" + mimic-fn "^2.0.0" + p-is-promise "^2.0.0" + +mime-db@1.52.0: + version "1.52.0" + resolved "https://registry.yarnpkg.com/mime-db/-/mime-db-1.52.0.tgz#bbabcdc02859f4987301c856e3387ce5ec43bf70" + integrity sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg== + +mime-types@^2.1.12: + version "2.1.35" + resolved "https://registry.yarnpkg.com/mime-types/-/mime-types-2.1.35.tgz#381a871b62a734450660ae3deee44813f70d959a" + integrity sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw== + dependencies: + mime-db "1.52.0" + +mimic-fn@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b" + integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg== + +mkdirp-promise@^1.0.0: + version "1.1.0" + resolved "https://registry.yarnpkg.com/mkdirp-promise/-/mkdirp-promise-1.1.0.tgz#2c84893ed676e0d98fb18fb9a6212fd1b2b9a819" + integrity sha1-LISJPtZ24NmPsY+5piEv0bK5qBk= + +ms@2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8" + integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g= + +nice-try@^1.0.4: + version "1.0.5" + resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366" + integrity sha512-1nh45deeb5olNY7eX82BkPO7SSxR5SSYJiPTrTdFUVYwAl8CKMA5N9PjTYkHiRjisVcxcQ1HXdLhx2qxxJzLNQ== + +node-fetch-h2@^2.3.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/node-fetch-h2/-/node-fetch-h2-2.3.0.tgz#c6188325f9bd3d834020bf0f2d6dc17ced2241ac" + integrity sha512-ofRW94Ab0T4AOh5Fk8t0h8OBWrmjb0SSB20xh1H8YnPV9EJ+f5AMoYSUQ2zgJ4Iq2HAK0I2l5/Nequ8YzFS3Hg== + dependencies: + http2-client "^1.2.5" + +node-fetch@^2.0.0: + version "2.6.7" + resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.7.tgz#24de9fba827e3b4ae44dc8b20256a379160052ad" + integrity sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ== + dependencies: + whatwg-url "^5.0.0" + +node-readfiles@^0.2.0: + version "0.2.0" + resolved "https://registry.yarnpkg.com/node-readfiles/-/node-readfiles-0.2.0.tgz#dbbd4af12134e2e635c245ef93ffcf6f60673a5d" + integrity sha1-271K8SE04uY1wkXvk//Pb2BnOl0= + dependencies: + es6-promise "^3.2.1" + +npm-run-path@^2.0.0: + version "2.0.2" + resolved "https://registry.yarnpkg.com/npm-run-path/-/npm-run-path-2.0.2.tgz#35a9232dfa35d7067b4cb2ddf2357b1871536c5f" + integrity sha1-NakjLfo11wZ7TLLd8jV7GHFTbF8= + dependencies: + path-key "^2.0.0" + +number-is-nan@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/number-is-nan/-/number-is-nan-1.0.1.tgz#097b602b53422a522c1afb8790318336941a011d" + integrity sha1-CXtgK1NCKlIsGvuHkDGDNpQaAR0= + +oas-kit-common@^1.0.8: + version "1.0.8" + resolved "https://registry.yarnpkg.com/oas-kit-common/-/oas-kit-common-1.0.8.tgz#6d8cacf6e9097967a4c7ea8bcbcbd77018e1f535" + integrity sha512-pJTS2+T0oGIwgjGpw7sIRU8RQMcUoKCDWFLdBqKB2BNmGpbBMH2sdqAaOXUg8OzonZHU0L7vfJu1mJFEiYDWOQ== + dependencies: + fast-safe-stringify "^2.0.7" + +oas-linter@^3.1.3: + version "3.2.2" + resolved "https://registry.yarnpkg.com/oas-linter/-/oas-linter-3.2.2.tgz#ab6a33736313490659035ca6802dc4b35d48aa1e" + integrity sha512-KEGjPDVoU5K6swgo9hJVA/qYGlwfbFx+Kg2QB/kd7rzV5N8N5Mg6PlsoCMohVnQmo+pzJap/F610qTodKzecGQ== + dependencies: + "@exodus/schemasafe" "^1.0.0-rc.2" + should "^13.2.1" + yaml "^1.10.0" + +oas-resolver@^2.3.1, oas-resolver@^2.4.3: + version "2.5.6" + resolved "https://registry.yarnpkg.com/oas-resolver/-/oas-resolver-2.5.6.tgz#10430569cb7daca56115c915e611ebc5515c561b" + integrity sha512-Yx5PWQNZomfEhPPOphFbZKi9W93CocQj18NlD2Pa4GWZzdZpSJvYwoiuurRI7m3SpcChrnO08hkuQDL3FGsVFQ== + dependencies: + node-fetch-h2 "^2.3.0" + oas-kit-common "^1.0.8" + reftools "^1.1.9" + yaml "^1.10.0" + yargs "^17.0.1" + +oas-schema-walker@^1.1.3, oas-schema-walker@^1.1.5: + version "1.1.5" + resolved "https://registry.yarnpkg.com/oas-schema-walker/-/oas-schema-walker-1.1.5.tgz#74c3cd47b70ff8e0b19adada14455b5d3ac38a22" + integrity sha512-2yucenq1a9YPmeNExoUa9Qwrt9RFkjqaMAA1X+U7sbb0AqBeTIdMHky9SQQ6iN94bO5NW0W4TRYXerG+BdAvAQ== + +oas-validator@^4.0.8: + version "4.0.8" + resolved "https://registry.yarnpkg.com/oas-validator/-/oas-validator-4.0.8.tgz#4f1a4d6bd9e030ad07db03fd7a7bc3a91aabcc7d" + integrity sha512-bIt8erTyclF7bkaySTtQ9sppqyVc+mAlPi7vPzCLVHJsL9nrivQjc/jHLX/o+eGbxHd6a6YBwuY/Vxa6wGsiuw== + dependencies: + ajv "^5.5.2" + better-ajv-errors "^0.6.7" + call-me-maybe "^1.0.1" + oas-kit-common "^1.0.8" + oas-linter "^3.1.3" + oas-resolver "^2.4.3" + oas-schema-walker "^1.1.5" + reftools "^1.1.5" + should "^13.2.1" + yaml "^1.8.3" + +once@^1.3.1, once@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/once/-/once-1.4.0.tgz#583b1aa775961d4b113ac17d9c50baef9dd76bd1" + integrity sha1-WDsap3WWHUsROsF9nFC6753Xa9E= + dependencies: + wrappy "1" + +openapi-sampler@^1.0.0-beta.15: + version "1.2.1" + resolved "https://registry.yarnpkg.com/openapi-sampler/-/openapi-sampler-1.2.1.tgz#2ca9eea527f8f2ddb32c3ae1dda31afd8bf0833f" + integrity sha512-mHrYmyvcLD0qrfqPkPRBAL2z16hGT2rW0d0B7nklfoTcc3pmkJLkSZlKSeFgerUM41E5c7jlxf0Y19xrM7mWQQ== + dependencies: + "@types/json-schema" "^7.0.7" + json-pointer "0.6.2" + +os-locale@^3.0.0: + version "3.1.0" + resolved "https://registry.yarnpkg.com/os-locale/-/os-locale-3.1.0.tgz#a802a6ee17f24c10483ab9935719cef4ed16bf1a" + integrity sha512-Z8l3R4wYWM40/52Z+S265okfFj8Kt2cC2MKY+xNi3kFs+XGI7WXu/I309QQQYbRW4ijiZ+yxs9pqEhJh0DqW3Q== + dependencies: + execa "^1.0.0" + lcid "^2.0.0" + mem "^4.0.0" + +p-defer@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/p-defer/-/p-defer-1.0.0.tgz#9f6eb182f6c9aa8cd743004a7d4f96b196b0fb0c" + integrity sha1-n26xgvbJqozXQwBKfU+WsZaw+ww= + +p-finally@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/p-finally/-/p-finally-1.0.0.tgz#3fbcfb15b899a44123b34b6dcc18b724336a2cae" + integrity sha1-P7z7FbiZpEEjs0ttzBi3JDNqLK4= + +p-is-promise@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/p-is-promise/-/p-is-promise-2.1.0.tgz#918cebaea248a62cf7ffab8e3bca8c5f882fc42e" + integrity sha512-Y3W0wlRPK8ZMRbNq97l4M5otioeA5lm1z7bkNkxCka8HSPjR0xRWmpCmc9utiaLP9Jb1eD8BgeIxTW4AIF45Pg== + +p-limit@^2.0.0, p-limit@^2.2.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1" + integrity sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w== + dependencies: + p-try "^2.0.0" + +p-locate@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-3.0.0.tgz#322d69a05c0264b25997d9f40cd8a891ab0064a4" + integrity sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ== + dependencies: + p-limit "^2.0.0" + +p-locate@^4.1.0: + version "4.1.0" + resolved "https://registry.yarnpkg.com/p-locate/-/p-locate-4.1.0.tgz#a3428bb7088b3a60292f66919278b7c297ad4f07" + integrity sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A== + dependencies: + p-limit "^2.2.0" + +p-try@^2.0.0: + version "2.2.0" + resolved "https://registry.yarnpkg.com/p-try/-/p-try-2.2.0.tgz#cb2868540e313d61de58fafbe35ce9004d5540e6" + integrity sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ== + +path-exists@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-3.0.0.tgz#ce0ebeaa5f78cb18925ea7d810d7b59b010fd515" + integrity sha1-zg6+ql94yxiSXqfYENe1mwEP1RU= + +path-exists@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/path-exists/-/path-exists-4.0.0.tgz#513bdbe2d3b95d7762e8c1137efa195c6c61b5b3" + integrity sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w== + +path-key@^2.0.0, path-key@^2.0.1: + version "2.0.1" + resolved "https://registry.yarnpkg.com/path-key/-/path-key-2.0.1.tgz#411cadb574c5a140d3a4b1910d40d80cc9f40b40" + integrity sha1-QRyttXTFoUDTpLGRDUDYDMn0C0A= + +pause-stream@0.0.11: + version "0.0.11" + resolved "https://registry.yarnpkg.com/pause-stream/-/pause-stream-0.0.11.tgz#fe5a34b0cbce12b5aa6a2b403ee2e73b602f1445" + integrity sha1-/lo0sMvOErWqaitAPuLnO2AvFEU= + dependencies: + through "~2.3" + +pinkie-promise@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/pinkie-promise/-/pinkie-promise-1.0.0.tgz#d1da67f5482563bb7cf57f286ae2822ecfbf3670" + integrity sha1-0dpn9UglY7t89X8oauKCLs+/NnA= + dependencies: + pinkie "^1.0.0" + +pinkie-promise@^2.0.0: + version "2.0.1" + resolved "https://registry.yarnpkg.com/pinkie-promise/-/pinkie-promise-2.0.1.tgz#2135d6dfa7a358c069ac9b178776288228450ffa" + integrity sha1-ITXW36ejWMBprJsXh3YogihFD/o= + dependencies: + pinkie "^2.0.0" + +pinkie@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-1.0.0.tgz#5a47f28ba1015d0201bda7bf0f358e47bec8c7e4" + integrity sha1-Wkfyi6EBXQIBvae/DzWOR77Ix+Q= + +pinkie@^2.0.0: + version "2.0.4" + resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870" + integrity sha1-clVrgM+g1IqXToDnckjoDtT3+HA= + +pump@^3.0.0: + version "3.0.0" + resolved "https://registry.yarnpkg.com/pump/-/pump-3.0.0.tgz#b4a2116815bde2f4e1ea602354e8c75565107a64" + integrity sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww== + dependencies: + end-of-stream "^1.1.0" + once "^1.3.1" + +punycode@^2.1.0: + version "2.1.1" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec" + integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A== + +reftools@^1.1.0, reftools@^1.1.5, reftools@^1.1.9: + version "1.1.9" + resolved "https://registry.yarnpkg.com/reftools/-/reftools-1.1.9.tgz#e16e19f662ccd4648605312c06d34e5da3a2b77e" + integrity sha512-OVede/NQE13xBQ+ob5CKd5KyeJYU2YInb1bmV4nRoOfquZPkAkxuOXicSe1PvqIuZZ4kD13sPKBbR7UFDmli6w== + +regenerator-runtime@^0.13.4: + version "0.13.9" + resolved "https://registry.yarnpkg.com/regenerator-runtime/-/regenerator-runtime-0.13.9.tgz#8925742a98ffd90814988d7566ad30ca3b263b52" + integrity sha512-p3VT+cOEgxFsRRA9X4lkI1E+k2/CtnKtU4gcxyaCUreilL/vqI6CdZ3wxVUx3UOUg+gnUOQQcRI7BmSI656MYA== + +require-directory@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/require-directory/-/require-directory-2.1.1.tgz#8c64ad5fd30dab1c976e2344ffe7f792a6a6df42" + integrity sha1-jGStX9MNqxyXbiNE/+f3kqam30I= + +require-main-filename@^1.0.1: + version "1.0.1" + resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-1.0.1.tgz#97f717b69d48784f5f526a6c5aa8ffdda055a4d1" + integrity sha1-l/cXtp1IeE9fUmpsWqj/3aBVpNE= + +require-main-filename@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/require-main-filename/-/require-main-filename-2.0.0.tgz#d0b329ecc7cc0f61649f62215be69af54aa8989b" + integrity sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg== + +semver@^5.5.0: + version "5.7.1" + resolved "https://registry.yarnpkg.com/semver/-/semver-5.7.1.tgz#a954f931aeba508d307bbf069eff0c01c96116f7" + integrity sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ== + +set-blocking@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/set-blocking/-/set-blocking-2.0.0.tgz#045f9782d011ae9a6803ddd382b24392b3d890f7" + integrity sha1-BF+XgtARrppoA93TgrJDkrPYkPc= + +shebang-command@^1.2.0: + version "1.2.0" + resolved "https://registry.yarnpkg.com/shebang-command/-/shebang-command-1.2.0.tgz#44aac65b695b03398968c39f363fee5deafdf1ea" + integrity sha1-RKrGW2lbAzmJaMOfNj/uXer98eo= + dependencies: + shebang-regex "^1.0.0" + +shebang-regex@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-1.0.0.tgz#da42f49740c0b42db2ca9728571cb190c98efea3" + integrity sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM= + +should-equal@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/should-equal/-/should-equal-2.0.0.tgz#6072cf83047360867e68e98b09d71143d04ee0c3" + integrity sha512-ZP36TMrK9euEuWQYBig9W55WPC7uo37qzAEmbjHz4gfyuXrEUgF8cUvQVO+w+d3OMfPvSRQJ22lSm8MQJ43LTA== + dependencies: + should-type "^1.4.0" + +should-format@^3.0.3: + version "3.0.3" + resolved "https://registry.yarnpkg.com/should-format/-/should-format-3.0.3.tgz#9bfc8f74fa39205c53d38c34d717303e277124f1" + integrity sha1-m/yPdPo5IFxT04w01xcwPidxJPE= + dependencies: + should-type "^1.3.0" + should-type-adaptors "^1.0.1" + +should-type-adaptors@^1.0.1: + version "1.1.0" + resolved "https://registry.yarnpkg.com/should-type-adaptors/-/should-type-adaptors-1.1.0.tgz#401e7f33b5533033944d5cd8bf2b65027792e27a" + integrity sha512-JA4hdoLnN+kebEp2Vs8eBe9g7uy0zbRo+RMcU0EsNy+R+k049Ki+N5tT5Jagst2g7EAja+euFuoXFCa8vIklfA== + dependencies: + should-type "^1.3.0" + should-util "^1.0.0" + +should-type@^1.3.0, should-type@^1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/should-type/-/should-type-1.4.0.tgz#0756d8ce846dfd09843a6947719dfa0d4cff5cf3" + integrity sha1-B1bYzoRt/QmEOmlHcZ36DUz/XPM= + +should-util@^1.0.0: + version "1.0.1" + resolved "https://registry.yarnpkg.com/should-util/-/should-util-1.0.1.tgz#fb0d71338f532a3a149213639e2d32cbea8bcb28" + integrity sha512-oXF8tfxx5cDk8r2kYqlkUJzZpDBqVY/II2WhvU0n9Y3XYvAYRmeaf1PvvIvTgPnv4KJ+ES5M0PyDq5Jp+Ygy2g== + +should@^13.2.1: + version "13.2.3" + resolved "https://registry.yarnpkg.com/should/-/should-13.2.3.tgz#96d8e5acf3e97b49d89b51feaa5ae8d07ef58f10" + integrity sha512-ggLesLtu2xp+ZxI+ysJTmNjh2U0TsC+rQ/pfED9bUZZ4DKefP27D+7YJVVTvKsmjLpIi9jAa7itwDGkDDmt1GQ== + dependencies: + should-equal "^2.0.0" + should-format "^3.0.3" + should-type "^1.4.0" + should-type-adaptors "^1.0.1" + should-util "^1.0.0" + +signal-exit@^3.0.0: + version "3.0.7" + resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9" + integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ== + +split@0.3: + version "0.3.3" + resolved "https://registry.yarnpkg.com/split/-/split-0.3.3.tgz#cd0eea5e63a211dfff7eb0f091c4133e2d0dd28f" + integrity sha1-zQ7qXmOiEd//frDwkcQTPi0N0o8= + dependencies: + through "2" + +sprintf-js@~1.0.2: + version "1.0.3" + resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c" + integrity sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw= + +stream-combiner@~0.0.4: + version "0.0.4" + resolved "https://registry.yarnpkg.com/stream-combiner/-/stream-combiner-0.0.4.tgz#4d5e433c185261dde623ca3f44c586bcf5c4ad14" + integrity sha1-TV5DPBhSYd3mI8o/RMWGvPXErRQ= + dependencies: + duplexer "~0.1.1" + +string-width@^1.0.1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-1.0.2.tgz#118bdf5b8cdc51a2a7e70d211e07e2b0b9b107d3" + integrity sha1-EYvfW4zcUaKn5w0hHgfisLmxB9M= + dependencies: + code-point-at "^1.0.0" + is-fullwidth-code-point "^1.0.0" + strip-ansi "^3.0.0" + +string-width@^2.0.0, string-width@^2.1.1: + version "2.1.1" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-2.1.1.tgz#ab93f27a8dc13d28cac815c462143a6d9012ae9e" + integrity sha512-nOqH59deCq9SRHlxq1Aw85Jnt4w6KvLKqWVik6oA9ZklXLNIOlqg4F2yrT1MVaTjAqvVwdfeZ7w7aCvJD7ugkw== + dependencies: + is-fullwidth-code-point "^2.0.0" + strip-ansi "^4.0.0" + +string-width@^4.1.0, string-width@^4.2.0, string-width@^4.2.3: + version "4.2.3" + resolved "https://registry.yarnpkg.com/string-width/-/string-width-4.2.3.tgz#269c7117d27b05ad2e536830a8ec895ef9c6d010" + integrity sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g== + dependencies: + emoji-regex "^8.0.0" + is-fullwidth-code-point "^3.0.0" + strip-ansi "^6.0.1" + +stringify-object@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/stringify-object/-/stringify-object-3.3.0.tgz#703065aefca19300d3ce88af4f5b3956d7556629" + integrity sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw== + dependencies: + get-own-enumerable-property-symbols "^3.0.0" + is-obj "^1.0.1" + is-regexp "^1.0.0" + +strip-ansi@^3.0.0, strip-ansi@^3.0.1: + version "3.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-3.0.1.tgz#6a385fb8853d952d5ff05d0e8aaf94278dc63dcf" + integrity sha1-ajhfuIU9lS1f8F0Oiq+UJ43GPc8= + dependencies: + ansi-regex "^2.0.0" + +strip-ansi@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-4.0.0.tgz#a8479022eb1ac368a871389b635262c505ee368f" + integrity sha1-qEeQIusaw2iocTibY1JixQXuNo8= + dependencies: + ansi-regex "^3.0.0" + +strip-ansi@^6.0.0, strip-ansi@^6.0.1: + version "6.0.1" + resolved "https://registry.yarnpkg.com/strip-ansi/-/strip-ansi-6.0.1.tgz#9e26c63d30f53443e9489495b2105d37b67a85d9" + integrity sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A== + dependencies: + ansi-regex "^5.0.1" + +strip-eof@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/strip-eof/-/strip-eof-1.0.0.tgz#bb43ff5598a6eb05d89b59fcd129c983313606bf" + integrity sha1-u0P/VZim6wXYm1n80SnJgzE2Br8= + +supports-color@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-2.0.0.tgz#535d045ce6b6363fa40117084629995e9df324c7" + integrity sha1-U10EXOa2Nj+kARcIRimZXp3zJMc= + +supports-color@^5.3.0: + version "5.5.0" + resolved "https://registry.yarnpkg.com/supports-color/-/supports-color-5.5.0.tgz#e2e69a44ac8772f78a1ec0b35b689df6530efc8f" + integrity sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow== + dependencies: + has-flag "^3.0.0" + +swagger2openapi@^6.0.1: + version "6.2.3" + resolved "https://registry.yarnpkg.com/swagger2openapi/-/swagger2openapi-6.2.3.tgz#4a8059f89d851aee4c9ab178f9b7190debd904e2" + integrity sha512-cUUktzLpK69UwpMbcTzjMw2ns9RZChfxh56AHv6+hTx3StPOX2foZjPgds3HlJcINbxosYYBn/D3cG8nwcCWwQ== + dependencies: + better-ajv-errors "^0.6.1" + call-me-maybe "^1.0.1" + node-fetch-h2 "^2.3.0" + node-readfiles "^0.2.0" + oas-kit-common "^1.0.8" + oas-resolver "^2.4.3" + oas-schema-walker "^1.1.5" + oas-validator "^4.0.8" + reftools "^1.1.5" + yaml "^1.8.3" + yargs "^15.3.1" + +through@2, through@~2.3, through@~2.3.1: + version "2.3.8" + resolved "https://registry.yarnpkg.com/through/-/through-2.3.8.tgz#0dd4c9ffaabc357960b1b724115d7e0e86a2e1f5" + integrity sha1-DdTJ/6q8NXlgsbckEV1+Doai4fU= + +tr46@~0.0.3: + version "0.0.3" + resolved "https://registry.yarnpkg.com/tr46/-/tr46-0.0.3.tgz#8184fd347dac9cdc185992f3a6622e14b9d9ab6a" + integrity sha1-gYT9NH2snNwYWZLzpmIuFLnZq2o= + +uc.micro@^1.0.1, uc.micro@^1.0.5: + version "1.0.6" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-1.0.6.tgz#9c411a802a409a91fc6cf74081baba34b24499ac" + integrity sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA== + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +urijs@^1.19.0: + version "1.19.11" + resolved "https://registry.yarnpkg.com/urijs/-/urijs-1.19.11.tgz#204b0d6b605ae80bea54bea39280cdb7c9f923cc" + integrity sha512-HXgFDgDommxn5/bIv0cnQZsPhHDA90NPHD6+c/v21U5+Sx5hoP8+dP9IZXBU1gIfvdRfhG8cel9QNPeionfcCQ== + +webidl-conversions@^3.0.0: + version "3.0.1" + resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-3.0.1.tgz#24534275e2a7bc6be7bc86611cc16ae0a5654871" + integrity sha1-JFNCdeKnvGvnvIZhHMFq4KVlSHE= + +whatwg-url@^5.0.0: + version "5.0.0" + resolved "https://registry.yarnpkg.com/whatwg-url/-/whatwg-url-5.0.0.tgz#966454e8765462e37644d3626f6742ce8b70965d" + integrity sha1-lmRU6HZUYuN2RNNib2dCzotwll0= + dependencies: + tr46 "~0.0.3" + webidl-conversions "^3.0.0" + +which-module@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/which-module/-/which-module-2.0.0.tgz#d9ef07dce77b9902b8a3a8fa4b31c3e3f7e6e87a" + integrity sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho= + +which@^1.2.9: + version "1.3.1" + resolved "https://registry.yarnpkg.com/which/-/which-1.3.1.tgz#a45043d54f5805316da8d62f9f50918d3da70b0a" + integrity sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ== + dependencies: + isexe "^2.0.0" + +widdershins@^4.0.1: + version "4.0.1" + resolved "https://registry.yarnpkg.com/widdershins/-/widdershins-4.0.1.tgz#5ec5dd24ac9e2f6f5c002b67a08656b1de630c41" + integrity sha512-y7TGynno+J/EqRPtUrpEuEjJUc1N2ajfP7R4sHU7Qg8I/VFHGavBxL7ZTeOAVmd1fhmY2wJIbpX2LMDWf37vVA== + dependencies: + dot "^1.1.3" + fast-safe-stringify "^2.0.7" + highlightjs "^9.12.0" + httpsnippet "^1.19.0" + jgexml latest + markdown-it "^10.0.0" + markdown-it-emoji "^1.4.0" + node-fetch "^2.0.0" + oas-resolver "^2.3.1" + oas-schema-walker "^1.1.3" + openapi-sampler "^1.0.0-beta.15" + reftools "^1.1.0" + swagger2openapi "^6.0.1" + urijs "^1.19.0" + yaml "^1.8.3" + yargs "^12.0.5" + +wrap-ansi@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-2.1.0.tgz#d8fc3d284dd05794fe84973caecdd1cf824fdd85" + integrity sha1-2Pw9KE3QV5T+hJc8rs3Rz4JP3YU= + dependencies: + string-width "^1.0.1" + strip-ansi "^3.0.1" + +wrap-ansi@^6.2.0: + version "6.2.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53" + integrity sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrap-ansi@^7.0.0: + version "7.0.0" + resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-7.0.0.tgz#67e145cff510a6a6984bdf1152911d69d2eb9e43" + integrity sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q== + dependencies: + ansi-styles "^4.0.0" + string-width "^4.1.0" + strip-ansi "^6.0.0" + +wrappy@1: + version "1.0.2" + resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f" + integrity sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8= + +"y18n@^3.2.1 || ^4.0.0", y18n@^4.0.0: + version "4.0.3" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-4.0.3.tgz#b5f259c82cd6e336921efd7bfd8bf560de9eeedf" + integrity sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ== + +y18n@^5.0.5: + version "5.0.8" + resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" + integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== + +yaml@^1.10.0, yaml@^1.8.3: + version "1.10.2" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-1.10.2.tgz#2301c5ffbf12b467de8da2333a459e29e7920e4b" + integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== + +yargs-parser@^11.1.1: + version "11.1.1" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-11.1.1.tgz#879a0865973bca9f6bab5cbdf3b1c67ec7d3bcf4" + integrity sha512-C6kB/WJDiaxONLJQnF8ccx9SEeoTTLek8RVbaOIsrAUS8VrBEXfmeSnCZxygc+XC2sNMBIwOOnfcxiynjHsVSQ== + dependencies: + camelcase "^5.0.0" + decamelize "^1.2.0" + +yargs-parser@^18.1.2: + version "18.1.3" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-18.1.3.tgz#be68c4975c6b2abf469236b0c870362fab09a7b0" + integrity sha512-o50j0JeToy/4K6OZcaQmW6lyXXKhq7csREXcDwk2omFPJEwUNOVtJKvmDr9EI1fAJZUyZcRF7kxGBWmRXudrCQ== + dependencies: + camelcase "^5.0.0" + decamelize "^1.2.0" + +yargs-parser@^21.0.0: + version "21.0.1" + resolved "https://registry.yarnpkg.com/yargs-parser/-/yargs-parser-21.0.1.tgz#0267f286c877a4f0f728fceb6f8a3e4cb95c6e35" + integrity sha512-9BK1jFpLzJROCI5TzwZL/TU4gqjK5xiHV/RfWLOahrjAko/e4DJkRDZQXfvqAsiZzzYhgAzbgz6lg48jcm4GLg== + +yargs@^12.0.5: + version "12.0.5" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-12.0.5.tgz#05f5997b609647b64f66b81e3b4b10a368e7ad13" + integrity sha512-Lhz8TLaYnxq/2ObqHDql8dX8CJi97oHxrjUcYtzKbbykPtVW9WB+poxI+NM2UIzsMgNCZTIf0AQwsjK5yMAqZw== + dependencies: + cliui "^4.0.0" + decamelize "^1.2.0" + find-up "^3.0.0" + get-caller-file "^1.0.1" + os-locale "^3.0.0" + require-directory "^2.1.1" + require-main-filename "^1.0.1" + set-blocking "^2.0.0" + string-width "^2.0.0" + which-module "^2.0.0" + y18n "^3.2.1 || ^4.0.0" + yargs-parser "^11.1.1" + +yargs@^15.3.1: + version "15.4.1" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-15.4.1.tgz#0d87a16de01aee9d8bec2bfbf74f67851730f4f8" + integrity sha512-aePbxDmcYW++PaqBsJ+HYUFwCdv4LVvdnhBy78E57PIor8/OVvhMrADFFEDh8DHDFRv/O9i3lPhsENjO7QX0+A== + dependencies: + cliui "^6.0.0" + decamelize "^1.2.0" + find-up "^4.1.0" + get-caller-file "^2.0.1" + require-directory "^2.1.1" + require-main-filename "^2.0.0" + set-blocking "^2.0.0" + string-width "^4.2.0" + which-module "^2.0.0" + y18n "^4.0.0" + yargs-parser "^18.1.2" + +yargs@^17.0.1: + version "17.4.1" + resolved "https://registry.yarnpkg.com/yargs/-/yargs-17.4.1.tgz#ebe23284207bb75cee7c408c33e722bfb27b5284" + integrity sha512-WSZD9jgobAg3ZKuCQZSa3g9QOJeCCqLoLAykiWgmXnDo9EPnn4RPf5qVTtzgOx66o6/oqhcA5tHtJXpG8pMt3g== + dependencies: + cliui "^7.0.2" + escalade "^3.1.1" + get-caller-file "^2.0.5" + require-directory "^2.1.1" + string-width "^4.2.3" + y18n "^5.0.5" + yargs-parser "^21.0.0"