Skip to content

Commit

Permalink
add the sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
nvnieuwk committed Jun 25, 2024
0 parents commit 3499de4
Show file tree
Hide file tree
Showing 69 changed files with 7,392 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
*.class

# Mobile Tools for Java (J2ME)
.mtj.tmp/

# Package Files #
*.jar
*.war
*.ear

# exclude jar for gradle wrapper
!gradle/wrapper/*.jar

# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*

# build files
**/target
target
.gradle
build
23 changes: 23 additions & 0 deletions .swagger-codegen-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Swagger Codegen Ignore
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
1 change: 1 addition & 0 deletions .swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.0.57
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
#
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#
language: java
jdk:
- oraclejdk8
- oraclejdk7
before_install:
# ensure gradlew has proper permission
- chmod a+x ./gradlew
script:
# test using maven
- mvn test
# uncomment below to test using gradle
# - gradle test
# uncomment below to test using sbt
# - sbt test
307 changes: 307 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,307 @@
# swagger-java-client

Data Repository Service
- API version: 1.2.0
- Build date: 2024-06-25T15:49:43.145836023+02:00[Europe/Brussels]

GET request: - Fetch a DrsObject from the database by sending a unique ID through the request - Fetch an access url to the data which the object refers to - Fetch DrsObjects by doing a search on the aliases POST request: - Create a non-existing DrsObject in the database by giving an identifier DELETE request: - Delete a DrsObject from the database by unique identifier PUT request: - Update an existing DrsObject by unique identifier and the changes in the body


*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)*


## Requirements

Building the API client library requires:
1. Java 1.7+
2. Maven/Gradle

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell
mvn clean install
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell
mvn clean deploy
```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-java-client</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
```

### Gradle users

Add this dependency to your project's build file:

```groovy
compile "io.swagger:swagger-java-client:1.0.0"
```

### Others

At first generate the JAR by executing:

```shell
mvn clean package
```

Then manually install the following JARs:

* `target/swagger-java-client-1.0.0.jar`
* `target/lib/*.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
String objectId = "objectId_example"; // String |
try {
BasicResponse result = apiInstance.deleteObjectGa4ghDrsV1ObjectsObjectIdDelete(objectId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#deleteObjectGa4ghDrsV1ObjectsObjectIdDelete");
e.printStackTrace();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
List<String> alias = Arrays.asList("alias_example"); // List<String> | The alias(ses) on which to query DrsObjects (regex compatible)
try {
List<DrsObject> result = apiInstance.getObjectAliasGa4ghDrsV1ObjectsGet(alias);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#getObjectAliasGa4ghDrsV1ObjectsGet");
e.printStackTrace();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
String objectId = "objectId_example"; // String | ```DrsObject``` identifier
String accessId = "accessId_example"; // String | An `access_id` from the `access_methods` list of a `DrsObject`
try {
AccessURL result = apiInstance.getObjectGa4ghDrsV1ObjectsObjectIdAccessAccessIdGet(objectId, accessId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#getObjectGa4ghDrsV1ObjectsObjectIdAccessAccessIdGet");
e.printStackTrace();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
String objectId = "objectId_example"; // String | ```DrsObject``` identifier
Boolean expand = true; // Boolean | If false and the object_id refers to a bundle, then the ContentsObject array contains only those objects directly contained in the bundle. That is, if the bundle contains other bundles, those other bundles are not recursively included in the result. If true and the object_id refers to a bundle, then the entire set of objects in the bundle is expanded. That is, if the bundle contains aother bundles, then those other bundles are recursively expanded and included in the result. Recursion continues through the entire sub-tree of the bundle. If the object_id refers to a blob, then the query parameter is ignored.
try {
DrsObject result = apiInstance.getObjectGa4ghDrsV1ObjectsObjectIdGet(objectId, expand);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#getObjectGa4ghDrsV1ObjectsObjectIdGet");
e.printStackTrace();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
DrsObject body = new DrsObject(); // DrsObject |
try {
BasicResponse result = apiInstance.postObjectGa4ghDrsV1ObjectsPost(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#postObjectGa4ghDrsV1ObjectsPost");
e.printStackTrace();
}
}
}
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataRepositoryServiceApi;

import java.io.File;
import java.util.*;

public class DataRepositoryServiceApiExample {

public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: OAuth2PasswordBearer
ApiKeyAuth OAuth2PasswordBearer = (ApiKeyAuth) defaultClient.getAuthentication("OAuth2PasswordBearer");
OAuth2PasswordBearer.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//OAuth2PasswordBearer.setApiKeyPrefix("Token");

DataRepositoryServiceApi apiInstance = new DataRepositoryServiceApi();
DrsObject body = new DrsObject(); // DrsObject |
String objectId = "objectId_example"; // String |
try {
BasicResponse result = apiInstance.putObjectGa4ghDrsV1ObjectsObjectIdPut(body, objectId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DataRepositoryServiceApi#putObjectGa4ghDrsV1ObjectsObjectIdPut");
e.printStackTrace();
}
}
}
```

## Documentation for API Endpoints

All URIs are relative to */*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DataRepositoryServiceApi* | [**deleteObjectGa4ghDrsV1ObjectsObjectIdDelete**](docs/DataRepositoryServiceApi.md#deleteObjectGa4ghDrsV1ObjectsObjectIdDelete) | **DELETE** /ga4gh/drs/v1/objects/{object_id} | Delete a DrsObject
*DataRepositoryServiceApi* | [**getObjectAliasGa4ghDrsV1ObjectsGet**](docs/DataRepositoryServiceApi.md#getObjectAliasGa4ghDrsV1ObjectsGet) | **GET** /ga4gh/drs/v1/objects | Query DrsObjects on alias
*DataRepositoryServiceApi* | [**getObjectGa4ghDrsV1ObjectsObjectIdAccessAccessIdGet**](docs/DataRepositoryServiceApi.md#getObjectGa4ghDrsV1ObjectsObjectIdAccessAccessIdGet) | **GET** /ga4gh/drs/v1/objects/{object_id}/access/{access_id} | Get a URL for fetching bytes
*DataRepositoryServiceApi* | [**getObjectGa4ghDrsV1ObjectsObjectIdGet**](docs/DataRepositoryServiceApi.md#getObjectGa4ghDrsV1ObjectsObjectIdGet) | **GET** /ga4gh/drs/v1/objects/{object_id} | Retrieve a DrsObject
*DataRepositoryServiceApi* | [**postObjectGa4ghDrsV1ObjectsPost**](docs/DataRepositoryServiceApi.md#postObjectGa4ghDrsV1ObjectsPost) | **POST** /ga4gh/drs/v1/objects | Create a new DrsObject
*DataRepositoryServiceApi* | [**putObjectGa4ghDrsV1ObjectsObjectIdPut**](docs/DataRepositoryServiceApi.md#putObjectGa4ghDrsV1ObjectsObjectIdPut) | **PUT** /ga4gh/drs/v1/objects/{object_id} | Update a DrsObject
*HealthApi* | [**getHealthHealthGet**](docs/HealthApi.md#getHealthHealthGet) | **GET** /health | Check if the API is running correctly
*LoginApi* | [**loginTokenPost**](docs/LoginApi.md#loginTokenPost) | **POST** /token | Login

## Documentation for Models

- [AccessMethods](docs/AccessMethods.md)
- [AccessURL](docs/AccessURL.md)
- [AllOfDrsObjectAccessMethods](docs/AllOfDrsObjectAccessMethods.md)
- [AllOfDrsObjectChecksums](docs/AllOfDrsObjectChecksums.md)
- [AllOfDrsObjectContents](docs/AllOfDrsObjectContents.md)
- [BasicResponse](docs/BasicResponse.md)
- [BodyLoginTokenPost](docs/BodyLoginTokenPost.md)
- [Checksums](docs/Checksums.md)
- [ContentsExpanded](docs/ContentsExpanded.md)
- [DrsObject](docs/DrsObject.md)
- [Error](docs/Error.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [Token](docs/Token.md)
- [ValidationError](docs/ValidationError.md)

## Documentation for Authorization

Authentication schemes defined for the API:
### OAuth2PasswordBearer

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Author

[email protected]
Loading

0 comments on commit 3499de4

Please sign in to comment.