Update version file enum cases

JulianVennen · JulianVennen · commit ce3cb98dd7a0 · 2025-12-19T22:19:15.000+01:00
diff --git a/docs/Model/EditableFileType.md b/docs/Model/EditableFileType.md
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **algorithm** | **string** | The hash algorithm of the hash specified in the hash field |
 **hash** | **string** | The hash of the file you&#39;re editing |
-**file_type** | **string** | The hash algorithm of the file you&#39;re editing |
+**file_type** | [**\Aternos\ModrinthApi\Model\FileTypeEnum**](FileTypeEnum.md) | The hash algorithm of the file you&#39;re editing |
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/FileTypeEnum.md b/docs/Model/FileTypeEnum.md
@@ -0,0 +1,8 @@
+# # FileTypeEnum
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/docs/Model/VersionFile.md b/docs/Model/VersionFile.md
@@ -9,6 +9,6 @@ Name | Type | Description | Notes
 **filename** | **string** | The name of the file |
 **primary** | **bool** | Whether this file is the primary one for its version. Only a maximum of one file per version will have this set to true. If there are not any primary files, it can be inferred that the first file is the primary one. |
 **size** | **int** | The size of the file in bytes |
-**file_type** | **string** | The type of the additional file, used mainly for adding resource packs to datapacks | [optional]
+**file_type** | [**\Aternos\ModrinthApi\Model\FileTypeEnum**](FileTypeEnum.md) | The type of the additional file, used mainly for adding resource packs to datapacks | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
diff --git a/lib/Api/MiscApi.php b/lib/Api/MiscApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/NotificationsApi.php b/lib/Api/NotificationsApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/TagsApi.php b/lib/Api/TagsApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/TeamsApi.php b/lib/Api/TeamsApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/ThreadsApi.php b/lib/Api/ThreadsApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/UsersApi.php b/lib/Api/UsersApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Api/VersionFilesApi.php b/lib/Api/VersionFilesApi.php
@@ -39,6 +39,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Aternos\ModrinthApi\ApiException;
 use Aternos\ModrinthApi\Configuration;
+use Aternos\ModrinthApi\FormDataProcessor;
 use Aternos\ModrinthApi\HeaderSelector;
 use Aternos\ModrinthApi\ObjectSerializer;
 
diff --git a/lib/Model/EditableFileType.php b/lib/Model/EditableFileType.php
@@ -60,7 +60,7 @@ class EditableFileType implements ModelInterface, ArrayAccess, \JsonSerializable
     protected static $openAPITypes = [
         'algorithm' => 'string',
         'hash' => 'string',
-        'file_type' => 'string'
+        'file_type' => '\Aternos\ModrinthApi\Model\FileTypeEnum'
     ];
 
     /**
@@ -241,21 +241,6 @@ public function getModelName()
         return self::$openAPIModelName;
     }
 
-    public const FILE_TYPE_REQUIRED_RESOURCE_PACK = 'required-resource-pack';
-    public const FILE_TYPE_OPTIONAL_RESOURCE_PACK = 'optional-resource-pack';
-
-    /**
-     * Gets allowable values of the enum
-     *
-     * @return string[]
-     */
-    public function getFileTypeAllowableValues()
-    {
-        return [
-            self::FILE_TYPE_REQUIRED_RESOURCE_PACK,
-            self::FILE_TYPE_OPTIONAL_RESOURCE_PACK,
-        ];
-    }
 
     /**
      * Associative array for storing property values
@@ -313,15 +298,6 @@ public function listInvalidProperties()
         if ($this->container['file_type'] === null) {
             $invalidProperties[] = "'file_type' can't be null";
         }
-        $allowedValues = $this->getFileTypeAllowableValues();
-        if (!is_null($this->container['file_type']) && !in_array($this->container['file_type'], $allowedValues, true)) {
-            $invalidProperties[] = sprintf(
-                "invalid value '%s' for 'file_type', must be one of '%s'",
-                $this->container['file_type'],
-                implode("', '", $allowedValues)
-            );
-        }
-
         return $invalidProperties;
     }
 
@@ -394,7 +370,7 @@ public function setHash($hash)
     /**
      * Gets file_type
      *
-     * @return string
+     * @return \Aternos\ModrinthApi\Model\FileTypeEnum
      */
     public function getFileType()
     {
@@ -404,7 +380,7 @@ public function getFileType()
     /**
      * Sets file_type
      *
-     * @param string $file_type The hash algorithm of the file you're editing
+     * @param \Aternos\ModrinthApi\Model\FileTypeEnum $file_type The hash algorithm of the file you're editing
      *
      * @return self
      */
@@ -420,16 +396,6 @@ public function setFileType($file_type)
                 $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
             }
         }
-        $allowedValues = $this->getFileTypeAllowableValues();
-        if (!is_null($file_type) && !in_array($file_type, $allowedValues, true)) {
-            throw new \InvalidArgumentException(
-                sprintf(
-                    "Invalid value '%s' for 'file_type', must be one of '%s'",
-                    $file_type,
-                    implode("', '", $allowedValues)
-                )
-            );
-        }
         $this->container['file_type'] = $file_type;
 
         return $this;
diff --git a/lib/Model/FileTypeEnum.php b/lib/Model/FileTypeEnum.php
@@ -0,0 +1,78 @@
+<?php
+/**
+ * FileTypeEnum
+ *
+ * PHP version 8.1
+ *
+ * @category Class
+ * @package  Aternos\ModrinthApi
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+
+/**
+ * Labrinth
+ *
+ * This documentation doesn't provide a way to test our API. In order to facilitate testing, we recommend the following tools:  - [cURL](https://curl.se/) (recommended, command-line) - [ReqBIN](https://reqbin.com/) (recommended, online) - [Postman](https://www.postman.com/downloads/) - [Insomnia](https://insomnia.rest/) - Your web browser, if you don't need to send headers or a request body  Once you have a working client, you can test that it works by making a `GET` request to `https://staging-api.modrinth.com/`:  ```json {   \"about\": \"Welcome traveler!\",   \"documentation\": \"https://docs.modrinth.com\",   \"name\": \"modrinth-labrinth\",   \"version\": \"2.7.0\" } ```  If you got a response similar to the one above, you can use the Modrinth API! When you want to go live using the production API, use `api.modrinth.com` instead of `staging-api.modrinth.com`.  ## Authentication This API has two options for authentication: personal access tokens and [OAuth2](https://en.wikipedia.org/wiki/OAuth). All tokens are tied to a Modrinth user and use the `Authorization` header of the request.  Example: ``` Authorization: mrp_RNtLRSPmGj2pd1v1ubi52nX7TJJM9sznrmwhAuj511oe4t1jAqAQ3D6Wc8Ic ```  You do not need a token for most requests. Generally speaking, only the following types of requests require a token: - those which create data (such as version creation) - those which modify data (such as editing a project) - those which access private data (such as draft projects, notifications, emails, and payout data)  Each request requiring authentication has a certain scope. For example, to view the email of the user being requested, the token must have the `USER_READ_EMAIL` scope. You can find the list of available scopes [on GitHub](https://github.com/modrinth/labrinth/blob/master/src/models/pats.rs#L15). Making a request with an invalid scope will return a 401 error.  Please note that certain scopes and requests cannot be completed with a personal access token or using OAuth. For example, deleting a user account can only be done through Modrinth's frontend.  A detailed guide on OAuth has been published in [Modrinth's technical documentation](https://docs.modrinth.com/guide/oauth).  ### Personal access tokens Personal access tokens (PATs) can be generated in from [the user settings](https://modrinth.com/settings/account).  ### GitHub tokens For backwards compatibility purposes, some types of GitHub tokens also work for authenticating a user with Modrinth's API, granting all scopes. **We urge any application still using GitHub tokens to start using personal access tokens for security and reliability purposes.** GitHub tokens will cease to function to authenticate with Modrinth's API as soon as version 3 of the API is made generally available.  ## Cross-Origin Resource Sharing This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with the [W3C spec](https://www.w3.org/TR/cors/). This allows for cross-domain communication from the browser. All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.  ## Identifiers The majority of items you can interact with in the API have a unique eight-digit base62 ID. Projects, versions, users, threads, teams, and reports all use this same way of identifying themselves. Version files use the sha1 or sha512 file hashes as identifiers.  Each project and user has a friendlier way of identifying them; slugs and usernames, respectively. While unique IDs are constant, slugs and usernames can change at any moment. If you want to store something in the long term, it is recommended to use the unique ID.  ## Ratelimits The API has a ratelimit defined per IP. Limits and remaining amounts are given in the response headers. - `X-Ratelimit-Limit`: the maximum number of requests that can be made in a minute - `X-Ratelimit-Remaining`: the number of requests remaining in the current ratelimit window - `X-Ratelimit-Reset`: the time in seconds until the ratelimit window resets  Ratelimits are the same no matter whether you use a token or not. The ratelimit is currently 300 requests per minute. If you have a use case requiring a higher limit, please [contact us](mailto:admin@modrinth.com).  ## User Agents To access the Modrinth API, you **must** use provide a uniquely-identifying `User-Agent` header. Providing a user agent that only identifies your HTTP client library (such as \"okhttp/4.9.3\") increases the likelihood that we will block your traffic. It is recommended, but not required, to include contact information in your user agent. This allows us to contact you if we would like a change in your application's behavior without having to block your traffic. - Bad: `User-Agent: okhttp/4.9.3` - Good: `User-Agent: project_name` - Better: `User-Agent: github_username/project_name/1.56.0` - Best: `User-Agent: github_username/project_name/1.56.0 (launcher.com)` or `User-Agent: github_username/project_name/1.56.0 (contact@launcher.com)`  ## Versioning Modrinth follows a simple pattern for its API versioning. In the event of a breaking API change, the API version in the URL path is bumped, and migration steps will be published below.  When an API is no longer the current one, it will immediately be considered deprecated. No more support will be provided for API versions older than the current one. It will be kept for some time, but this amount of time is not certain.  We will exercise various tactics to get people to update their implementation of our API. One example is by adding something like `STOP USING THIS API` to various data returned by the API.  Once an API version is completely deprecated, it will permanently return a 410 error. Please ensure your application handles these 410 errors.  ### Migrations Inside the following spoiler, you will be able to find all changes between versions of the Modrinth API, accompanied by tips and a guide to migrate applications to newer versions.  Here, you can also find changes for [Minotaur](https://github.com/modrinth/minotaur), Modrinth's official Gradle plugin. Major versions of Minotaur directly correspond to major versions of the Modrinth API.  <details><summary>API v1 to API v2</summary>  These bullet points cover most changes in the v2 API, but please note that fields containing `mod` in most contexts have been shifted to `project`.  For example, in the search route, the field `mod_id` was renamed to `project_id`.  - The search route has been moved from `/api/v1/mod` to `/v2/search` - New project fields: `project_type` (may be `mod` or `modpack`), `moderation_message` (which has a `message` and `body`), `gallery` - New search facet: `project_type` - Alphabetical sort removed (it didn't work and is not possible due to limits in MeiliSearch) - New search fields: `project_type`, `gallery`   - The gallery field is an array of URLs to images that are part of the project's gallery - The gallery is a new feature which allows the user to upload images showcasing their mod to the CDN which will be displayed on their mod page - Internal change: Any project file uploaded to Modrinth is now validated to make sure it's a valid Minecraft mod, Modpack, etc.   - For example, a Forge 1.17 mod with a JAR not containing a mods.toml will not be allowed to be uploaded to Modrinth - In project creation, projects may not upload a mod with no versions to review, however they can be saved as a draft   - Similarly, for version creation, a version may not be uploaded without any files - Donation URLs have been enabled - New project status: `archived`. Projects with this status do not appear in search - Tags (such as categories, loaders) now have icons (SVGs) and specific project types attached - Dependencies have been wiped and replaced with a new system - Notifications now have a `type` field, such as `project_update`  Along with this, project subroutes (such as `/v2/project/{id}/version`) now allow the slug to be used as the ID. This is also the case with user routes.  </details><details><summary>Minotaur v1 to Minotaur v2</summary>  Minotaur 2.x introduced a few breaking changes to how your buildscript is formatted.  First, instead of registering your own `publishModrinth` task, Minotaur now automatically creates a `modrinth` task. As such, you can replace the `task publishModrinth(type: TaskModrinthUpload) {` line with just `modrinth {`.  To declare supported Minecraft versions and mod loaders, the `gameVersions` and `loaders` arrays must now be used. The syntax for these are pretty self-explanatory.  Instead of using `releaseType`, you must now use `versionType`. This was actually changed in v1.2.0, but very few buildscripts have moved on from v1.1.0.  Dependencies have been changed to a special DSL. Create a `dependencies` block within the `modrinth` block, and then use `scope.type(\"project/version\")`. For example, `required.project(\"fabric-api\")` adds a required project dependency on Fabric API.  You may now use the slug anywhere that a project ID was previously required.  </details>
+ *
+ * The version of the OpenAPI document: v2.7.0/366f528
+ * Contact: support@modrinth.com
+ * Generated by: https://openapi-generator.tech
+ * Generator version: 7.17.0
+ */
+
+/**
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+namespace Aternos\ModrinthApi\Model;
+use \Aternos\ModrinthApi\ObjectSerializer;
+
+/**
+ * FileTypeEnum Class Doc Comment
+ *
+ * @category Class
+ * @package  Aternos\ModrinthApi
+ * @author   OpenAPI Generator team
+ * @link     https://openapi-generator.tech
+ */
+class FileTypeEnum
+{
+    /**
+     * Possible values of this enum
+     */
+    public const REQUIRED_RESOURCE_PACK = 'required-resource-pack';
+
+    public const OPTIONAL_RESOURCE_PACK = 'optional-resource-pack';
+
+    public const SOURCES_JAR = 'sources-jar';
+
+    public const DEV_JAR = 'dev-jar';
+
+    public const JAVADOC_JAR = 'javadoc-jar';
+
+    public const UNKNOWN = 'unknown';
+
+    public const SIGNATURE = 'signature';
+
+    /**
+     * Gets allowable values of the enum
+     * @return string[]
+     */
+    public static function getAllowableEnumValues()
+    {
+        return [
+            self::REQUIRED_RESOURCE_PACK,
+            self::OPTIONAL_RESOURCE_PACK,
+            self::SOURCES_JAR,
+            self::DEV_JAR,
+            self::JAVADOC_JAR,
+            self::UNKNOWN,
+            self::SIGNATURE
+        ];
+    }
+}
+
+
diff --git a/lib/Model/VersionFile.php b/lib/Model/VersionFile.php
@@ -63,7 +63,7 @@ class VersionFile implements ModelInterface, ArrayAccess, \JsonSerializable
         'filename' => 'string',
         'primary' => 'bool',
         'size' => 'int',
-        'file_type' => 'string'
+        'file_type' => '\Aternos\ModrinthApi\Model\FileTypeEnum'
     ];
 
     /**
@@ -259,21 +259,6 @@ public function getModelName()
         return self::$openAPIModelName;
     }
 
-    public const FILE_TYPE_REQUIRED_RESOURCE_PACK = 'required-resource-pack';
-    public const FILE_TYPE_OPTIONAL_RESOURCE_PACK = 'optional-resource-pack';
-
-    /**
-     * Gets allowable values of the enum
-     *
-     * @return string[]
-     */
-    public function getFileTypeAllowableValues()
-    {
-        return [
-            self::FILE_TYPE_REQUIRED_RESOURCE_PACK,
-            self::FILE_TYPE_OPTIONAL_RESOURCE_PACK,
-        ];
-    }
 
     /**
      * Associative array for storing property values
@@ -340,15 +325,6 @@ public function listInvalidProperties()
         if ($this->container['size'] === null) {
             $invalidProperties[] = "'size' can't be null";
         }
-        $allowedValues = $this->getFileTypeAllowableValues();
-        if (!is_null($this->container['file_type']) && !in_array($this->container['file_type'], $allowedValues, true)) {
-            $invalidProperties[] = sprintf(
-                "invalid value '%s' for 'file_type', must be one of '%s'",
-                $this->container['file_type'],
-                implode("', '", $allowedValues)
-            );
-        }
-
         return $invalidProperties;
     }
 
@@ -502,7 +478,7 @@ public function setSize($size)
     /**
      * Gets file_type
      *
-     * @return string|null
+     * @return \Aternos\ModrinthApi\Model\FileTypeEnum|null
      */
     public function getFileType()
     {
@@ -512,7 +488,7 @@ public function getFileType()
     /**
      * Sets file_type
      *
-     * @param string|null $file_type The type of the additional file, used mainly for adding resource packs to datapacks
+     * @param \Aternos\ModrinthApi\Model\FileTypeEnum|null $file_type The type of the additional file, used mainly for adding resource packs to datapacks
      *
      * @return self
      */
@@ -528,16 +504,6 @@ public function setFileType($file_type)
                 $this->setOpenAPINullablesSetToNull($nullablesSetToNull);
             }
         }
-        $allowedValues = $this->getFileTypeAllowableValues();
-        if (!is_null($file_type) && !in_array($file_type, $allowedValues, true)) {
-            throw new \InvalidArgumentException(
-                sprintf(
-                    "Invalid value '%s' for 'file_type', must be one of '%s'",
-                    $file_type,
-                    implode("', '", $allowedValues)
-                )
-            );
-        }
         $this->container['file_type'] = $file_type;
 
         return $this;
diff --git a/openapitools.json b/openapitools.json
@@ -0,0 +1,7 @@
+{
+  "$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
+  "spaces": 2,
+  "generator-cli": {
+    "version": "7.17.0"
+  }
+}
