The main repository is hosted in gitlab.com/ravimosharksas but it is automatically mirrored to github.com/RavimoShark, gitlab.com/singletonsd, github.com/singletonsd, github.com/patoperpetua and to gitlab.com/patoperpetua. If you are in the Github page it may occur that is not updated to the last version.
Ravimoshark Task API
- API version: 1.0.0
- Build date: 2019-10-20T13:36:04.593821+02:00[Europe/Rome]
This is an API to interact with Ravimoshark contracts database. # Introduction This API allow to create, modify and delete contracts and machines. It also interacts with machines imported from SAGE database. # User Authentication This API does not contain any kind of user validation but It request to have a valid authentication user to interact with it. For more information about user Authentication, please refer to Ravimoshark User Authentication.
For more information, please visit http://ravimoshark.com/contact
Automatically generated by the Swagger Codegen
Building the API client library requires:
- Java 1.7+
- Maven/Gradle
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.
Add this dependency to your project's POM:
<dependency>
<groupId>com.ravimoshark</groupId>
<artifactId>apis.task</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
Add this dependency to your project's build file:
compile "com.ravimoshark:apis.task:1.0.0"
At first generate the JAR by executing:
mvn clean package
Then manually install the following JARs:
target/apis.task-1.0.0.jar
target/lib/*.jar
Please follow the installation instruction and execute the following Java code:
import com.ravimoshark.apis.task.*;
import com.ravimoshark.apis.task.auth.*;
import com.ravimoshark.apis.task.model.*;
import com.ravimoshark.apis.task.calls.ClientsApi;
import java.io.File;
import java.util.*;
public class ClientsApiExample {
public static void main(String[] args) {
ClientsApi apiInstance = new ClientsApi();
Integer skip = 56; // Integer | number of item to skip
Integer limit = 56; // Integer | max records to return
String orderBy = "orderBy_example"; // String | order by property.
String filterBy = "filterBy_example"; // String | filter data.
Deleted deleted = new Deleted(); // Deleted | Get all, deleted, not deleted data. Default not deleted.
Boolean metadata = true; // Boolean | If metadata is needed (for pagination controls)
try {
InlineResponse200 result = apiInstance.getClients(skip, limit, orderBy, filterBy, deleted, metadata);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClientsApi#getClients");
e.printStackTrace();
}
}
}
All URIs are relative to http://localhost:8000
Class | Method | HTTP request | Description |
---|---|---|---|
ClientsApi | getClients | GET /clients | Get all clients. |
ContractsApi | addContract | POST /contracts | Add one contract. |
ContractsApi | deleteContract | DELETE /contracts/{refContract} | Delete one contract. |
ContractsApi | editContract | PUT /contracts | Edit one contract. |
ContractsApi | getContractById | GET /contracts/{refContract} | Get one contract. |
ContractsApi | getContracts | GET /contracts | Get all contracts. |
ImportedMachinesApi | addImportedMachine | POST /importedMachines | Add one imported Machine. |
ImportedMachinesApi | deleteImportedMachine | DELETE /importedMachines/{id} | Delete one imported Machine. |
ImportedMachinesApi | editImportedMachine | PUT /importedMachines | Edit one imported Machine. |
ImportedMachinesApi | getImportedMachineById | GET /importedMachines/{id} | Get one imported Machine. |
ImportedMachinesApi | getImportedMachines | GET /importedMachines | Get all imported Machines. |
LocationsApi | addLocation | POST /locations | Add one location. |
LocationsApi | deleteLocation | DELETE /locations/{id} copy | Delete one location. |
LocationsApi | editLocation | PUT /locations | Edit one location. |
LocationsApi | getLocationById | GET /locations/{id} copy | Get one Location. |
LocationsApi | getLocations | GET /locations | Get all locations. |
MachinesApi | addMachine | POST /machines | Add one machine. |
MachinesApi | deleteMachine | DELETE /machines/{id} | Delete one machine. |
MachinesApi | editMachine | PUT /machines | Edit one machine. |
MachinesApi | getMachineById | GET /machines/{id} | Get one Machine. |
MachinesApi | getMachines | GET /machines | Get all machines. |
PiecesApi | getPieces | GET /pieces | Get all pieces. |
- Clients
- Contracts
- CustomError
- Deleted
- IdInteger
- ImportedMachines
- InlineResponse200
- InlineResponse2001
- InlineResponse2002
- InlineResponse2003
- InlineResponse2004
- InlineResponse2005
- Locations
- Machines
- Metadata
- Pieces
- RefContract
- Reviewed
- Valid
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
- Type: HTTP basic authentication
- Type: OAuth
- Flow: implicit
- Authorization URL: http://example.com/api/oauth/dialog
- Scopes:
- :
It's recommended to create an instance of ApiClient
per thread in a multi-threaded environment to avoid any potential issues.
To regenerate the library from spec, first create a .env file with the following content:
SWAGGER_API_SPEC="" #Default value: ../../documentation/dist/openapi.yaml
SWAGGER_GROUP="" #MANDATORY FIELD
SWAGGER_ARTIFACT="" #MANDATORY FIELD
And then just execute the following script:
mkdir -p scripts && \
curl -o scripts/swagger_binaries_downloader.sh -L https://singletonsd.gitlab.io/scripts/swagger/latest/swagger_binaries_downloader.sh && \
curl -o scripts/swagger_generate_android.sh -L https://singletonsd.gitlab.io/scripts/swagger/latest/swagger_generate_android.sh && \
chmod +x scripts/swagger_binaries_downloader.sh scripts/swagger_generate_android.sh && \
./scripts/swagger_generate_android.sh
© Singleton SD, France, 2019.