Merge pull request #11 from aternosorg/spec-update

Update to latest openapi spec
aternosorg · Dec 19, 2023 · 993f00d · 993f00d
2 parents d4b466a + 1f06763
commit 993f00d
Show file tree

Hide file tree

Showing 117 changed files with 1,812 additions and 10,124 deletions.
diff --git a/config.yaml b/config.yaml
@@ -2,5 +2,4 @@ invokerPackage: Aternos\ModrinthApi
 artifactVersion: 1.0.0
 generatorName: php
 outputDir: .
-# This points to a downgraded Open API 3.0.0 spec for now. The official spec can be found at https://docs.modrinth.com/redocusaurus/plugin-redoc-0.yaml
-inputSpec: https://raw.githubusercontent.com/JulianVennen/modrinth-docs/php-modrinth-api/static/openapi.yaml
+inputSpec: https://docs.modrinth.com/redocusaurus/plugin-redoc-0.yaml
diff --git a/docs/Api/MiscApi.md b/docs/Api/MiscApi.md
@@ -6,7 +6,6 @@ All URIs are relative to https://api.modrinth.com/v2, except if the operation de
 | ------------- | ------------- | ------------- |
 | [**forgeUpdates()**](MiscApi.md#forgeUpdates) | **GET** /updates/{id|slug}/forge_updates.json | Forge Updates JSON file |
 | [**statistics()**](MiscApi.md#statistics) | **GET** /statistics | Various statistics about this Modrinth instance |
-| [**submitReport()**](MiscApi.md#submitReport) | **POST** /report | Report a project, user, or version |
 
 
 ## `forgeUpdates()`
@@ -123,65 +122,3 @@ No authorization required
 [[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
 [[Back to Model list]](../../README.md#models)
 [[Back to README]](../../README.md)
-
-## `submitReport()`
-
-```php
-submitReport($creatable_report): \Aternos\ModrinthApi\Model\Report
-```
-
-Report a project, user, or version
-
-Bring a project, user, or version to the attention of the moderators by reporting it.
-
-### Example
-
-```php
-<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-
-// Configure API key authorization: TokenAuth
-$config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
-// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-// $config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
-
-
-$apiInstance = new Aternos\ModrinthApi\Api\MiscApi(
-    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
-    // This is optional, `GuzzleHttp\Client` will be used as default.
-    new GuzzleHttp\Client(),
-    $config
-);
-$creatable_report = new \Aternos\ModrinthApi\Model\CreatableReport(); // \Aternos\ModrinthApi\Model\CreatableReport | The report to be sent
-
-try {
-    $result = $apiInstance->submitReport($creatable_report);
-    print_r($result);
-} catch (Exception $e) {
-    echo 'Exception when calling MiscApi->submitReport: ', $e->getMessage(), PHP_EOL;
-}
-```
-
-### Parameters
-
-| Name | Type | Description  | Notes |
-| ------------- | ------------- | ------------- | ------------- |
-| **creatable_report** | [**\Aternos\ModrinthApi\Model\CreatableReport**](../Model/CreatableReport.md)| The report to be sent | [optional] |
-
-### Return type
-
-[**\Aternos\ModrinthApi\Model\Report**](../Model/Report.md)
-
-### Authorization
-
-[TokenAuth](../../README.md#TokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
-[[Back to Model list]](../../README.md#models)
-[[Back to README]](../../README.md)
diff --git a/docs/Api/ProjectsApi.md b/docs/Api/ProjectsApi.md
@@ -987,7 +987,7 @@ void (empty response body)
 ## `searchProjects()`
 
 ```php
-searchProjects($query, $facets, $index, $offset, $limit, $filters, $version): \Aternos\ModrinthApi\Model\SearchResults
+searchProjects($query, $facets, $index, $offset, $limit): \Aternos\ModrinthApi\Model\SearchResults
 ```
 
 Search projects
@@ -1010,11 +1010,9 @@ $facets = [["categories:forge"],["versions:1.17.1"],["project_type:mod"],["licen
 $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
-$filters = categories="fabric" AND (categories="technology" OR categories="utility"); // string | A list of filters relating to the properties of a project. Facets are generally recommended over filters.
-$version = version="1.16.3" OR version="1.16.2" OR version="1.16.1"; // string | A list of filters relating to the versions of a project. Use of facets for filtering by version is recommended
 
 try {
-    $result = $apiInstance->searchProjects($query, $facets, $index, $offset, $limit, $filters, $version);
+    $result = $apiInstance->searchProjects($query, $facets, $index, $offset, $limit);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling ProjectsApi->searchProjects: ', $e->getMessage(), PHP_EOL;
@@ -1030,8 +1028,6 @@ try {
 | **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] |
-| **filters** | **string**| A list of filters relating to the properties of a project. Facets are generally recommended over filters. | [optional] |
-| **version** | **string**| A list of filters relating to the versions of a project. Use of facets for filtering by version is recommended | [optional] |
 
 ### Return type
 

diff --git a/docs/Api/TagsApi.md b/docs/Api/TagsApi.md
@@ -177,7 +177,7 @@ No authorization required
 ## `licenseText()`
 
 ```php
-licenseText($id): \Aternos\ModrinthApi\Model\LicenseText200Response
+licenseText($id): \Aternos\ModrinthApi\Model\License
 ```
 
 Get the text and title of a license
@@ -213,7 +213,7 @@ try {
 
 ### Return type
 
-[**\Aternos\ModrinthApi\Model\LicenseText200Response**](../Model/LicenseText200Response.md)
+[**\Aternos\ModrinthApi\Model\License**](../Model/License.md)
 
 ### Authorization
 

diff --git a/docs/Api/UsersApi.md b/docs/Api/UsersApi.md
@@ -9,7 +9,6 @@ All URIs are relative to https://api.modrinth.com/v2, except if the operation de
 | [**getPayoutHistory()**](UsersApi.md#getPayoutHistory) | **GET** /user/{id|username}/payouts | Get user&#39;s payout history |
 | [**getUser()**](UsersApi.md#getUser) | **GET** /user/{id|username} | Get a user |
 | [**getUserFromAuth()**](UsersApi.md#getUserFromAuth) | **GET** /user | Get user from authorization header |
-| [**getUserNotifications()**](UsersApi.md#getUserNotifications) | **GET** /user/{id|username}/notifications | Get user&#39;s notifications |
 | [**getUserProjects()**](UsersApi.md#getUserProjects) | **GET** /user/{id|username}/projects | Get user&#39;s projects |
 | [**getUsers()**](UsersApi.md#getUsers) | **GET** /users | Get multiple users |
 | [**modifyUser()**](UsersApi.md#modifyUser) | **PATCH** /user/{id|username} | Modify a user |
@@ -310,66 +309,6 @@ This endpoint does not need any parameter.
 [[Back to Model list]](../../README.md#models)
 [[Back to README]](../../README.md)
 
-## `getUserNotifications()`
-
-```php
-getUserNotifications($id_username): \Aternos\ModrinthApi\Model\Notification[]
-```
-
-Get user's notifications
-
-### Example
-
-```php
-<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-
-// Configure API key authorization: TokenAuth
-$config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
-// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
-// $config = Aternos\ModrinthApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');
-
-
-$apiInstance = new Aternos\ModrinthApi\Api\UsersApi(
-    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
-    // This is optional, `GuzzleHttp\Client` will be used as default.
-    new GuzzleHttp\Client(),
-    $config
-);
-$id_username = ["EEFFGGHH","my_user"]; // string | The ID or username of the user
-
-try {
-    $result = $apiInstance->getUserNotifications($id_username);
-    print_r($result);
-} catch (Exception $e) {
-    echo 'Exception when calling UsersApi->getUserNotifications: ', $e->getMessage(), PHP_EOL;
-}
-```
-
-### Parameters
-
-| Name | Type | Description  | Notes |
-| ------------- | ------------- | ------------- | ------------- |
-| **id_username** | **string**| The ID or username of the user | |
-
-### Return type
-
-[**\Aternos\ModrinthApi\Model\Notification[]**](../Model/Notification.md)
-
-### Authorization
-
-[TokenAuth](../../README.md#TokenAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
-[[Back to Model list]](../../README.md#models)
-[[Back to README]](../../README.md)
-
 ## `getUserProjects()`
 
 ```php

diff --git a/docs/Api/VersionsApi.md b/docs/Api/VersionsApi.md
@@ -221,8 +221,8 @@ $apiInstance = new Aternos\ModrinthApi\Api\VersionsApi(
     new GuzzleHttp\Client()
 );
 $id_slug = ["AABBCCDD","my_project"]; // string | The ID or slug of the project
-$loaders = ["fabric"]; // string[] | The types of loaders to filter for
-$game_versions = ["1.18.1"]; // string[] | The game versions to filter for
+$loaders = ["fabric"]; // string | The types of loaders to filter for
+$game_versions = ["1.18.1"]; // string | The game versions to filter for
 $featured = True; // bool | Allows to filter for featured or non-featured versions only
 
 try {
@@ -238,8 +238,8 @@ try {
 | Name | Type | Description  | Notes |
 | ------------- | ------------- | ------------- | ------------- |
 | **id_slug** | **string**| The ID or slug of the project | |
-| **loaders** | [**string[]**](../Model/string.md)| The types of loaders to filter for | [optional] |
-| **game_versions** | [**string[]**](../Model/string.md)| The game versions to filter for | [optional] |
+| **loaders** | **string**| The types of loaders to filter for | [optional] |
+| **game_versions** | **string**| The game versions to filter for | [optional] |
 | **featured** | **bool**| Allows to filter for featured or non-featured versions only | [optional] |
 
 ### Return type
@@ -392,7 +392,7 @@ $apiInstance = new Aternos\ModrinthApi\Api\VersionsApi(
     // This is optional, `GuzzleHttp\Client` will be used as default.
     new GuzzleHttp\Client()
 );
-$ids = ["AABBCCDD","EEFFGGHH"]; // string | The IDs of the versions
+$ids = ["AABBCCDD", "EEFFGGHH"]; // string | The IDs of the versions
 
 try {
     $result = $apiInstance->getVersions($ids);

diff --git a/docs/Model/EditableProjectAllOf.md b/docs/Model/EditableProjectAllOf.md
diff --git a/docs/Model/ForgeUpdatesPromos.md → docs/Model/ForgeUpdateCheckerPromos.md b/docs/Model/ForgeUpdatesPromos.md → docs/Model/ForgeUpdateCheckerPromos.md
@@ -1,4 +1,4 @@
-# # ForgeUpdatesPromos
+# # ForgeUpdateCheckerPromos
 
 ## Properties
 

diff --git a/docs/Model/ForgeUpdates.md b/docs/Model/ForgeUpdates.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **homepage** | **string** | A link to the mod page | [optional]
-**promos** | [**\Aternos\ModrinthApi\Model\ForgeUpdatesPromos**](ForgeUpdatesPromos.md) |  | [optional]
+**promos** | [**\Aternos\ModrinthApi\Model\ForgeUpdateCheckerPromos**](ForgeUpdateCheckerPromos.md) |  | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/GetLatestVersionsFromHashesBodyAllOf.md b/docs/Model/GetLatestVersionsFromHashesBodyAllOf.md
diff --git a/docs/Model/LicenseText200Response.md → docs/Model/License.md b/docs/Model/LicenseText200Response.md → docs/Model/License.md
@@ -1,4 +1,4 @@
-# # LicenseText200Response
+# # License
 
 ## Properties
 

diff --git a/docs/Model/LicenseList200ResponseInner.md b/docs/Model/LicenseList200ResponseInner.md
diff --git a/docs/Model/ModifiableProjectAllOf.md b/docs/Model/ModifiableProjectAllOf.md
diff --git a/docs/Model/NonSearchProjectAllOf.md b/docs/Model/NonSearchProjectAllOf.md
diff --git a/docs/Model/NotificationAction.md b/docs/Model/NotificationAction.md
@@ -5,6 +5,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **title** | **string** | The friendly name for this action | [optional]
-**action_route** | **array** | The HTTP code and path to request in order to perform this action. | [optional]
+**action_route** | **string[]** | The HTTP code and path to request in order to perform this action. | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ProjectAllOf.md b/docs/Model/ProjectAllOf.md
diff --git a/docs/Model/ProjectResult.md b/docs/Model/ProjectResult.md
@@ -27,6 +27,5 @@ Name | Type | Description | Notes
 **license** | **string** | The SPDX license ID of a project |
 **gallery** | **string[]** | All gallery images attached to the project | [optional]
 **featured_gallery** | **string** | The featured gallery image of the project | [optional]
-**dependencies** | **string[]** | A list of this project&#39;s dependencies, in the format of &#x60;{project_id}-{dep_type}&#x60; | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/ProjectResultAllOf.md b/docs/Model/ProjectResultAllOf.md
diff --git a/docs/Model/ReportAllOf.md b/docs/Model/ReportAllOf.md