Add include changelog option to client methods for listing versions

Author: JulianVennen

config.yaml

@@ -1,5 +1,5 @@
 invokerPackage: Aternos\ModrinthApi
-artifactVersion: 3.2.0
+artifactVersion: 3.2.1
 generatorName: php
 outputDir: .
 inputSpec: https://raw.githubusercontent.com/modrinth/code/refs/heads/main/apps/docs/public/openapi.yaml

lib/Client/ModrinthAPIClient.php

@@ -223,8 +223,7 @@ public function checkProjectValidity(string $idOrSlug): ?string
     {
         try {
             return $this->projects->checkProjectValidity($idOrSlug)->getId();
-        }
-        catch (ApiException $exception) {
+        } catch (ApiException $exception) {
             if ($exception->getCode() === 404) {
                 return null;
             }
@@ -258,17 +257,19 @@ public function getProjectVersionFromIdOrNumber(string $idOrSlug, string $versio
     /**
      * Get all versions of a project
      * @param string $idOrSlug Project ID or slug
-     * @param string[]|null $loaders only show versions for any of these loaders // TODO: enum??
+     * @param string[]|null $loaders only show versions for any of these loaders
      * @param string[]|null $gameVersions
      * @param bool|null $featured
+     * @param bool|null $include_changelog whether to include changelogs in the response. Currently defaults to true on modrinth side.
      * @return Version[]
      * @throws ApiException
      */
     public function getProjectVersions(
         string $idOrSlug,
         ?array $loaders = null,
         ?array $gameVersions = null,
-        ?bool  $featured = null
+        ?bool  $featured = null,
+        ?bool  $include_changelog = null,
     ): array
     {
         return array_map(function (VersionModel $version): Version {
@@ -277,7 +278,8 @@ public function getProjectVersions(
             $idOrSlug,
             $loaders ? json_encode($loaders) : null,
             $gameVersions ? json_encode($gameVersions) : null,
-            $featured
+            $featured,
+            $include_changelog,
         ));
     }
 
@@ -366,9 +368,9 @@ public function getLatestVersionFromHash(
      * @throws ApiException
      */
     public function getLatestVersionsFromHashes(
-        array $hashes,
-        array $loaders,
-        array $gameVersions,
+        array         $hashes,
+        array         $loaders,
+        array         $gameVersions,
         HashAlgorithm $algorithm = HashAlgorithm::SHA1
     ): array
     {

lib/Client/ProjectTrait.php

@@ -30,19 +30,21 @@ public function getDependencies(): ProjectDependencies
 
     /**
      * Get all versions of this project
-     * @param string[]|null $loaders
+     * @param string[]|null $loaders only show versions for any of these loaders
      * @param string[]|null $gameVersions
      * @param bool|null $featured
+     * @param bool|null $include_changelog whether to include changelogs in the response. Currently defaults to true on modrinth side.
      * @return Version[]
      * @throws ApiException
      */
     public function getVersions(
         ?array $loaders = null,
         ?array $gameVersions = null,
-        ?bool  $featured = null
+        ?bool  $featured = null,
+        ?bool  $include_changelog = null,
     ): array
     {
-        return $this->getClient()->getProjectVersions($this->getId(), $loaders, $gameVersions, $featured);
+        return $this->getClient()->getProjectVersions($this->getId(), $loaders, $gameVersions, $featured, $include_changelog);
     }
 
     /**
@@ -54,4 +56,4 @@ public function getMembers(): array
     {
         return $this->getClient()->getProjectMembers($this->getId());
     }
-}
+}