README.md

swagger-java-client

Jiskefet

• API version: 1.0
  • Build date: 2019-03-08T11:03:08.533Z

Running with /api prefix

Automatically generated by the 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:

mvn clean install

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

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<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:

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

Others

At first generate the JAR by executing:

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 instruction and execute the following Java code:

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AttachmentsApi;

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

public class AttachmentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: bearer
        ApiKeyAuth bearer = (ApiKeyAuth) defaultClient.getAuthentication("bearer");
        bearer.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //bearer.setApiKeyPrefix("Token");

        AttachmentsApi apiInstance = new AttachmentsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.attachmentsIdLogsGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#attachmentsIdLogsGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Class	Method	HTTP request	Description
AttachmentsApi	attachmentsIdLogsGet	GET /attachments/{id}/logs
AttachmentsApi	attachmentsPost	POST /attachments
AuthenticationApi	authGet	GET /auth	Authenticate a user by giving an Authorization Grant.
AuthenticationApi	profileGet	GET /profile	Returns the user's profile
LogsApi	logsGet	GET /logs
LogsApi	logsIdGet	GET /logs/{id}
LogsApi	logsIdRunsPatch	PATCH /logs/{id}/runs
LogsApi	logsPost	POST /logs
OverviewApi	overviewGet	GET /overview
RunsApi	runsGet	GET /runs
RunsApi	runsIdGet	GET /runs/{id}
RunsApi	runsIdLogsPatch	PATCH /runs/{id}/logs
RunsApi	runsPost	POST /runs
SubsystemsApi	subsystemsGet	GET /subsystems
SubsystemsApi	subsystemsIdGet	GET /subsystems/{id}
UsersApi	usersIdGet	GET /users/{id}
UsersApi	usersIdTokensGet	GET /users/{id}/tokens
UsersApi	usersIdTokensNewPost	POST /users/{id}/tokens/new

Documentation for Models

• CreateAttachmentDto
• CreateLogDto
• CreateRunDto
• CreateRunResultDto
• CreateSubSystemPermissionDto
• LinkLogToRunDto
• LinkRunToLogDto

Documentation for Authorization

Authentication schemes defined for the API:

bearer

• 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