Skip to content

Commit

Permalink
Rerun generator
Browse files Browse the repository at this point in the history
  • Loading branch information
JulianVennen committed Jan 20, 2025
1 parent 2608aed commit 26ee558
Show file tree
Hide file tree
Showing 78 changed files with 1,144 additions and 1,423 deletions.
4 changes: 2 additions & 2 deletions config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
invokerPackage: Aternos\ModrinthApi
artifactVersion: 2.1.0
artifactVersion: 2.1.1
generatorName: php
outputDir: .
inputSpec: https://raw.githubusercontent.com/JulianVennen/modrinth-docs/master/static/openapi.yaml
inputSpec: https://raw.githubusercontent.com/modrinth/code/refs/heads/main/apps/docs/public/openapi.yaml
2 changes: 1 addition & 1 deletion docs/Api/MiscApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ forgeUpdates($id_slug): \Aternos\ModrinthApi\Model\ForgeUpdates
- https://api.modrinth.com Production server- https://staging-api.modrinth.com Staging server
Forge Updates JSON file

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

### Example

Expand Down
10 changes: 5 additions & 5 deletions docs/Api/ProjectsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ $featured = True; // bool | Whether an image is featured
$title = 'title_example'; // string | Title of the image
$description = 'description_example'; // string | Description of the image
$ordering = 56; // int | Ordering of the image
$body = "/path/to/file.txt"; // \SplFileObject
$body = '/path/to/file.txt'; // \SplFileObject

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

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

try {
$result = $apiInstance->createProject($data, $icon);
Expand Down Expand Up @@ -1006,7 +1006,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\ProjectsApi(
new GuzzleHttp\Client()
);
$query = gravestones; // string | The query to search for
$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`.
$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`.
$index = downloads; // string | The sorting method used for sorting search results
$offset = 20; // int | The offset into the search. Skips this number of results
$limit = 20; // int | The number of results returned by the search
Expand All @@ -1024,7 +1024,7 @@ try {
| Name | Type | Description | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **query** | **string**| The query to search for | [optional] |
| **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] |
| **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] |
| **index** | **string**| The sorting method used for sorting search results | [optional] [default to &#39;relevance&#39;] |
| **offset** | **int**| The offset into the search. Skips this number of results | [optional] [default to 0] |
| **limit** | **int**| The number of results returned by the search | [optional] [default to 10] |
Expand Down
2 changes: 1 addition & 1 deletion docs/Api/UsersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\UsersApi(
$config
);
$id_username = ["EEFFGGHH","my_user"]; // string | The ID or username of the user
$body = "/path/to/file.txt"; // \SplFileObject
$body = '/path/to/file.txt'; // \SplFileObject

try {
$apiInstance->changeUserIcon($id_username, $body);
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/BaseVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports | [optional]
**version_type** | **string** | The release channel for this version | [optional]
**loaders** | **string[]** | The mod loaders that this version supports | [optional]
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; | [optional]
**featured** | **bool** | Whether the version is featured or not | [optional]
**status** | **string** | | [optional]
**requested_status** | **string** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/CreatableVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on |
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports |
**version_type** | **string** | The release channel for this version |
**loaders** | **string[]** | The mod loaders that this version supports |
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; |
**featured** | **bool** | Whether the version is featured or not |
**status** | **string** | | [optional]
**requested_status** | **string** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/EditableVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports | [optional]
**version_type** | **string** | The release channel for this version | [optional]
**loaders** | **string[]** | The mod loaders that this version supports | [optional]
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; | [optional]
**featured** | **bool** | Whether the version is featured or not | [optional]
**status** | **string** | | [optional]
**requested_status** | **string** | | [optional]
Expand Down
2 changes: 1 addition & 1 deletion docs/Model/Version.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Name | Type | Description | Notes
**dependencies** | [**\Aternos\ModrinthApi\Model\VersionDependency[]**](VersionDependency.md) | A list of specific versions of projects that this version depends on | [optional]
**game_versions** | **string[]** | A list of versions of Minecraft that this version supports |
**version_type** | **string** | The release channel for this version |
**loaders** | **string[]** | The mod loaders that this version supports |
**loaders** | **string[]** | The mod loaders that this version supports. In case of resource packs, use \&quot;minecraft\&quot; |
**featured** | **bool** | Whether the version is featured or not |
**status** | **string** | | [optional]
**requested_status** | **string** | | [optional]
Expand Down
Loading

0 comments on commit 26ee558

Please sign in to comment.