Update client

This commit is contained in:
Jannis Mattheis
2020-06-24 18:40:00 +02:00
parent f3c7ffd9cd
commit 4edaa1943f
41 changed files with 460 additions and 122 deletions

View File

@@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**description** | **String** | The description of the application. | **description** | **String** | The description of the application. |
**id** | **Integer** | The application id. | **id** | **Long** | The application id. |
**image** | **String** | The image of the application. | **image** | **String** | The image of the application. |
**internal** | **Boolean** | Whether the application is an internal application. Internal applications should not be deleted. | **internal** | **Boolean** | Whether the application is an internal application. Internal applications should not be deleted. |
**name** | **String** | The application name. This is how the application should be displayed to the user. | **name** | **String** | The application name. This is how the application should be displayed to the user. |

View File

@@ -110,7 +110,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
ApplicationApi apiInstance = new ApplicationApi(); ApplicationApi apiInstance = new ApplicationApi();
Integer id = 56; // Integer | the application id Long id = 789L; // Long | the application id
try { try {
Void result = apiInstance.deleteApp(id); Void result = apiInstance.deleteApp(id);
System.out.println(result); System.out.println(result);
@@ -124,7 +124,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the application id | **id** | **Long**| the application id |
### Return type ### Return type
@@ -235,7 +235,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
ApplicationApi apiInstance = new ApplicationApi(); ApplicationApi apiInstance = new ApplicationApi();
Application body = new Application(); // Application | the application to update Application body = new Application(); // Application | the application to update
Integer id = 56; // Integer | the application id Long id = 789L; // Long | the application id
try { try {
Application result = apiInstance.updateApplication(body, id); Application result = apiInstance.updateApplication(body, id);
System.out.println(result); System.out.println(result);
@@ -250,7 +250,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**body** | [**Application**](Application.md)| the application to update | **body** | [**Application**](Application.md)| the application to update |
**id** | **Integer**| the application id | **id** | **Long**| the application id |
### Return type ### Return type
@@ -301,7 +301,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
ApplicationApi apiInstance = new ApplicationApi(); ApplicationApi apiInstance = new ApplicationApi();
File file = new File("/path/to/file.txt"); // File | the application image File file = new File("/path/to/file.txt"); // File | the application image
Integer id = 56; // Integer | the application id Long id = 789L; // Long | the application id
try { try {
Application result = apiInstance.uploadAppImage(file, id); Application result = apiInstance.uploadAppImage(file, id);
System.out.println(result); System.out.println(result);
@@ -316,7 +316,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**file** | **File**| the application image | **file** | **File**| the application image |
**id** | **Integer**| the application id | **id** | **Long**| the application id |
### Return type ### Return type

View File

@@ -4,7 +4,7 @@
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**id** | **Integer** | The client id. | **id** | **Long** | The client id. |
**name** | **String** | The client name. This is how the client should be displayed to the user. | **name** | **String** | The client name. This is how the client should be displayed to the user. |
**token** | **String** | The client token. Can be used as `clientToken`. See Authentication. | **token** | **String** | The client token. Can be used as `clientToken`. See Authentication. |

View File

@@ -7,6 +7,7 @@ Method | HTTP request | Description
[**createClient**](ClientApi.md#createClient) | **POST** client | Create a client. [**createClient**](ClientApi.md#createClient) | **POST** client | Create a client.
[**deleteClient**](ClientApi.md#deleteClient) | **DELETE** client/{id} | Delete a client. [**deleteClient**](ClientApi.md#deleteClient) | **DELETE** client/{id} | Delete a client.
[**getClients**](ClientApi.md#getClients) | **GET** client | Return all clients. [**getClients**](ClientApi.md#getClients) | **GET** client | Return all clients.
[**updateClient**](ClientApi.md#updateClient) | **PUT** client/{id} | Update a client.
<a name="createClient"></a> <a name="createClient"></a>
@@ -108,7 +109,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
ClientApi apiInstance = new ClientApi(); ClientApi apiInstance = new ClientApi();
Integer id = 56; // Integer | the client id Long id = 789L; // Long | the client id
try { try {
Void result = apiInstance.deleteClient(id); Void result = apiInstance.deleteClient(id);
System.out.println(result); System.out.println(result);
@@ -122,7 +123,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the client id | **id** | **Long**| the client id |
### Return type ### Return type
@@ -197,3 +198,69 @@ This endpoint does not need any parameter.
- **Content-Type**: application/json - **Content-Type**: application/json
- **Accept**: application/json - **Accept**: application/json
<a name="updateClient"></a>
# **updateClient**
> Client updateClient(body, id)
Update a client.
### Example
```java
// Import classes:
//import com.github.gotify.client.ApiClient;
//import com.github.gotify.client.ApiException;
//import com.github.gotify.client.Configuration;
//import com.github.gotify.client.auth.*;
//import com.github.gotify.client.api.ClientApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
// Configure API key authorization: clientTokenHeader
ApiKeyAuth clientTokenHeader = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenHeader");
clientTokenHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//clientTokenHeader.setApiKeyPrefix("Token");
// Configure API key authorization: clientTokenQuery
ApiKeyAuth clientTokenQuery = (ApiKeyAuth) defaultClient.getAuthentication("clientTokenQuery");
clientTokenQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//clientTokenQuery.setApiKeyPrefix("Token");
ClientApi apiInstance = new ClientApi();
Client body = new Client(); // Client | the client to update
Long id = 789L; // Long | the client id
try {
Client result = apiInstance.updateClient(body, id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ClientApi#updateClient");
e.printStackTrace();
}
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| the client to update |
**id** | **Long**| the client id |
### Return type
[**Client**](Client.md)
### Authorization
[basicAuth](../README.md#basicAuth), [clientTokenHeader](../README.md#clientTokenHeader), [clientTokenQuery](../README.md#clientTokenQuery)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

11
client/docs/Health.md Normal file
View File

@@ -0,0 +1,11 @@
# Health
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**database** | **String** | The health of the database connection. |
**health** | **String** | The health of the overall application. |

48
client/docs/HealthApi.md Normal file
View File

@@ -0,0 +1,48 @@
# HealthApi
All URIs are relative to *http://localhost*
Method | HTTP request | Description
------------- | ------------- | -------------
[**getHealth**](HealthApi.md#getHealth) | **GET** health | Get health information.
<a name="getHealth"></a>
# **getHealth**
> Health getHealth()
Get health information.
### Example
```java
// Import classes:
//import com.github.gotify.client.ApiException;
//import com.github.gotify.client.api.HealthApi;
HealthApi apiInstance = new HealthApi();
try {
Health result = apiInstance.getHealth();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling HealthApi#getHealth");
e.printStackTrace();
}
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**Health**](Health.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -4,11 +4,11 @@
## Properties ## Properties
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**appid** | **Integer** | The application id that send this message. | **appid** | **Long** | The application id that send this message. |
**date** | [**OffsetDateTime**](OffsetDateTime.md) | The date the message was created. | **date** | [**OffsetDateTime**](OffsetDateTime.md) | The date the message was created. |
**extras** | **Map&lt;String, Object&gt;** | The extra data sent along the message. The extra fields are stored in a key-value scheme. Only accepted in CreateMessage requests with application/json content-type. The keys should be in the following format: &amp;lt;top-namespace&amp;gt;::[&amp;lt;sub-namespace&amp;gt;::]&amp;lt;action&amp;gt; These namespaces are reserved and might be used in the official clients: gotify android ios web server client. Do not use them for other purposes. | [optional] **extras** | **Map&lt;String, Object&gt;** | The extra data sent along the message. The extra fields are stored in a key-value scheme. Only accepted in CreateMessage requests with application/json content-type. The keys should be in the following format: &amp;lt;top-namespace&amp;gt;::[&amp;lt;sub-namespace&amp;gt;::]&amp;lt;action&amp;gt; These namespaces are reserved and might be used in the official clients: gotify android ios web server client. Do not use them for other purposes. | [optional]
**id** | **Integer** | The message id. | **id** | **Long** | The message id. |
**message** | **String** | The actual message. | **message** | **String** | The message. Markdown (excluding html) is allowed. |
**priority** | **Long** | The priority of the message. | [optional] **priority** | **Long** | The priority of the message. | [optional]
**title** | **String** | The title of the message. | [optional] **title** | **String** | The title of the message. | [optional]

View File

@@ -109,7 +109,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
MessageApi apiInstance = new MessageApi(); MessageApi apiInstance = new MessageApi();
Integer id = 56; // Integer | the application id Long id = 789L; // Long | the application id
try { try {
Void result = apiInstance.deleteAppMessages(id); Void result = apiInstance.deleteAppMessages(id);
System.out.println(result); System.out.println(result);
@@ -123,7 +123,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the application id | **id** | **Long**| the application id |
### Return type ### Return type
@@ -173,7 +173,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
MessageApi apiInstance = new MessageApi(); MessageApi apiInstance = new MessageApi();
Integer id = 56; // Integer | the message id Long id = 789L; // Long | the message id
try { try {
Void result = apiInstance.deleteMessage(id); Void result = apiInstance.deleteMessage(id);
System.out.println(result); System.out.println(result);
@@ -187,7 +187,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the message id | **id** | **Long**| the message id |
### Return type ### Return type
@@ -297,9 +297,9 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
MessageApi apiInstance = new MessageApi(); MessageApi apiInstance = new MessageApi();
Integer id = 56; // Integer | the application id Long id = 789L; // Long | the application id
Integer limit = 100; // Integer | the maximal amount of messages to return Integer limit = 100; // Integer | the maximal amount of messages to return
Integer since = 56; // Integer | return all messages with an ID less than this value Long since = 789L; // Long | return all messages with an ID less than this value
try { try {
PagedMessages result = apiInstance.getAppMessages(id, limit, since); PagedMessages result = apiInstance.getAppMessages(id, limit, since);
System.out.println(result); System.out.println(result);
@@ -313,9 +313,9 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the application id | **id** | **Long**| the application id |
**limit** | **Integer**| the maximal amount of messages to return | [optional] [default to 100] **limit** | **Integer**| the maximal amount of messages to return | [optional] [default to 100]
**since** | **Integer**| return all messages with an ID less than this value | [optional] **since** | **Long**| return all messages with an ID less than this value | [optional]
### Return type ### Return type
@@ -366,7 +366,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
MessageApi apiInstance = new MessageApi(); MessageApi apiInstance = new MessageApi();
Integer limit = 100; // Integer | the maximal amount of messages to return Integer limit = 100; // Integer | the maximal amount of messages to return
Integer since = 56; // Integer | return all messages with an ID less than this value Long since = 789L; // Long | return all messages with an ID less than this value
try { try {
PagedMessages result = apiInstance.getMessages(limit, since); PagedMessages result = apiInstance.getMessages(limit, since);
System.out.println(result); System.out.println(result);
@@ -381,7 +381,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**limit** | **Integer**| the maximal amount of messages to return | [optional] [default to 100] **limit** | **Integer**| the maximal amount of messages to return | [optional] [default to 100]
**since** | **Integer**| return all messages with an ID less than this value | [optional] **since** | **Long**| return all messages with an ID less than this value | [optional]
### Return type ### Return type

View File

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**limit** | **Long** | The limit of the messages for the current request. | **limit** | **Long** | The limit of the messages for the current request. |
**next** | **String** | The request url for the next page. Empty/Null when no next page is available. | [optional] **next** | **String** | The request url for the next page. Empty/Null when no next page is available. | [optional]
**since** | **Integer** | The ID of the last message returned in the current request. Use this as alternative to the next link. | **since** | **Long** | The ID of the last message returned in the current request. Use this as alternative to the next link. |
**size** | **Long** | The amount of messages that got returned in the current request. | **size** | **Long** | The amount of messages that got returned in the current request. |

View File

@@ -47,7 +47,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
PluginApi apiInstance = new PluginApi(); PluginApi apiInstance = new PluginApi();
Integer id = 56; // Integer | the plugin id Long id = 789L; // Long | the plugin id
try { try {
Void result = apiInstance.disablePlugin(id); Void result = apiInstance.disablePlugin(id);
System.out.println(result); System.out.println(result);
@@ -61,7 +61,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the plugin id | **id** | **Long**| the plugin id |
### Return type ### Return type
@@ -111,7 +111,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
PluginApi apiInstance = new PluginApi(); PluginApi apiInstance = new PluginApi();
Integer id = 56; // Integer | the plugin id Long id = 789L; // Long | the plugin id
try { try {
Void result = apiInstance.enablePlugin(id); Void result = apiInstance.enablePlugin(id);
System.out.println(result); System.out.println(result);
@@ -125,7 +125,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the plugin id | **id** | **Long**| the plugin id |
### Return type ### Return type
@@ -175,7 +175,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
PluginApi apiInstance = new PluginApi(); PluginApi apiInstance = new PluginApi();
Integer id = 56; // Integer | the plugin id Long id = 789L; // Long | the plugin id
try { try {
Object result = apiInstance.getPluginConfig(id); Object result = apiInstance.getPluginConfig(id);
System.out.println(result); System.out.println(result);
@@ -189,7 +189,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the plugin id | **id** | **Long**| the plugin id |
### Return type ### Return type
@@ -239,7 +239,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
PluginApi apiInstance = new PluginApi(); PluginApi apiInstance = new PluginApi();
Integer id = 56; // Integer | the plugin id Long id = 789L; // Long | the plugin id
try { try {
String result = apiInstance.getPluginDisplay(id); String result = apiInstance.getPluginDisplay(id);
System.out.println(result); System.out.println(result);
@@ -253,7 +253,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the plugin id | **id** | **Long**| the plugin id |
### Return type ### Return type
@@ -363,7 +363,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
PluginApi apiInstance = new PluginApi(); PluginApi apiInstance = new PluginApi();
Integer id = 56; // Integer | the plugin id Long id = 789L; // Long | the plugin id
try { try {
Void result = apiInstance.updatePluginConfig(id); Void result = apiInstance.updatePluginConfig(id);
System.out.println(result); System.out.println(result);
@@ -377,7 +377,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the plugin id | **id** | **Long**| the plugin id |
### Return type ### Return type

View File

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
**author** | **String** | The author of the plugin. | [optional] **author** | **String** | The author of the plugin. | [optional]
**capabilities** | **List&lt;String&gt;** | Capabilities the plugin provides | **capabilities** | **List&lt;String&gt;** | Capabilities the plugin provides |
**enabled** | **Boolean** | Whether the plugin instance is enabled. | **enabled** | **Boolean** | Whether the plugin instance is enabled. |
**id** | **Integer** | The plugin id. | **id** | **Long** | The plugin id. |
**license** | **String** | The license of the plugin. | [optional] **license** | **String** | The license of the plugin. | [optional]
**modulePath** | **String** | The module path of the plugin. | **modulePath** | **String** | The module path of the plugin. |
**name** | **String** | The plugin name. | **name** | **String** | The plugin name. |

View File

@@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**admin** | **Boolean** | If the user is an administrator. | [optional] **admin** | **Boolean** | If the user is an administrator. | [optional]
**id** | **Integer** | The user id. | **id** | **Long** | The user id. |
**name** | **String** | The user name. For login. | **name** | **String** | The user name. For login. |

View File

@@ -172,7 +172,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi(); UserApi apiInstance = new UserApi();
Integer id = 56; // Integer | the user id Long id = 789L; // Long | the user id
try { try {
Void result = apiInstance.deleteUser(id); Void result = apiInstance.deleteUser(id);
System.out.println(result); System.out.println(result);
@@ -186,7 +186,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the user id | **id** | **Long**| the user id |
### Return type ### Return type
@@ -236,7 +236,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi(); UserApi apiInstance = new UserApi();
Integer id = 56; // Integer | the user id Long id = 789L; // Long | the user id
try { try {
User result = apiInstance.getUser(id); User result = apiInstance.getUser(id);
System.out.println(result); System.out.println(result);
@@ -250,7 +250,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the user id | **id** | **Long**| the user id |
### Return type ### Return type
@@ -424,7 +424,7 @@ clientTokenQuery.setApiKey("YOUR API KEY");
//clientTokenQuery.setApiKeyPrefix("Token"); //clientTokenQuery.setApiKeyPrefix("Token");
UserApi apiInstance = new UserApi(); UserApi apiInstance = new UserApi();
Integer id = 56; // Integer | the user id Long id = 789L; // Long | the user id
UserWithPass body = new UserWithPass(); // UserWithPass | the updated user UserWithPass body = new UserWithPass(); // UserWithPass | the updated user
try { try {
User result = apiInstance.updateUser(id, body); User result = apiInstance.updateUser(id, body);
@@ -439,7 +439,7 @@ try {
Name | Type | Description | Notes Name | Type | Description | Notes
------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | -------------
**id** | **Integer**| the user id | **id** | **Long**| the user id |
**body** | [**UserWithPass**](UserWithPass.md)| the updated user | **body** | [**UserWithPass**](UserWithPass.md)| the updated user |
### Return type ### Return type

View File

@@ -5,7 +5,7 @@
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**admin** | **Boolean** | If the user is an administrator. | [optional] **admin** | **Boolean** | If the user is an administrator. | [optional]
**id** | **Integer** | The user id. | **id** | **Long** | The user id. |
**name** | **String** | The user name. For login. | **name** | **String** | The user name. For login. |
**pass** | **String** | The user password. For login. | **pass** | **String** | The user password. For login. |

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -13,7 +13,7 @@
package com.github.gotify.client; package com.github.gotify.client;
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class StringUtil { public class StringUtil {
/** /**
* Check if the given array contains the given value (with case-insensitive comparison). * Check if the given array contains the given value (with case-insensitive comparison).

View File

@@ -43,7 +43,7 @@ public interface ApplicationApi {
}) })
@DELETE("application/{id}") @DELETE("application/{id}")
Call<Void> deleteApp( Call<Void> deleteApp(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -70,7 +70,7 @@ public interface ApplicationApi {
}) })
@PUT("application/{id}") @PUT("application/{id}")
Call<Application> updateApplication( Call<Application> updateApplication(
@retrofit2.http.Body Application body, @retrofit2.http.Path("id") Integer id @retrofit2.http.Body Application body, @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -83,7 +83,7 @@ public interface ApplicationApi {
@retrofit2.http.Multipart @retrofit2.http.Multipart
@POST("application/{id}/image") @POST("application/{id}/image")
Call<Application> uploadAppImage( Call<Application> uploadAppImage(
@retrofit2.http.Part("file\"; filename=\"file") RequestBody file, @retrofit2.http.Path("id") Integer id @retrofit2.http.Part("file\"; filename=\"file") RequestBody file, @retrofit2.http.Path("id") Long id
); );
} }

View File

@@ -42,7 +42,7 @@ public interface ClientApi {
}) })
@DELETE("client/{id}") @DELETE("client/{id}")
Call<Void> deleteClient( Call<Void> deleteClient(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -57,4 +57,19 @@ public interface ClientApi {
Call<List<Client>> getClients(); Call<List<Client>> getClients();
/**
* Update a client.
*
* @param body the client to update (required)
* @param id the client id (required)
* @return Call&lt;Client&gt;
*/
@Headers({
"Content-Type:application/json"
})
@PUT("client/{id}")
Call<Client> updateClient(
@retrofit2.http.Body Client body, @retrofit2.http.Path("id") Long id
);
} }

View File

@@ -0,0 +1,31 @@
package com.github.gotify.client.api;
import com.github.gotify.client.CollectionFormats.*;
import retrofit2.Call;
import retrofit2.http.*;
import okhttp3.RequestBody;
import okhttp3.ResponseBody;
import com.github.gotify.client.model.Health;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public interface HealthApi {
/**
* Get health information.
*
* @return Call&lt;Health&gt;
*/
@Headers({
"Content-Type:application/json"
})
@GET("health")
Call<Health> getHealth();
}

View File

@@ -43,7 +43,7 @@ public interface MessageApi {
}) })
@DELETE("application/{id}/message") @DELETE("application/{id}/message")
Call<Void> deleteAppMessages( Call<Void> deleteAppMessages(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -57,7 +57,7 @@ public interface MessageApi {
}) })
@DELETE("message/{id}") @DELETE("message/{id}")
Call<Void> deleteMessage( Call<Void> deleteMessage(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -85,7 +85,7 @@ public interface MessageApi {
}) })
@GET("application/{id}/message") @GET("application/{id}/message")
Call<PagedMessages> getAppMessages( Call<PagedMessages> getAppMessages(
@retrofit2.http.Path("id") Integer id, @retrofit2.http.Query("limit") Integer limit, @retrofit2.http.Query("since") Integer since @retrofit2.http.Path("id") Long id, @retrofit2.http.Query("limit") Integer limit, @retrofit2.http.Query("since") Long since
); );
/** /**
@@ -100,7 +100,7 @@ public interface MessageApi {
}) })
@GET("message") @GET("message")
Call<PagedMessages> getMessages( Call<PagedMessages> getMessages(
@retrofit2.http.Query("limit") Integer limit, @retrofit2.http.Query("since") Integer since @retrofit2.http.Query("limit") Integer limit, @retrofit2.http.Query("since") Long since
); );
/** /**

View File

@@ -28,7 +28,7 @@ public interface PluginApi {
}) })
@POST("plugin/{id}/disable") @POST("plugin/{id}/disable")
Call<Void> disablePlugin( Call<Void> disablePlugin(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -42,7 +42,7 @@ public interface PluginApi {
}) })
@POST("plugin/{id}/enable") @POST("plugin/{id}/enable")
Call<Void> enablePlugin( Call<Void> enablePlugin(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -56,7 +56,7 @@ public interface PluginApi {
}) })
@GET("plugin/{id}/config") @GET("plugin/{id}/config")
Call<Object> getPluginConfig( Call<Object> getPluginConfig(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -70,7 +70,7 @@ public interface PluginApi {
}) })
@GET("plugin/{id}/display") @GET("plugin/{id}/display")
Call<String> getPluginDisplay( Call<String> getPluginDisplay(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -96,7 +96,7 @@ public interface PluginApi {
}) })
@POST("plugin/{id}/config") @POST("plugin/{id}/config")
Call<Void> updatePluginConfig( Call<Void> updatePluginConfig(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
} }

View File

@@ -56,7 +56,7 @@ public interface UserApi {
}) })
@DELETE("user/{id}") @DELETE("user/{id}")
Call<Void> deleteUser( Call<Void> deleteUser(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -70,7 +70,7 @@ public interface UserApi {
}) })
@GET("user/{id}") @GET("user/{id}")
Call<User> getUser( Call<User> getUser(
@retrofit2.http.Path("id") Integer id @retrofit2.http.Path("id") Long id
); );
/** /**
@@ -111,7 +111,7 @@ public interface UserApi {
}) })
@POST("user/{id}") @POST("user/{id}")
Call<User> updateUser( Call<User> updateUser(
@retrofit2.http.Path("id") Integer id, @retrofit2.http.Body UserWithPass body @retrofit2.http.Path("id") Long id, @retrofit2.http.Body UserWithPass body
); );
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,13 +27,13 @@ import java.io.IOException;
* The Application holds information about an app which can send notifications. * The Application holds information about an app which can send notifications.
*/ */
@ApiModel(description = "The Application holds information about an app which can send notifications.") @ApiModel(description = "The Application holds information about an app which can send notifications.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Application { public class Application {
@SerializedName("description") @SerializedName("description")
private String description = null; private String description = null;
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("image") @SerializedName("image")
private String image = null; private String image = null;
@@ -70,7 +70,7 @@ public class Application {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "5", required = true, value = "The application id.") @ApiModelProperty(example = "5", required = true, value = "The application id.")
public Integer getId() { public Long getId() {
return id; return id;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,10 +27,10 @@ import java.io.IOException;
* The Client holds information about a device which can receive notifications (and other stuff). * The Client holds information about a device which can receive notifications (and other stuff).
*/ */
@ApiModel(description = "The Client holds information about a device which can receive notifications (and other stuff).") @ApiModel(description = "The Client holds information about a device which can receive notifications (and other stuff).")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Client { public class Client {
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("name") @SerializedName("name")
private String name = null; private String name = null;
@@ -43,7 +43,7 @@ public class Client {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "5", required = true, value = "The client id.") @ApiModelProperty(example = "5", required = true, value = "The client id.")
public Integer getId() { public Long getId() {
return id; return id;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,7 +27,7 @@ import java.io.IOException;
* The Error contains error relevant information. * The Error contains error relevant information.
*/ */
@ApiModel(description = "The Error contains error relevant information.") @ApiModel(description = "The Error contains error relevant information.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Error { public class Error {
@SerializedName("error") @SerializedName("error")
private String error = null; private String error = null;

View File

@@ -0,0 +1,117 @@
/*
* Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
*
* OpenAPI spec version: 2.0.1
*
*
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen.git
* Do not edit the class manually.
*/
package com.github.gotify.client.model;
import java.util.Objects;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
/**
* Health represents how healthy the application is.
*/
@ApiModel(description = "Health represents how healthy the application is.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Health {
@SerializedName("database")
private String database = null;
@SerializedName("health")
private String health = null;
public Health database(String database) {
this.database = database;
return this;
}
/**
* The health of the database connection.
* @return database
**/
@ApiModelProperty(example = "green", required = true, value = "The health of the database connection.")
public String getDatabase() {
return database;
}
public void setDatabase(String database) {
this.database = database;
}
public Health health(String health) {
this.health = health;
return this;
}
/**
* The health of the overall application.
* @return health
**/
@ApiModelProperty(example = "green", required = true, value = "The health of the overall application.")
public String getHealth() {
return health;
}
public void setHealth(String health) {
this.health = health;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Health health = (Health) o;
return Objects.equals(this.database, health.database) &&
Objects.equals(this.health, health.health);
}
@Override
public int hashCode() {
return Objects.hash(database, health);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Health {\n");
sb.append(" database: ").append(toIndentedString(database)).append("\n");
sb.append(" health: ").append(toIndentedString(health)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -31,10 +31,10 @@ import org.threeten.bp.OffsetDateTime;
* The MessageExternal holds information about a message which was sent by an Application. * The MessageExternal holds information about a message which was sent by an Application.
*/ */
@ApiModel(description = "The MessageExternal holds information about a message which was sent by an Application.") @ApiModel(description = "The MessageExternal holds information about a message which was sent by an Application.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Message { public class Message {
@SerializedName("appid") @SerializedName("appid")
private Integer appid = null; private Long appid = null;
@SerializedName("date") @SerializedName("date")
private OffsetDateTime date = null; private OffsetDateTime date = null;
@@ -43,7 +43,7 @@ public class Message {
private Map<String, Object> extras = null; private Map<String, Object> extras = null;
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("message") @SerializedName("message")
private String message = null; private String message = null;
@@ -59,7 +59,7 @@ public class Message {
* @return appid * @return appid
**/ **/
@ApiModelProperty(example = "5", required = true, value = "The application id that send this message.") @ApiModelProperty(example = "5", required = true, value = "The application id that send this message.")
public Integer getAppid() { public Long getAppid() {
return appid; return appid;
} }
@@ -103,7 +103,7 @@ public class Message {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "25", required = true, value = "The message id.") @ApiModelProperty(example = "25", required = true, value = "The message id.")
public Integer getId() { public Long getId() {
return id; return id;
} }
@@ -113,10 +113,10 @@ public class Message {
} }
/** /**
* The actual message. * The message. Markdown (excluding html) is allowed.
* @return message * @return message
**/ **/
@ApiModelProperty(example = "Backup was successfully finished.", required = true, value = "The actual message.") @ApiModelProperty(example = "**Backup** was successfully finished.", required = true, value = "The message. Markdown (excluding html) is allowed.")
public String getMessage() { public String getMessage() {
return message; return message;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -31,7 +31,7 @@ import java.util.List;
* Wrapper for the paging and the messages * Wrapper for the paging and the messages
*/ */
@ApiModel(description = "Wrapper for the paging and the messages") @ApiModel(description = "Wrapper for the paging and the messages")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class PagedMessages { public class PagedMessages {
@SerializedName("messages") @SerializedName("messages")
private List<Message> messages = new ArrayList<Message>(); private List<Message> messages = new ArrayList<Message>();

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -24,10 +24,10 @@ import io.swagger.annotations.ApiModelProperty;
import java.io.IOException; import java.io.IOException;
/** /**
* The Paging holds holds information about the limit and making requests to the next page. * The Paging holds information about the limit and making requests to the next page.
*/ */
@ApiModel(description = "The Paging holds holds information about the limit and making requests to the next page.") @ApiModel(description = "The Paging holds information about the limit and making requests to the next page.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class Paging { public class Paging {
@SerializedName("limit") @SerializedName("limit")
private Long limit = null; private Long limit = null;
@@ -36,7 +36,7 @@ public class Paging {
private String next = null; private String next = null;
@SerializedName("since") @SerializedName("since")
private Integer since = null; private Long since = null;
@SerializedName("size") @SerializedName("size")
private Long size = null; private Long size = null;
@@ -67,7 +67,7 @@ public class Paging {
* @return since * @return since
**/ **/
@ApiModelProperty(example = "5", required = true, value = "The ID of the last message returned in the current request. Use this as alternative to the next link.") @ApiModelProperty(example = "5", required = true, value = "The ID of the last message returned in the current request. Use this as alternative to the next link.")
public Integer getSince() { public Long getSince() {
return since; return since;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -29,7 +29,7 @@ import java.util.List;
* Holds information about a plugin instance for one user. * Holds information about a plugin instance for one user.
*/ */
@ApiModel(description = "Holds information about a plugin instance for one user.") @ApiModel(description = "Holds information about a plugin instance for one user.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class PluginConf { public class PluginConf {
@SerializedName("author") @SerializedName("author")
private String author = null; private String author = null;
@@ -41,7 +41,7 @@ public class PluginConf {
private Boolean enabled = null; private Boolean enabled = null;
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("license") @SerializedName("license")
private String license = null; private String license = null;
@@ -113,7 +113,7 @@ public class PluginConf {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "25", required = true, value = "The plugin id.") @ApiModelProperty(example = "25", required = true, value = "The plugin id.")
public Integer getId() { public Long getId() {
return id; return id;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,13 +27,13 @@ import java.io.IOException;
* The User holds information about permission and other stuff. * The User holds information about permission and other stuff.
*/ */
@ApiModel(description = "The User holds information about permission and other stuff.") @ApiModel(description = "The User holds information about permission and other stuff.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class User { public class User {
@SerializedName("admin") @SerializedName("admin")
private Boolean admin = null; private Boolean admin = null;
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("name") @SerializedName("name")
private String name = null; private String name = null;
@@ -61,7 +61,7 @@ public class User {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "25", required = true, value = "The user id.") @ApiModelProperty(example = "25", required = true, value = "The user id.")
public Integer getId() { public Long getId() {
return id; return id;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,7 +27,7 @@ import java.io.IOException;
* The Password for updating the user. * The Password for updating the user.
*/ */
@ApiModel(description = "The Password for updating the user.") @ApiModel(description = "The Password for updating the user.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class UserPass { public class UserPass {
@SerializedName("pass") @SerializedName("pass")
private String pass = null; private String pass = null;

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,13 +27,13 @@ import java.io.IOException;
* The UserWithPass holds information about the credentials and other stuff. * The UserWithPass holds information about the credentials and other stuff.
*/ */
@ApiModel(description = "The UserWithPass holds information about the credentials and other stuff.") @ApiModel(description = "The UserWithPass holds information about the credentials and other stuff.")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class UserWithPass { public class UserWithPass {
@SerializedName("admin") @SerializedName("admin")
private Boolean admin = null; private Boolean admin = null;
@SerializedName("id") @SerializedName("id")
private Integer id = null; private Long id = null;
@SerializedName("name") @SerializedName("name")
private String name = null; private String name = null;
@@ -64,7 +64,7 @@ public class UserWithPass {
* @return id * @return id
**/ **/
@ApiModelProperty(example = "25", required = true, value = "The user id.") @ApiModelProperty(example = "25", required = true, value = "The user id.")
public Integer getId() { public Long getId() {
return id; return id;
} }

View File

@@ -2,7 +2,7 @@
* Gotify REST-API. * Gotify REST-API.
* This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues) * This is the documentation of the Gotify REST-API. # Authentication In Gotify there are two token types: __clientToken__: a client is something that receives message and manages stuff like creating new tokens or delete messages. (f.ex this token should be used for an android app) __appToken__: an application is something that sends messages (f.ex. this token should be used for a shell script) The token can be either transmitted through a header named `X-Gotify-Key` or a query parameter named `token`. There is also the possibility to authenticate through basic auth, this should only be used for creating a clientToken. \\--- Found a bug or have some questions? [Create an issue on GitHub](https://github.com/gotify/server/issues)
* *
* OpenAPI spec version: 1.0.6 * OpenAPI spec version: 2.0.1
* *
* *
* NOTE: This class is auto generated by the swagger code generator program. * NOTE: This class is auto generated by the swagger code generator program.
@@ -27,7 +27,7 @@ import java.io.IOException;
* VersionInfo Model * VersionInfo Model
*/ */
@ApiModel(description = "VersionInfo Model") @ApiModel(description = "VersionInfo Model")
@javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2019-02-17T19:42:51.206+01:00") @javax.annotation.Generated(value = "io.swagger.codegen.languages.JavaClientCodegen", date = "2020-06-24T18:39:01.386+02:00")
public class VersionInfo { public class VersionInfo {
@SerializedName("buildDate") @SerializedName("buildDate")
private String buildDate = null; private String buildDate = null;

View File

@@ -43,7 +43,7 @@ public class ApplicationApiTest {
*/ */
@Test @Test
public void deleteAppTest() { public void deleteAppTest() {
Integer id = null; Long id = null;
// Void response = api.deleteApp(id); // Void response = api.deleteApp(id);
// TODO: test validations // TODO: test validations
@@ -67,7 +67,7 @@ public class ApplicationApiTest {
@Test @Test
public void updateApplicationTest() { public void updateApplicationTest() {
Application body = null; Application body = null;
Integer id = null; Long id = null;
// Application response = api.updateApplication(body, id); // Application response = api.updateApplication(body, id);
// TODO: test validations // TODO: test validations
@@ -80,7 +80,7 @@ public class ApplicationApiTest {
@Test @Test
public void uploadAppImageTest() { public void uploadAppImageTest() {
File file = null; File file = null;
Integer id = null; Long id = null;
// Application response = api.uploadAppImage(file, id); // Application response = api.uploadAppImage(file, id);
// TODO: test validations // TODO: test validations

View File

@@ -42,7 +42,7 @@ public class ClientApiTest {
*/ */
@Test @Test
public void deleteClientTest() { public void deleteClientTest() {
Integer id = null; Long id = null;
// Void response = api.deleteClient(id); // Void response = api.deleteClient(id);
// TODO: test validations // TODO: test validations
@@ -56,6 +56,19 @@ public class ClientApiTest {
public void getClientsTest() { public void getClientsTest() {
// List<Client> response = api.getClients(); // List<Client> response = api.getClients();
// TODO: test validations
}
/**
* Update a client.
*
*
*/
@Test
public void updateClientTest() {
Client body = null;
Long id = null;
// Client response = api.updateClient(body, id);
// TODO: test validations // TODO: test validations
} }
} }

View File

@@ -0,0 +1,36 @@
package com.github.gotify.client.api;
import com.github.gotify.client.ApiClient;
import com.github.gotify.client.model.Health;
import org.junit.Before;
import org.junit.Test;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* API tests for HealthApi
*/
public class HealthApiTest {
private HealthApi api;
@Before
public void setup() {
api = new ApiClient().createService(HealthApi.class);
}
/**
* Get health information.
*
*
*/
@Test
public void getHealthTest() {
// Health response = api.getHealth();
// TODO: test validations
}
}

View File

@@ -43,7 +43,7 @@ public class MessageApiTest {
*/ */
@Test @Test
public void deleteAppMessagesTest() { public void deleteAppMessagesTest() {
Integer id = null; Long id = null;
// Void response = api.deleteAppMessages(id); // Void response = api.deleteAppMessages(id);
// TODO: test validations // TODO: test validations
@@ -55,7 +55,7 @@ public class MessageApiTest {
*/ */
@Test @Test
public void deleteMessageTest() { public void deleteMessageTest() {
Integer id = null; Long id = null;
// Void response = api.deleteMessage(id); // Void response = api.deleteMessage(id);
// TODO: test validations // TODO: test validations
@@ -78,9 +78,9 @@ public class MessageApiTest {
*/ */
@Test @Test
public void getAppMessagesTest() { public void getAppMessagesTest() {
Integer id = null; Long id = null;
Integer limit = null; Integer limit = null;
Integer since = null; Long since = null;
// PagedMessages response = api.getAppMessages(id, limit, since); // PagedMessages response = api.getAppMessages(id, limit, since);
// TODO: test validations // TODO: test validations
@@ -93,7 +93,7 @@ public class MessageApiTest {
@Test @Test
public void getMessagesTest() { public void getMessagesTest() {
Integer limit = null; Integer limit = null;
Integer since = null; Long since = null;
// PagedMessages response = api.getMessages(limit, since); // PagedMessages response = api.getMessages(limit, since);
// TODO: test validations // TODO: test validations

View File

@@ -30,7 +30,7 @@ public class PluginApiTest {
*/ */
@Test @Test
public void disablePluginTest() { public void disablePluginTest() {
Integer id = null; Long id = null;
// Void response = api.disablePlugin(id); // Void response = api.disablePlugin(id);
// TODO: test validations // TODO: test validations
@@ -42,7 +42,7 @@ public class PluginApiTest {
*/ */
@Test @Test
public void enablePluginTest() { public void enablePluginTest() {
Integer id = null; Long id = null;
// Void response = api.enablePlugin(id); // Void response = api.enablePlugin(id);
// TODO: test validations // TODO: test validations
@@ -54,7 +54,7 @@ public class PluginApiTest {
*/ */
@Test @Test
public void getPluginConfigTest() { public void getPluginConfigTest() {
Integer id = null; Long id = null;
// Object response = api.getPluginConfig(id); // Object response = api.getPluginConfig(id);
// TODO: test validations // TODO: test validations
@@ -66,7 +66,7 @@ public class PluginApiTest {
*/ */
@Test @Test
public void getPluginDisplayTest() { public void getPluginDisplayTest() {
Integer id = null; Long id = null;
// String response = api.getPluginDisplay(id); // String response = api.getPluginDisplay(id);
// TODO: test validations // TODO: test validations
@@ -89,7 +89,7 @@ public class PluginApiTest {
*/ */
@Test @Test
public void updatePluginConfigTest() { public void updatePluginConfigTest() {
Integer id = null; Long id = null;
// Void response = api.updatePluginConfig(id); // Void response = api.updatePluginConfig(id);
// TODO: test validations // TODO: test validations

View File

@@ -55,7 +55,7 @@ public class UserApiTest {
*/ */
@Test @Test
public void deleteUserTest() { public void deleteUserTest() {
Integer id = null; Long id = null;
// Void response = api.deleteUser(id); // Void response = api.deleteUser(id);
// TODO: test validations // TODO: test validations
@@ -67,7 +67,7 @@ public class UserApiTest {
*/ */
@Test @Test
public void getUserTest() { public void getUserTest() {
Integer id = null; Long id = null;
// User response = api.getUser(id); // User response = api.getUser(id);
// TODO: test validations // TODO: test validations
@@ -102,7 +102,7 @@ public class UserApiTest {
*/ */
@Test @Test
public void updateUserTest() { public void updateUserTest() {
Integer id = null; Long id = null;
UserWithPass body = null; UserWithPass body = null;
// User response = api.updateUser(id, body); // User response = api.updateUser(id, body);