Skip to content

Commit 9b17d59

Browse files
committed
Rerun with openapi-generator on v7.17.0
1 parent 58cfefc commit 9b17d59

File tree

80 files changed

+2447
-3819
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+2447
-3819
lines changed

docs/Api/MiscApi.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\MiscApi
22

3+
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |
@@ -11,13 +13,13 @@ All URIs are relative to https://api.modrinth.com/v2, except if the operation de
1113
## `forgeUpdates()`
1214

1315
```php
14-
forgeUpdates($id_slug): \Aternos\ModrinthApi\Model\ForgeUpdates
16+
forgeUpdates($id_slug, $neoforge): \Aternos\ModrinthApi\Model\ForgeUpdates
1517
```
1618
### URI(s):
1719
- https://api.modrinth.com Production server- https://staging-api.modrinth.com Staging server
1820
Forge Updates JSON file
1921

20-
If you're a Forge mod developer, your Modrinth mods have an automatically generated `updates.json` using the [Forge Update Checker](https://docs.minecraftforge.net/en/latest/misc/updatechecker/). The only setup is to insert the URL into the `[[mods]]` section of your `mods.toml` file as such: ```toml [[mods]] # the other stuff here - ID, version, display name, etc. updateJSONURL = \"https://api.modrinth.com/updates/{slug|ID}/forge_updates.json\" ``` Replace `{slug|id}` with the slug or ID of your project. Modrinth will handle the rest! When you update your mod, Forge will notify your users that their copy of your mod is out of date. Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your `mods.toml`. If you use a format such as `1.2.3-forge` or `1.2.3+1.19` with your Modrinth releases but your `mods.toml` only has `1.2.3`, the update checker may not function properly.
22+
If you're a Forge mod developer, your Modrinth mods have an automatically generated `updates.json` using the [Forge Update Checker](https://docs.minecraftforge.net/en/latest/misc/updatechecker/). The only setup is to insert the URL into the `[[mods]]` section of your `mods.toml` file as such: ```toml [[mods]] # the other stuff here - ID, version, display name, etc. updateJSONURL = \"https://api.modrinth.com/updates/{slug|ID}/forge_updates.json\" ``` Replace `{slug|id}` with the slug or ID of your project. Modrinth will handle the rest! When you update your mod, Forge will notify your users that their copy of your mod is out of date. Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your `mods.toml`. If you use a format such as `1.2.3-forge` or `1.2.3+1.19` with your Modrinth releases but your `mods.toml` only has `1.2.3`, the update checker may not function properly. If you're using NeoForge, NeoForge versions will, by default, not appear in the default URL. You will need to add `?neoforge=only` to show your NeoForge-only versions, or `?neoforge=include` for both. ```toml [[mods]] # the other stuff here - ID, version, display name, etc. updateJSONURL = \"https://api.modrinth.com/updates/{slug|ID}/forge_updates.json?neoforge=only\" ```
2123

2224
### Example
2325

@@ -33,13 +35,14 @@ $apiInstance = new Aternos\ModrinthApi\Api\MiscApi(
3335
new GuzzleHttp\Client()
3436
);
3537
$id_slug = ["AABBCCDD","my_project"]; // string | The ID or slug of the project
38+
$neoforge = include; // string | Whether to include NeoForge versions. Can be `only` (NeoForge-only versions), `include` (both Forge and NeoForge versions), or omitted (Forge-only versions).
3639

3740
$hostIndex = 0;
3841
$variables = [
3942
];
4043

4144
try {
42-
$result = $apiInstance->forgeUpdates($id_slug, $hostIndex, $variables);
45+
$result = $apiInstance->forgeUpdates($id_slug, $neoforge, $hostIndex, $variables);
4346
print_r($result);
4447
} catch (Exception $e) {
4548
echo 'Exception when calling MiscApi->forgeUpdates: ', $e->getMessage(), PHP_EOL;
@@ -51,6 +54,7 @@ try {
5154
| Name | Type | Description | Notes |
5255
| ------------- | ------------- | ------------- | ------------- |
5356
| **id_slug** | **string**| The ID or slug of the project | |
57+
| **neoforge** | **string**| Whether to include NeoForge versions. Can be `only` (NeoForge-only versions), `include` (both Forge and NeoForge versions), or omitted (Forge-only versions). | [optional] |
5458
| hostIndex | null|int | Host index. Defaults to null. If null, then the library will use $this->hostIndex instead | [optional] |
5559
| variables | array | Associative array of variables to pass to the host. Defaults to empty array. | [optional] |
5660

docs/Api/NotificationsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\NotificationsApi
22

3+
Notifications are sent to users for various reasons, including for project updates, team invites, and moderation purposes.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Api/ProjectsApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\ProjectsApi
22

3+
Projects are what Modrinth is centered around, be it mods, modpacks, resource packs, etc.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |
@@ -1006,7 +1008,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\ProjectsApi(
10061008
new GuzzleHttp\Client()
10071009
);
10081010
$query = gravestones; // string | The query to search for
1009-
$facets = [["categories:forge"],["versions:1.17.1"],["project_type:mod"],["license:mit"]]; // string | Facets are an essential concept for understanding how to filter out results. These are the most commonly used facet types: - `project_type` - `categories` (loaders are lumped in with categories in search) - `versions` - `client_side` - `server_side` - `open_source` Several others are also available for use, though these should not be used outside very specific use cases. - `title` - `author` - `follows` - `project_id` - `license` - `downloads` - `color` - `created_timestamp` - `modified_timestamp` In order to then use these facets, you need a value to filter by, as well as an operation to perform on this value. The most common operation is `:` (same as `=`), though you can also use `!=`, `>=`, `>`, `<=`, and `<`. Join together the type, operation, and value, and you've got your string. ``` {type} {operation} {value} ``` Examples: ``` categories = adventure versions != 1.20.1 downloads <= 100 ``` You then join these strings together in arrays to signal `AND` and `OR` operators. ##### OR All elements in a single array are considered to be joined by OR statements. For example, the search `[[\"versions:1.16.5\", \"versions:1.17.1\"]]` translates to `Projects that support 1.16.5 OR 1.17.1`. ##### AND Separate arrays are considered to be joined by AND statements. For example, the search `[[\"versions:1.16.5\"], [\"project_type:modpack\"]]` translates to `Projects that support 1.16.5 AND are modpacks`.
1011+
$facets = [["categories:forge"],["versions:1.17.1"],["project_type:mod"],["license:mit"]]; // string | Facets are an essential concept for understanding how to filter out results. These are the most commonly used facet types: - `project_type` - `categories` (loaders are lumped in with categories in search) - `versions` - `client_side` - `server_side` - `open_source` Several others are also available for use, though these should not be used outside very specific use cases. - `title` - `author` - `follows` - `project_id` - `license` - `downloads` - `color` - `created_timestamp` (uses Unix timestamp) - `modified_timestamp` (uses Unix timestamp) - `date_created` (uses ISO-8601 timestamp) - `date_modified` (uses ISO-8601 timestamp) In order to then use these facets, you need a value to filter by, as well as an operation to perform on this value. The most common operation is `:` (same as `=`), though you can also use `!=`, `>=`, `>`, `<=`, and `<`. Join together the type, operation, and value, and you've got your string. ``` {type} {operation} {value} ``` Examples: ``` categories = adventure versions != 1.20.1 downloads <= 100 ``` You then join these strings together in arrays to signal `AND` and `OR` operators. ##### OR All elements in a single array are considered to be joined by OR statements. For example, the search `[[\"versions:1.16.5\", \"versions:1.17.1\"]]` translates to `Projects that support 1.16.5 OR 1.17.1`. ##### AND Separate arrays are considered to be joined by AND statements. For example, the search `[[\"versions:1.16.5\"], [\"project_type:modpack\"]]` translates to `Projects that support 1.16.5 AND are modpacks`.
10101012
$index = downloads; // string | The sorting method used for sorting search results
10111013
$offset = 20; // int | The offset into the search. Skips this number of results
10121014
$limit = 20; // int | The number of results returned by the search
@@ -1024,7 +1026,7 @@ try {
10241026
| Name | Type | Description | Notes |
10251027
| ------------- | ------------- | ------------- | ------------- |
10261028
| **query** | **string**| The query to search for | [optional] |
1027-
| **facets** | **string**| Facets are an essential concept for understanding how to filter out results. These are the most commonly used facet types: - &#x60;project_type&#x60; - &#x60;categories&#x60; (loaders are lumped in with categories in search) - &#x60;versions&#x60; - &#x60;client_side&#x60; - &#x60;server_side&#x60; - &#x60;open_source&#x60; Several others are also available for use, though these should not be used outside very specific use cases. - &#x60;title&#x60; - &#x60;author&#x60; - &#x60;follows&#x60; - &#x60;project_id&#x60; - &#x60;license&#x60; - &#x60;downloads&#x60; - &#x60;color&#x60; - &#x60;created_timestamp&#x60; - &#x60;modified_timestamp&#x60; In order to then use these facets, you need a value to filter by, as well as an operation to perform on this value. The most common operation is &#x60;:&#x60; (same as &#x60;&#x3D;&#x60;), though you can also use &#x60;!&#x3D;&#x60;, &#x60;&gt;&#x3D;&#x60;, &#x60;&gt;&#x60;, &#x60;&lt;&#x3D;&#x60;, and &#x60;&lt;&#x60;. Join together the type, operation, and value, and you&#39;ve got your string. &#x60;&#x60;&#x60; {type} {operation} {value} &#x60;&#x60;&#x60; Examples: &#x60;&#x60;&#x60; categories &#x3D; adventure versions !&#x3D; 1.20.1 downloads &lt;&#x3D; 100 &#x60;&#x60;&#x60; You then join these strings together in arrays to signal &#x60;AND&#x60; and &#x60;OR&#x60; operators. ##### OR All elements in a single array are considered to be joined by OR statements. For example, the search &#x60;[[\&quot;versions:1.16.5\&quot;, \&quot;versions:1.17.1\&quot;]]&#x60; translates to &#x60;Projects that support 1.16.5 OR 1.17.1&#x60;. ##### AND Separate arrays are considered to be joined by AND statements. For example, the search &#x60;[[\&quot;versions:1.16.5\&quot;], [\&quot;project_type:modpack\&quot;]]&#x60; translates to &#x60;Projects that support 1.16.5 AND are modpacks&#x60;. | [optional] |
1029+
| **facets** | **string**| Facets are an essential concept for understanding how to filter out results. These are the most commonly used facet types: - &#x60;project_type&#x60; - &#x60;categories&#x60; (loaders are lumped in with categories in search) - &#x60;versions&#x60; - &#x60;client_side&#x60; - &#x60;server_side&#x60; - &#x60;open_source&#x60; Several others are also available for use, though these should not be used outside very specific use cases. - &#x60;title&#x60; - &#x60;author&#x60; - &#x60;follows&#x60; - &#x60;project_id&#x60; - &#x60;license&#x60; - &#x60;downloads&#x60; - &#x60;color&#x60; - &#x60;created_timestamp&#x60; (uses Unix timestamp) - &#x60;modified_timestamp&#x60; (uses Unix timestamp) - &#x60;date_created&#x60; (uses ISO-8601 timestamp) - &#x60;date_modified&#x60; (uses ISO-8601 timestamp) In order to then use these facets, you need a value to filter by, as well as an operation to perform on this value. The most common operation is &#x60;:&#x60; (same as &#x60;&#x3D;&#x60;), though you can also use &#x60;!&#x3D;&#x60;, &#x60;&gt;&#x3D;&#x60;, &#x60;&gt;&#x60;, &#x60;&lt;&#x3D;&#x60;, and &#x60;&lt;&#x60;. Join together the type, operation, and value, and you&#39;ve got your string. &#x60;&#x60;&#x60; {type} {operation} {value} &#x60;&#x60;&#x60; Examples: &#x60;&#x60;&#x60; categories &#x3D; adventure versions !&#x3D; 1.20.1 downloads &lt;&#x3D; 100 &#x60;&#x60;&#x60; You then join these strings together in arrays to signal &#x60;AND&#x60; and &#x60;OR&#x60; operators. ##### OR All elements in a single array are considered to be joined by OR statements. For example, the search &#x60;[[\&quot;versions:1.16.5\&quot;, \&quot;versions:1.17.1\&quot;]]&#x60; translates to &#x60;Projects that support 1.16.5 OR 1.17.1&#x60;. ##### AND Separate arrays are considered to be joined by AND statements. For example, the search &#x60;[[\&quot;versions:1.16.5\&quot;], [\&quot;project_type:modpack\&quot;]]&#x60; translates to &#x60;Projects that support 1.16.5 AND are modpacks&#x60;. | [optional] |
10281030
| **index** | **string**| The sorting method used for sorting search results | [optional] [default to &#39;relevance&#39;] |
10291031
| **offset** | **int**| The offset into the search. Skips this number of results | [optional] [default to 0] |
10301032
| **limit** | **int**| The number of results returned by the search | [optional] [default to 10] |

docs/Api/TagsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\TagsApi
22

3+
Tags are common and reusable lists of metadata types such as categories or versions. Some can be applied to projects and/or versions.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Api/TeamsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\TeamsApi
22

3+
Through teams, user permissions limit how team members can modify projects.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Api/ThreadsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\ThreadsApi
22

3+
Threads are a way of communicating between users and moderators, for the purposes of project reviews and reports.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Api/UsersApi.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,13 @@
11
# Aternos\ModrinthApi\UsersApi
22

3+
Users can create projects, join teams, access notifications, manage settings, and follow projects. Admins and moderators have more advanced permissions such as reviewing new projects.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |
68
| ------------- | ------------- | ------------- |
79
| [**changeUserIcon()**](UsersApi.md#changeUserIcon) | **PATCH** /user/{id|username}/icon | Change user&#39;s avatar |
10+
| [**deleteUserIcon()**](UsersApi.md#deleteUserIcon) | **DELETE** /user/{id|username}/icon | Remove user&#39;s avatar |
811
| [**getFollowedProjects()**](UsersApi.md#getFollowedProjects) | **GET** /user/{id|username}/follows | Get user&#39;s followed projects |
912
| [**getPayoutHistory()**](UsersApi.md#getPayoutHistory) | **GET** /user/{id|username}/payouts | Get user&#39;s payout history |
1013
| [**getUser()**](UsersApi.md#getUser) | **GET** /user/{id|username} | Get a user |
@@ -78,6 +81,65 @@ void (empty response body)
7881
[[Back to Model list]](../../README.md#models)
7982
[[Back to README]](../../README.md)
8083

84+
## `deleteUserIcon()`
85+
86+
```php
87+
deleteUserIcon($id_username)
88+
```
89+
90+
Remove user's avatar
91+
92+
### Example
93+
94+
```php
95+
<?php
96+
require_once(__DIR__ . '/vendor/autoload.php');
97+
98+
99+
// Configure API key authorization: TokenAuth
100+
$config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
101+
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
102+
// $config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
103+
104+
105+
$apiInstance = new Aternos\ModrinthApi\Api\UsersApi(
106+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
107+
// This is optional, `GuzzleHttp\Client` will be used as default.
108+
new GuzzleHttp\Client(),
109+
$config
110+
);
111+
$id_username = ["EEFFGGHH","my_user"]; // string | The ID or username of the user
112+
113+
try {
114+
$apiInstance->deleteUserIcon($id_username);
115+
} catch (Exception $e) {
116+
echo 'Exception when calling UsersApi->deleteUserIcon: ', $e->getMessage(), PHP_EOL;
117+
}
118+
```
119+
120+
### Parameters
121+
122+
| Name | Type | Description | Notes |
123+
| ------------- | ------------- | ------------- | ------------- |
124+
| **id_username** | **string**| The ID or username of the user | |
125+
126+
### Return type
127+
128+
void (empty response body)
129+
130+
### Authorization
131+
132+
[TokenAuth](../../README.md#TokenAuth)
133+
134+
### HTTP request headers
135+
136+
- **Content-Type**: Not defined
137+
- **Accept**: `application/json`
138+
139+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
140+
[[Back to Model list]](../../README.md#models)
141+
[[Back to README]](../../README.md)
142+
81143
## `getFollowedProjects()`
82144

83145
```php

docs/Api/VersionFilesApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\VersionFilesApi
22

3+
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Api/VersionsApi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Aternos\ModrinthApi\VersionsApi
22

3+
Versions contain download links to files with additional metadata.
4+
35
All URIs are relative to https://api.modrinth.com/v2, except if the operation defines another base path.
46

57
| Method | HTTP request | Description |

docs/Model/Statistics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**projects** | **int** | Number of projects on Modrinth | [optional]
8-
**versions** | **int** | Number of projects on Modrinth | [optional]
8+
**versions** | **int** | Number of versions on Modrinth | [optional]
99
**files** | **int** | Number of version files on Modrinth | [optional]
1010
**authors** | **int** | Number of authors (users with projects) on Modrinth | [optional]
1111

0 commit comments

Comments
 (0)