|
| 1 | +# openapi-java-client |
| 2 | + |
| 3 | +FileApi |
| 4 | +- API version: 0.1 |
| 5 | + - Build date: 2025-10-30T21:45:34.503460199+01:00[Europe/Brussels] |
| 6 | + - Generator version: 7.17.0 |
| 7 | + |
| 8 | +File Api V1 |
| 9 | + |
| 10 | + |
| 11 | +*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)* |
| 12 | + |
| 13 | + |
| 14 | +## Requirements |
| 15 | + |
| 16 | +Building the API client library requires: |
| 17 | +1. Java 1.8+ |
| 18 | +2. Maven (3.8.3+)/Gradle (7.2+) |
| 19 | + |
| 20 | +## Installation |
| 21 | + |
| 22 | +To install the API client library to your local Maven repository, simply execute: |
| 23 | + |
| 24 | +```shell |
| 25 | +mvn clean install |
| 26 | +``` |
| 27 | + |
| 28 | +To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: |
| 29 | + |
| 30 | +```shell |
| 31 | +mvn clean deploy |
| 32 | +``` |
| 33 | + |
| 34 | +Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. |
| 35 | + |
| 36 | +### Maven users |
| 37 | + |
| 38 | +Add this dependency to your project's POM: |
| 39 | + |
| 40 | +```xml |
| 41 | +<dependency> |
| 42 | + <groupId>org.openapitools</groupId> |
| 43 | + <artifactId>openapi-java-client</artifactId> |
| 44 | + <version>0.1</version> |
| 45 | + <scope>compile</scope> |
| 46 | +</dependency> |
| 47 | +``` |
| 48 | + |
| 49 | +### Gradle users |
| 50 | + |
| 51 | +Add this dependency to your project's build file: |
| 52 | + |
| 53 | +```groovy |
| 54 | + repositories { |
| 55 | + mavenCentral() // Needed if the 'openapi-java-client' jar has been published to maven central. |
| 56 | + mavenLocal() // Needed if the 'openapi-java-client' jar has been published to the local maven repo. |
| 57 | + } |
| 58 | +
|
| 59 | + dependencies { |
| 60 | + implementation "org.openapitools:openapi-java-client:0.1" |
| 61 | + } |
| 62 | +``` |
| 63 | + |
| 64 | +### Others |
| 65 | + |
| 66 | +At first generate the JAR by executing: |
| 67 | + |
| 68 | +```shell |
| 69 | +mvn clean package |
| 70 | +``` |
| 71 | + |
| 72 | +Then manually install the following JARs: |
| 73 | + |
| 74 | +* `target/openapi-java-client-0.1.jar` |
| 75 | +* `target/lib/*.jar` |
| 76 | + |
| 77 | +## Getting Started |
| 78 | + |
| 79 | +Please follow the [installation](#installation) instruction and execute the following Java code: |
| 80 | + |
| 81 | +```java |
| 82 | + |
| 83 | +// Import classes: |
| 84 | +import org.openapitools.client.ApiClient; |
| 85 | +import org.openapitools.client.ApiException; |
| 86 | +import org.openapitools.client.Configuration; |
| 87 | +import org.openapitools.client.model.*; |
| 88 | +import org.openapitools.client.api.TemplateRoutesApi; |
| 89 | + |
| 90 | +public class Example { |
| 91 | + public static void main(String[] args) { |
| 92 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 93 | + defaultClient.setBasePath("http://localhost"); |
| 94 | + |
| 95 | + TemplateRoutesApi apiInstance = new TemplateRoutesApi(defaultClient); |
| 96 | + String id = "id_example"; // String | |
| 97 | + try { |
| 98 | + apiInstance.deleteTemplById(id); |
| 99 | + } catch (ApiException e) { |
| 100 | + System.err.println("Exception when calling TemplateRoutesApi#deleteTemplById"); |
| 101 | + System.err.println("Status code: " + e.getCode()); |
| 102 | + System.err.println("Reason: " + e.getResponseBody()); |
| 103 | + System.err.println("Response headers: " + e.getResponseHeaders()); |
| 104 | + e.printStackTrace(); |
| 105 | + } |
| 106 | + } |
| 107 | +} |
| 108 | + |
| 109 | +``` |
| 110 | + |
| 111 | +## Documentation for API Endpoints |
| 112 | + |
| 113 | +All URIs are relative to *http://localhost* |
| 114 | + |
| 115 | +Class | Method | HTTP request | Description |
| 116 | +------------ | ------------- | ------------- | ------------- |
| 117 | +*TemplateRoutesApi* | [**deleteTemplById**](docs/TemplateRoutesApi.md#deleteTemplById) | **DELETE** /api/v1/template/{id} | |
| 118 | +*TemplateRoutesApi* | [**findAll**](docs/TemplateRoutesApi.md#findAll) | **GET** /api/v1/template/find-all | |
| 119 | +*TemplateRoutesApi* | [**findByContext**](docs/TemplateRoutesApi.md#findByContext) | **GET** /api/v1/template/find-by-context | |
| 120 | +*TemplateRoutesApi* | [**findByIds**](docs/TemplateRoutesApi.md#findByIds) | **GET** /api/v1/template/find-by-ids | |
| 121 | +*TemplateRoutesApi* | [**findByType**](docs/TemplateRoutesApi.md#findByType) | **GET** /api/v1/template/find-by-type | |
| 122 | +*TemplateRoutesApi* | [**findOne**](docs/TemplateRoutesApi.md#findOne) | **GET** /api/v1/template/find-one/{templ_id} | |
| 123 | +*TemplateRoutesApi* | [**render**](docs/TemplateRoutesApi.md#render) | **POST** /api/v1/template/render | |
| 124 | +*TemplateRoutesApi* | [**upsert**](docs/TemplateRoutesApi.md#upsert) | **POST** /api/v1/template | |
| 125 | +*UploadRoutesApi* | [**deleteById**](docs/UploadRoutesApi.md#deleteById) | **DELETE** /api/v1/upload/{id} | |
| 126 | +*UploadRoutesApi* | [**download**](docs/UploadRoutesApi.md#download) | **GET** /api/v1/upload/download | |
| 127 | +*UploadRoutesApi* | [**findAllUploads**](docs/UploadRoutesApi.md#findAllUploads) | **GET** /api/v1/upload/find-all | |
| 128 | +*UploadRoutesApi* | [**metadata**](docs/UploadRoutesApi.md#metadata) | **GET** /api/v1/upload/metadata | |
| 129 | +*UploadRoutesApi* | [**upload**](docs/UploadRoutesApi.md#upload) | **POST** /api/v1/upload | |
| 130 | + |
| 131 | + |
| 132 | +## Documentation for Models |
| 133 | + |
| 134 | + - [Context](docs/Context.md) |
| 135 | + - [DownloadFileRequestUriParams](docs/DownloadFileRequestUriParams.md) |
| 136 | + - [FileUploadV2](docs/FileUploadV2.md) |
| 137 | + - [FindAllQueryParams](docs/FindAllQueryParams.md) |
| 138 | + - [RenderRequest](docs/RenderRequest.md) |
| 139 | + - [TemplateType](docs/TemplateType.md) |
| 140 | + - [TemplateUpsert](docs/TemplateUpsert.md) |
| 141 | + - [TemplateV2](docs/TemplateV2.md) |
| 142 | + - [UploadFileRequestUriParams](docs/UploadFileRequestUriParams.md) |
| 143 | + |
| 144 | + |
| 145 | +<a id="documentation-for-authorization"></a> |
| 146 | +## Documentation for Authorization |
| 147 | + |
| 148 | +Endpoints do not require authorization. |
| 149 | + |
| 150 | + |
| 151 | +## Recommendation |
| 152 | + |
| 153 | +It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. |
| 154 | + |
| 155 | +## Author |
| 156 | + |
| 157 | + |
| 158 | + |
0 commit comments