Skip to content

Commit 26ee558

Browse files
committed
Rerun generator
1 parent 2608aed commit 26ee558

Some content is hidden

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

78 files changed

+1144
-1423
lines changed

config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
invokerPackage: Aternos\ModrinthApi
2-
artifactVersion: 2.1.0
2+
artifactVersion: 2.1.1
33
generatorName: php
44
outputDir: .
5-
inputSpec: https://raw.githubusercontent.com/JulianVennen/modrinth-docs/master/static/openapi.yaml
5+
inputSpec: https://raw.githubusercontent.com/modrinth/code/refs/heads/main/apps/docs/public/openapi.yaml

docs/Api/MiscApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ forgeUpdates($id_slug): \Aternos\ModrinthApi\Model\ForgeUpdates
1717
- https://api.modrinth.com Production server- https://staging-api.modrinth.com Staging server
1818
Forge Updates JSON file
1919

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.
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.
2121

2222
### Example
2323

docs/Api/ProjectsApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ $featured = True; // bool | Whether an image is featured
5959
$title = 'title_example'; // string | Title of the image
6060
$description = 'description_example'; // string | Description of the image
6161
$ordering = 56; // int | Ordering of the image
62-
$body = "/path/to/file.txt"; // \SplFileObject
62+
$body = '/path/to/file.txt'; // \SplFileObject
6363

6464
try {
6565
$apiInstance->addGalleryImage($id_slug, $ext, $featured, $title, $description, $ordering, $body);
@@ -128,7 +128,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\ProjectsApi(
128128
);
129129
$id_slug = ["AABBCCDD","my_project"]; // string | The ID or slug of the project
130130
$ext = 'ext_example'; // string | Image extension
131-
$body = "/path/to/file.txt"; // \SplFileObject
131+
$body = '/path/to/file.txt'; // \SplFileObject
132132

133133
try {
134134
$apiInstance->changeProjectIcon($id_slug, $ext, $body);
@@ -244,7 +244,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\ProjectsApi(
244244
$config
245245
);
246246
$data = new \Aternos\ModrinthApi\Model\CreatableProject(); // \Aternos\ModrinthApi\Model\CreatableProject
247-
$icon = "/path/to/file.txt"; // \SplFileObject | Project icon file
247+
$icon = '/path/to/file.txt'; // \SplFileObject | Project icon file
248248

249249
try {
250250
$result = $apiInstance->createProject($data, $icon);
@@ -1006,7 +1006,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\ProjectsApi(
10061006
new GuzzleHttp\Client()
10071007
);
10081008
$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`.
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`.
10101010
$index = downloads; // string | The sorting method used for sorting search results
10111011
$offset = 20; // int | The offset into the search. Skips this number of results
10121012
$limit = 20; // int | The number of results returned by the search
@@ -1024,7 +1024,7 @@ try {
10241024
| Name | Type | Description | Notes |
10251025
| ------------- | ------------- | ------------- | ------------- |
10261026
| **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] |
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] |
10281028
| **index** | **string**| The sorting method used for sorting search results | [optional] [default to &#39;relevance&#39;] |
10291029
| **offset** | **int**| The offset into the search. Skips this number of results | [optional] [default to 0] |
10301030
| **limit** | **int**| The number of results returned by the search | [optional] [default to 10] |

docs/Api/UsersApi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\UsersApi(
4545
$config
4646
);
4747
$id_username = ["EEFFGGHH","my_user"]; // string | The ID or username of the user
48-
$body = "/path/to/file.txt"; // \SplFileObject
48+
$body = '/path/to/file.txt'; // \SplFileObject
4949

5050
try {
5151
$apiInstance->changeUserIcon($id_username, $body);

docs/Model/BaseVersion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
1111
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports | [optional]
1212
**version_type** | **string** | The release channel for this version | [optional]
13-
**loaders** | **string[]** | The mod loaders that this version supports | [optional]
13+
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; | [optional]
1414
**featured** | **bool** | Whether the version is featured or not | [optional]
1515
**status** | **string** | | [optional]
1616
**requested_status** | **string** | | [optional]

docs/Model/CreatableVersion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on |
1111
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports |
1212
**version_type** | **string** | The release channel for this version |
13-
**loaders** | **string[]** | The mod loaders that this version supports |
13+
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; |
1414
**featured** | **bool** | Whether the version is featured or not |
1515
**status** | **string** | | [optional]
1616
**requested_status** | **string** | | [optional]

docs/Model/EditableVersion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
1111
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports | [optional]
1212
**version_type** | **string** | The release channel for this version | [optional]
13-
**loaders** | **string[]** | The mod loaders that this version supports | [optional]
13+
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; | [optional]
1414
**featured** | **bool** | Whether the version is featured or not | [optional]
1515
**status** | **string** | | [optional]
1616
**requested_status** | **string** | | [optional]

docs/Model/Version.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
1111
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports |
1212
**version_type** | **string** | The release channel for this version |
13-
**loaders** | **string[]** | The mod loaders that this version supports |
13+
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; |
1414
**featured** | **bool** | Whether the version is featured or not |
1515
**status** | **string** | | [optional]
1616
**requested_status** | **string** | | [optional]

0 commit comments

Comments
 (0)