Skip to content
Snippets Groups Projects
Unverified Commit e3eb873f authored by Martin Weise's avatar Martin Weise
Browse files

Updated API

parent fa90e142
Branches
No related tags found
No related merge requests found
Pipeline #2844 passed
Showing
with 5093 additions and 1316 deletions
...@@ -10,6 +10,7 @@ clean: ...@@ -10,6 +10,7 @@ clean:
release: release-docs release-dockerhub release: release-docs release-dockerhub
release-docs: release-docs:
cd ./swagger && ./generate.sh
docker compose build dbrepo-docs docker compose build dbrepo-docs
docker tag dbrepo-docs:latest "dbrepo/docs:${TAG}" docker tag dbrepo-docs:latest "dbrepo/docs:${TAG}"
docker push "dbrepo/docs:${TAG}" docker push "dbrepo/docs:${TAG}"
......
...@@ -17,19 +17,21 @@ COPY ./swagger-initializer.js ./swagger-initializer.js ...@@ -17,19 +17,21 @@ COPY ./swagger-initializer.js ./swagger-initializer.js
COPY ./docker-build.sh ./docker-build.sh COPY ./docker-build.sh ./docker-build.sh
RUN chmod +x ./docker-build.sh RUN chmod +x ./docker-build.sh
COPY ./nginx.conf /etc/nginx/nginx.conf
WORKDIR /usr/share/nginx/html/ WORKDIR /usr/share/nginx/html/
# copy api
COPY ./index.html ./index.html COPY ./index.html ./index.html
COPY ./api-analyse.yaml ./analyse/api.yaml
COPY ./api-authentication.yaml ./authentication/api.yaml COPY ./api-analyse.yaml ./docs/analyse/api.yaml
COPY ./api-container.yaml ./container/api.yaml COPY ./api-authentication.yaml ./docs/authentication/api.yaml
COPY ./api-database.yaml ./database/api.yaml COPY ./api-container.yaml ./docs/container/api.yaml
COPY ./api-identifier.yaml ./identifier/api.yaml COPY ./api-database.yaml ./docs/database/api.yaml
COPY ./api-metadata.yaml ./metadata/api.yaml COPY ./api-identifier.yaml ./docs/identifier/api.yaml
COPY ./api-query.yaml ./query/api.yaml COPY ./api-metadata.yaml ./docs/metadata/api.yaml
COPY ./api-table.yaml ./table/api.yaml COPY ./api-query.yaml ./docs/query/api.yaml
COPY ./api-units.yaml ./units/api.yaml COPY ./api-table.yaml ./docs/table/api.yaml
COPY ./api-units.yaml ./docs/units/api.yaml
# generate # generate
RUN bash /app/docker-build.sh RUN bash /app/docker-build.sh
\ No newline at end of file
openapi: 3.0.1 {"definitions":{},"info":{"contact":{"email":"andreas.rauber@tuwien.ac.at","name":"Prof. Andreas Rauber"},"description":"Service that analyses data structures","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"title":"Database Repository Analyse Service API","version":"1.1.0-alpha"},"openapi":"3.0.0","paths":{"/api/analyse/determinedt":{"post":{"consumes":["application/json"],"description":"This is a simple API which returns the datatypes of a (path) csv file","parameters":[{"description":"to-do description","in":"body","name":"body","required":true,"schema":{"properties":{"enum":{"example":true,"type":"boolean"},"enum_tol":{"example":0.1},"filepath":{"example":"/data/testdt08.csv","type":"string"},"separator":{"example":",","type":"string"}},"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"405":{"description":"Invalid input"}},"summary":"Determine datatypes"}},"/api/analyse/determinepk":{"post":{"consumes":["application/json"],"description":"This is a simple API which returns the primary keys + ranking of a (path) csv file","parameters":[{"description":"to-do description","in":"body","name":"body","required":true,"schema":{"properties":{"filepath":{"example":"/data/testdt08.csv","type":"string"},"seperator":{"example":",","type":"string"}},"type":"object"}}],"produces":["application/json"],"responses":{"200":{"description":"OK"},"405":{"description":"Invalid input"}},"summary":"Determine primary keys"}}},"servers":[{"description":"Generated server url","url":"http://localhost:5000"}]}
info:
title: Database Repository Analyse Service API
description: Service that manages the analysis
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:
# Added by API Auto Mocking Plugin
- description: SwaggerHub API Auto Mocking
url: https://virtserver.swaggerhub.com/mweise/dbrepo-debug/1.1.0-alpha
- url: http://localhost:5000
description: Generated server url
paths:
/api/analyse/determinedt:
post:
tags:
- analyse-endpoint
summary: Determine datatypes
description: This is a simple API which returns the datatypes of a (path) csv file
requestBody:
required: true
content:
'*/*':
schema:
$ref: '#/components/schemas/DetermineDataTypeRequestDto'
responses:
200:
description: "OK"
content:
'*/*':
schema:
$ref: '#/components/schemas/DetermineDataTypeResponseDto'
405:
description: "Invalid input"
content:
'*/*':
schema:
$ref: '#/components/schemas/DeterminePrimaryKeyDto'
/api/analyse/determinepk:
post:
tags:
- analyse-endpoint
summary: Determine primary keys
description: This is a simple API which returns the primary keys + ranking of a (path) csv file
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
filepath:
type: string
example : "/data/testdt08.csv"
seperator:
type: string
example: ","
responses:
200:
description: "OK"
content:
'*/*':
schema:
$ref: '#/components/schemas/DeterminePrimaryKeyDto'
405:
description: "Invalid input"
content:
'*/*':
schema:
$ref: '#/components/schemas/ErrorDto'
/api/analyse/update_mdb_col:
post:
tags:
- mdb-endpoint
summary: Update entity mdb_columns from metadatabase
description: Updates entity mdb_columns and mdb_columns_num, mdb_columns_nom and mdb_columns_cat in metadatabase
requestBody:
required: true
description: Updates entity mdb_columns attributes (datatype, ordinal_position, is_nullable) and automatically updates mdb_columns_nom (attribute max_length), mdb_columns_num (min, max, mean, sd, histogram) and mdb_columns_cat (num_cat, cat_array). The attribute 'histogram' describes a equi-width histogram with a fix number of 10 buckets. The last value in this numeric array is the width of one bucket. The attribute cat_array contains an array with the names of the categories.
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateColumnDto'
responses:
200:
description: "OK"
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateColumnDto'
405:
description: "Invalid input"
content:
'*/*':
schema:
$ref: '#/components/schemas/ErrorDto'
components:
schemas:
DetermineDataTypeRequestDto:
required:
- filepath
type: object
properties:
filepath:
type: string
example : "/data/testdt08.csv"
enum:
type: boolean
example: true
enum_tol:
example: 0.1
separator:
type: string
example: ","
DetermineDataTypeResponseDto:
required:
- columns
- separator
type: object
properties:
columns:
type: array
items:
$ref: '#/components/schemas/DataTypeDto'
separator:
type: string
example: ","
DeterminePrimaryKeyDto:
required:
- filepath
type: "object"
properties:
filepath:
type: string
example : "/data/testdt08.csv"
seperator:
type: string
example: ","
UpdateColumnDto:
required:
- dbid
- tid
- cid
type: object
properties:
dbid:
type: integer
example: 1
tid:
type: integer
example: 1
cid:
type: integer
example: 1
DataTypeDto:
type: object
example: "{\"firstname\": \"text\"}"
ErrorDto:
required:
- success
type: object
properties:
success:
type: boolean
example : false
message:
type: string
example: Reason
\ No newline at end of file
This diff is collapsed.
...@@ -30,8 +30,8 @@ paths: ...@@ -30,8 +30,8 @@ paths:
type: integer type: integer
format: int64 format: int64
responses: responses:
"400": "404":
description: Bad Request description: Image not found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -42,8 +42,8 @@ paths: ...@@ -42,8 +42,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Image not found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -85,8 +85,8 @@ paths: ...@@ -85,8 +85,8 @@ paths:
$ref: '#/components/schemas/ImageChangeDto' $ref: '#/components/schemas/ImageChangeDto'
required: true required: true
responses: responses:
"400": "404":
description: Bad Request description: Image not found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -97,8 +97,8 @@ paths: ...@@ -97,8 +97,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Image not found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -136,8 +136,8 @@ paths: ...@@ -136,8 +136,8 @@ paths:
type: integer type: integer
format: int64 format: int64
responses: responses:
"400": "404":
description: Bad Request description: Image not found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -148,8 +148,8 @@ paths: ...@@ -148,8 +148,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Image not found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -188,8 +188,8 @@ paths: ...@@ -188,8 +188,8 @@ paths:
type: integer type: integer
format: int64 format: int64
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -200,8 +200,8 @@ paths: ...@@ -200,8 +200,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -243,8 +243,8 @@ paths: ...@@ -243,8 +243,8 @@ paths:
$ref: '#/components/schemas/ContainerChangeDto' $ref: '#/components/schemas/ContainerChangeDto'
required: true required: true
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -255,8 +255,8 @@ paths: ...@@ -255,8 +255,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -294,8 +294,8 @@ paths: ...@@ -294,8 +294,8 @@ paths:
type: integer type: integer
format: int64 format: int64
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -306,8 +306,8 @@ paths: ...@@ -306,8 +306,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -339,8 +339,8 @@ paths: ...@@ -339,8 +339,8 @@ paths:
summary: Find all images summary: Find all images
operationId: findAll operationId: findAll
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -351,8 +351,8 @@ paths: ...@@ -351,8 +351,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -389,8 +389,8 @@ paths: ...@@ -389,8 +389,8 @@ paths:
$ref: '#/components/schemas/ImageCreateDto' $ref: '#/components/schemas/ImageCreateDto'
required: true required: true
responses: responses:
"400": "404":
description: Bad Request description: Image not found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -401,8 +401,8 @@ paths: ...@@ -401,8 +401,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Image not found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -434,8 +434,8 @@ paths: ...@@ -434,8 +434,8 @@ paths:
summary: Find all containers summary: Find all containers
operationId: findAll_1 operationId: findAll_1
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -446,8 +446,8 @@ paths: ...@@ -446,8 +446,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -484,8 +484,8 @@ paths: ...@@ -484,8 +484,8 @@ paths:
$ref: '#/components/schemas/ContainerCreateRequestDto' $ref: '#/components/schemas/ContainerCreateRequestDto'
required: true required: true
responses: responses:
"400": "404":
description: Bad Request description: Not Found
content: content:
'*/*': '*/*':
schema: schema:
...@@ -496,8 +496,8 @@ paths: ...@@ -496,8 +496,8 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"404": "400":
description: Not Found description: Bad Request
content: content:
'*/*': '*/*':
schema: schema:
...@@ -918,6 +918,31 @@ components: ...@@ -918,6 +918,31 @@ components:
example: air-quality example: air-quality
ip_address: ip_address:
type: string type: string
CreatorDto:
required:
- created
- id
- name
type: object
properties:
id:
type: integer
format: int64
name:
type: string
example: "Carberry, Josiah"
affiliation:
type: string
example: Wesleyan University
orcid:
type: string
example: 0000-0002-1825-0097
created:
type: string
format: date-time
last_modified:
type: string
format: date-time
DatabaseDto: DatabaseDto:
required: required:
- creator - creator
...@@ -938,13 +963,93 @@ components: ...@@ -938,13 +963,93 @@ components:
example: air_quality example: air_quality
creator: creator:
$ref: '#/components/schemas/UserBriefDto' $ref: '#/components/schemas/UserBriefDto'
subjects: identifier:
$ref: '#/components/schemas/IdentifierDto'
description:
type: string
example: Weather Australia 2009-2021
tables:
type: array type: array
items: items:
$ref: '#/components/schemas/TableBriefDto'
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
example: weather_australia
is_public:
type: boolean
example: true
GrantedAuthorityDto:
type: object
properties:
authority:
type: string
example: ROLE_RESEARCHER
IdentifierDto:
required:
- container id
- creator
- creators
- database id
- execution
- publication_year
- query
- query_hash
- query_normalized
- result_hash
- result_number
- title
- type
- visibility
type: object
properties:
id:
type: integer
format: int64
type:
type: string
enum:
- database
- subset
title:
type: string type: string
example: "Airquality Stephansplatz, Vienna, Austria"
description:
type: string
example: "Air quality reports at Stephansplatz, Vienna"
query:
type: string
example: "SELECT `id`, `value`, `location` FROM `air_quality` WHERE `location`\
\ = \"09:STEF\""
execution:
type: string
format: date-time
visibility:
type: string
example: everyone
enum:
- everyone
- trusted
- self
doi:
type: string
example: 10.1038/nphys1170
publisher:
type: string
example: TU Wien
creator:
$ref: '#/components/schemas/UserDto'
language: language:
type: string type: string
example: EN
enum: enum:
- ab - ab
- aa - aa
...@@ -1132,41 +1237,57 @@ components: ...@@ -1132,41 +1237,57 @@ components:
- zu - zu
license: license:
$ref: '#/components/schemas/LicenseDto' $ref: '#/components/schemas/LicenseDto'
description: creators:
type: string
example: Weather Australia 2009-2021
publisher:
type: string
example: TU Wien
tables:
type: array type: array
items: items:
$ref: '#/components/schemas/TableBriefDto' $ref: '#/components/schemas/CreatorDto'
image:
$ref: '#/components/schemas/ImageDto'
container:
$ref: '#/components/schemas/ContainerDto'
created: created:
type: string type: string
format: date-time format: date-time
deleted: container id:
type: integer
format: int64
example: 1
database id:
type: integer
format: int64
example: 1
query id:
type: integer
format: int64
example: 1
query_normalized:
type: string type: string
format: date-time example: "SELECT `id`, `value`, `location` FROM `air_quality` WHERE `location`\
internal_name: \ = \"09:STEF\""
related:
type: array
items:
$ref: '#/components/schemas/RelatedIdentifierDto'
query_hash:
type: string type: string
example: weather_australia description: query hash in sha512
publication_year: result_hash:
type: string
result_number:
type: integer
format: int64
example: 1
publication_day:
type: integer type: integer
format: int32 format: int32
example: 15
publication_month: publication_month:
type: integer type: integer
format: int32 format: int32
publication_day: example: 12
publication_year:
type: integer type: integer
format: int32 format: int32
is_public: example: 2022
type: boolean last_modified:
example: true type: string
format: date-time
LicenseDto: LicenseDto:
required: required:
- identifier - identifier
...@@ -1179,7 +1300,88 @@ components: ...@@ -1179,7 +1300,88 @@ components:
uri: uri:
type: string type: string
example: https://opensource.org/licenses/MIT example: https://opensource.org/licenses/MIT
example: MIT2 RelatedIdentifierDto:
required:
- created
- id
- value
type: object
properties:
id:
type: integer
format: int64
value:
type: string
example: 10.70124/dc4zh-9ce78
type:
type: string
example: DOI
enum:
- DOI
- URL
- URN
- ARK
- arXiv
- bibcode
- EAN13
- EISSN
- Handle
- IGSN
- ISBN
- ISTC
- LISSN
- LSID
- PMID
- PURL
- UPC
- w3id
relation:
type: string
example: Cites
enum:
- IsCitedBy
- Cites
- IsSupplementTo
- IsSupplementedBy
- IsContinuedBy
- Continues
- IsDescribedBy
- Describes
- HasMetadata
- IsMetadataFor
- HasVersion
- IsVersionOf
- IsNewVersionOf
- IsPreviousVersionOf
- IsPartOf
- HasPart
- IsPublishedIn
- IsReferencedBy
- References
- IsDocumentedBy
- Documents
- IsCompiledBy
- Compiles
- IsVariantFormOf
- IsOriginalFormOf
- IsIdenticalTo
- IsReviewedBy
- Reviews
- IsDerivedFrom
- IsSourceOf
- IsRequiredBy
- Requires
- IsObsoletedBy
- Obsoletes
created:
type: string
format: date-time
deleted:
type: string
format: date-time
last_modified:
type: string
format: date-time
TableBriefDto: TableBriefDto:
required: required:
- creator - creator
...@@ -1199,6 +1401,64 @@ components: ...@@ -1199,6 +1401,64 @@ components:
internal_name: internal_name:
type: string type: string
example: air_quality example: air_quality
UserDto:
required:
- email
- email_verified
- id
- theme_dark
- username
type: object
properties:
id:
type: integer
format: int64
authorities:
type: array
items:
$ref: '#/components/schemas/GrantedAuthorityDto'
username:
type: string
description: Only contains lowercase characters
example: jcarberry
firstname:
type: string
example: Josiah
lastname:
type: string
example: Carberry
affiliation:
type: string
example: Brown University
orcid:
type: string
example: 0000-0002-1825-0097
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
example: jcarberry@brown.edu
titles_before:
type: string
example: Prof.
titles_after:
type: string
theme_dark:
type: boolean
example: true
email_verified:
type: boolean
example: true
securitySchemes: securitySchemes:
bearerAuth: bearerAuth:
type: http type: http
......
This diff is collapsed.
This diff is collapsed.
...@@ -13,7 +13,7 @@ externalDocs: ...@@ -13,7 +13,7 @@ externalDocs:
description: Wiki Documentation description: Wiki Documentation
url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis url: https://gitlab.phaidra.org/fair-data-austria-db-repository/fda-services/-/wikis
servers: servers:
- url: http://localhost:9098 - url: http://localhost:9099
description: Generated server url description: Generated server url
paths: paths:
/api/oai: /api/oai:
...@@ -24,16 +24,25 @@ paths: ...@@ -24,16 +24,25 @@ paths:
operationId: identify_1_1_1_1 operationId: identify_1_1_1_1
parameters: parameters:
- name: verb - name: verb
in: query example: ListMetadataFormats
required: true
schema:
type: string
- name: parameters - name: parameters
in: query in: query
required: true required: true
schema: schema:
$ref: '#/components/schemas/OaiListIdentifiersParameters' $ref: '#/components/schemas/OaiListIdentifiersParameters'
responses: responses:
"404":
description: Not Found
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiErrorDto'
"400":
description: Bad Request
content:
'*/*':
schema:
$ref: '#/components/schemas/ApiErrorDto'
"200": "200":
description: OK description: OK
content: content:
...@@ -42,6 +51,91 @@ paths: ...@@ -42,6 +51,91 @@ paths:
type: object type: object
components: components:
schemas: schemas:
ApiErrorDto:
required:
- code
- message
- status
type: object
properties:
status:
type: string
example: NOT_FOUND
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
example: Could not find container
code:
type: string
example: error.container.notfound
OaiListIdentifiersParameters: OaiListIdentifiersParameters:
type: object type: object
properties: properties:
...@@ -55,11 +149,11 @@ components: ...@@ -55,11 +149,11 @@ components:
type: string type: string
resumptionToken: resumptionToken:
type: string type: string
parametersString:
type: string
fromDate: fromDate:
type: string type: string
format: date-time format: date-time
parametersString:
type: string
untilDate: untilDate:
type: string type: string
format: date-time format: date-time
This diff is collapsed.
...@@ -60,14 +60,14 @@ paths: ...@@ -60,14 +60,14 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"406": "405":
description: Not Acceptable description: Method Not Allowed
content: content:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"405": "406":
description: Method Not Allowed description: Not Acceptable
content: content:
'*/*': '*/*':
schema: schema:
...@@ -123,14 +123,14 @@ paths: ...@@ -123,14 +123,14 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"406": "405":
description: Not Acceptable description: Method Not Allowed
content: content:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"405": "406":
description: Method Not Allowed description: Not Acceptable
content: content:
'*/*': '*/*':
schema: schema:
...@@ -167,11 +167,6 @@ paths: ...@@ -167,11 +167,6 @@ paths:
schema: schema:
type: integer type: integer
format: int64 format: int64
- name: Authorization
in: header
required: true
schema:
type: string
responses: responses:
"400": "400":
description: Bad Request description: Bad Request
...@@ -191,14 +186,14 @@ paths: ...@@ -191,14 +186,14 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"406": "405":
description: Not Acceptable description: Method Not Allowed
content: content:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"405": "406":
description: Method Not Allowed description: Not Acceptable
content: content:
'*/*': '*/*':
schema: schema:
...@@ -212,7 +207,7 @@ paths: ...@@ -212,7 +207,7 @@ paths:
tags: tags:
- table-endpoint - table-endpoint
summary: List all tables summary: List all tables
operationId: findAll operationId: list
parameters: parameters:
- name: id - name: id
in: path in: path
...@@ -245,14 +240,14 @@ paths: ...@@ -245,14 +240,14 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"406": "405":
description: Not Acceptable description: Method Not Allowed
content: content:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"405": "406":
description: Method Not Allowed description: Not Acceptable
content: content:
'*/*': '*/*':
schema: schema:
...@@ -285,11 +280,6 @@ paths: ...@@ -285,11 +280,6 @@ paths:
schema: schema:
type: integer type: integer
format: int64 format: int64
- name: Authorization
in: header
required: true
schema:
type: string
requestBody: requestBody:
content: content:
application/json: application/json:
...@@ -315,14 +305,14 @@ paths: ...@@ -315,14 +305,14 @@ paths:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"406": "405":
description: Not Acceptable description: Method Not Allowed
content: content:
'*/*': '*/*':
schema: schema:
$ref: '#/components/schemas/ApiErrorDto' $ref: '#/components/schemas/ApiErrorDto'
"405": "406":
description: Method Not Allowed description: Not Acceptable
content: content:
'*/*': '*/*':
schema: schema:
......
# coding: utf-8
# flake8: noqa
"""
Database Repository Analyse Service API
Service that analyses data structures # noqa: E501
OpenAPI spec version: 1.1.0-alpha
Contact: andreas.rauber@tuwien.ac.at
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
# import apis into sdk package
from api_analyse.api.default_api import DefaultApi
# import ApiClient
from api_analyse.api_client import ApiClient
from api_analyse.configuration import Configuration
# import models into sdk package
from __future__ import absolute_import
# flake8: noqa
# import apis into api package
from api_analyse.api.default_api import DefaultApi
# coding: utf-8
"""
Database Repository Analyse Service API
Service that analyses data structures # noqa: E501
OpenAPI spec version: 1.1.0-alpha
Contact: andreas.rauber@tuwien.ac.at
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
import re # noqa: F401
# python 2 and python 3 compatibility library
import six
from api_analyse.api_client import ApiClient
class DefaultApi(object):
"""NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Ref: https://github.com/swagger-api/swagger-codegen
"""
def __init__(self, api_client=None):
if api_client is None:
api_client = ApiClient()
self.api_client = api_client
def api_analyse_determinedt_post(self, **kwargs): # noqa: E501
"""Determine datatypes # noqa: E501
This is a simple API which returns the datatypes of a (path) csv file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_analyse_determinedt_post(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.api_analyse_determinedt_post_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.api_analyse_determinedt_post_with_http_info(**kwargs) # noqa: E501
return data
def api_analyse_determinedt_post_with_http_info(self, **kwargs): # noqa: E501
"""Determine datatypes # noqa: E501
This is a simple API which returns the datatypes of a (path) csv file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_analyse_determinedt_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method api_analyse_determinedt_post" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/api/analyse/determinedt', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
def api_analyse_determinepk_post(self, **kwargs): # noqa: E501
"""Determine primary keys # noqa: E501
This is a simple API which returns the primary keys + ranking of a (path) csv file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_analyse_determinepk_post(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: None
If the method is called asynchronously,
returns the request thread.
"""
kwargs['_return_http_data_only'] = True
if kwargs.get('async_req'):
return self.api_analyse_determinepk_post_with_http_info(**kwargs) # noqa: E501
else:
(data) = self.api_analyse_determinepk_post_with_http_info(**kwargs) # noqa: E501
return data
def api_analyse_determinepk_post_with_http_info(self, **kwargs): # noqa: E501
"""Determine primary keys # noqa: E501
This is a simple API which returns the primary keys + ranking of a (path) csv file # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.api_analyse_determinepk_post_with_http_info(async_req=True)
>>> result = thread.get()
:param async_req bool
:return: None
If the method is called asynchronously,
returns the request thread.
"""
all_params = [] # noqa: E501
all_params.append('async_req')
all_params.append('_return_http_data_only')
all_params.append('_preload_content')
all_params.append('_request_timeout')
params = locals()
for key, val in six.iteritems(params['kwargs']):
if key not in all_params:
raise TypeError(
"Got an unexpected keyword argument '%s'"
" to method api_analyse_determinepk_post" % key
)
params[key] = val
del params['kwargs']
collection_formats = {}
path_params = {}
query_params = []
header_params = {}
form_params = []
local_var_files = {}
body_params = None
# Authentication setting
auth_settings = [] # noqa: E501
return self.api_client.call_api(
'/api/analyse/determinepk', 'POST',
path_params,
query_params,
header_params,
body=body_params,
post_params=form_params,
files=local_var_files,
response_type=None, # noqa: E501
auth_settings=auth_settings,
async_req=params.get('async_req'),
_return_http_data_only=params.get('_return_http_data_only'),
_preload_content=params.get('_preload_content', True),
_request_timeout=params.get('_request_timeout'),
collection_formats=collection_formats)
This diff is collapsed.
This diff is collapsed.
# coding: utf-8
# flake8: noqa
"""
Database Repository Analyse Service API
Service that analyses data structures # noqa: E501
OpenAPI spec version: 1.1.0-alpha
Contact: andreas.rauber@tuwien.ac.at
Generated by: https://github.com/swagger-api/swagger-codegen.git
"""
from __future__ import absolute_import
# import models into model package
This diff is collapsed.
...@@ -16,6 +16,7 @@ from __future__ import absolute_import ...@@ -16,6 +16,7 @@ from __future__ import absolute_import
# import apis into sdk package # import apis into sdk package
from api_authentication.api.authentication_endpoint_api import AuthenticationEndpointApi from api_authentication.api.authentication_endpoint_api import AuthenticationEndpointApi
from api_authentication.api.time_secret_endpoint_api import TimeSecretEndpointApi
from api_authentication.api.token_endpoint_api import TokenEndpointApi from api_authentication.api.token_endpoint_api import TokenEndpointApi
from api_authentication.api.user_endpoint_api import UserEndpointApi from api_authentication.api.user_endpoint_api import UserEndpointApi
# import ApiClient # import ApiClient
...@@ -24,8 +25,10 @@ from api_authentication.configuration import Configuration ...@@ -24,8 +25,10 @@ from api_authentication.configuration import Configuration
# import models into sdk package # import models into sdk package
from api_authentication.models.api_error_dto import ApiErrorDto from api_authentication.models.api_error_dto import ApiErrorDto
from api_authentication.models.container_dto import ContainerDto from api_authentication.models.container_dto import ContainerDto
from api_authentication.models.creator_dto import CreatorDto
from api_authentication.models.database_dto import DatabaseDto from api_authentication.models.database_dto import DatabaseDto
from api_authentication.models.granted_authority_dto import GrantedAuthorityDto from api_authentication.models.granted_authority_dto import GrantedAuthorityDto
from api_authentication.models.identifier_dto import IdentifierDto
from api_authentication.models.image_brief_dto import ImageBriefDto from api_authentication.models.image_brief_dto import ImageBriefDto
from api_authentication.models.image_date_dto import ImageDateDto from api_authentication.models.image_date_dto import ImageDateDto
from api_authentication.models.image_dto import ImageDto from api_authentication.models.image_dto import ImageDto
...@@ -33,8 +36,11 @@ from api_authentication.models.image_env_item_dto import ImageEnvItemDto ...@@ -33,8 +36,11 @@ from api_authentication.models.image_env_item_dto import ImageEnvItemDto
from api_authentication.models.jwt_response_dto import JwtResponseDto from api_authentication.models.jwt_response_dto import JwtResponseDto
from api_authentication.models.license_dto import LicenseDto from api_authentication.models.license_dto import LicenseDto
from api_authentication.models.login_request_dto import LoginRequestDto from api_authentication.models.login_request_dto import LoginRequestDto
from api_authentication.models.related_identifier_dto import RelatedIdentifierDto
from api_authentication.models.signup_request_dto import SignupRequestDto from api_authentication.models.signup_request_dto import SignupRequestDto
from api_authentication.models.table_brief_dto import TableBriefDto from api_authentication.models.table_brief_dto import TableBriefDto
from api_authentication.models.token_brief_dto import TokenBriefDto
from api_authentication.models.token_dto import TokenDto
from api_authentication.models.user_brief_dto import UserBriefDto from api_authentication.models.user_brief_dto import UserBriefDto
from api_authentication.models.user_dto import UserDto from api_authentication.models.user_dto import UserDto
from api_authentication.models.user_email_dto import UserEmailDto from api_authentication.models.user_email_dto import UserEmailDto
......
...@@ -4,5 +4,6 @@ from __future__ import absolute_import ...@@ -4,5 +4,6 @@ from __future__ import absolute_import
# import apis into api package # import apis into api package
from api_authentication.api.authentication_endpoint_api import AuthenticationEndpointApi from api_authentication.api.authentication_endpoint_api import AuthenticationEndpointApi
from api_authentication.api.time_secret_endpoint_api import TimeSecretEndpointApi
from api_authentication.api.token_endpoint_api import TokenEndpointApi from api_authentication.api.token_endpoint_api import TokenEndpointApi
from api_authentication.api.user_endpoint_api import UserEndpointApi from api_authentication.api.user_endpoint_api import UserEndpointApi
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment