Add ability to use release candidate API version

Falls back to latest API version for REST resources

Dont load rest resources for release candidate version

changeset

skip loading if unstable or rc

Author: lizkenyon

CHANGELOG.md

@@ -4,6 +4,7 @@ Note: For changes to the API, see https://shopify.dev/changelog?filter=api
 ## Unreleased
 
 - [#1362](https://github.com/Shopify/shopify-api-ruby/pull/1362) Add support for client credentials grant
+- [#1366](https://github.com/Shopify/shopify-api-ruby/pull/1366) Add support for release candidate API versions
 
 ## 14.8.0
 

lib/shopify_api/admin_versions.rb

@@ -3,8 +3,11 @@
 
 module ShopifyAPI
   module AdminVersions
+    extend T::Sig
+
     SUPPORTED_ADMIN_VERSIONS = T.let([
       "unstable",
+      "2025-04",
       "2025-01",
       "2024-10",
       "2024-07",
@@ -21,8 +24,10 @@ module AdminVersions
     ], T::Array[String])
 
     LATEST_SUPPORTED_ADMIN_VERSION = T.let("2025-01", String)
+    RELEASE_CANDIDATE_ADMIN_VERSION = T.let("2025-04", String)
   end
 
   SUPPORTED_ADMIN_VERSIONS = ShopifyAPI::AdminVersions::SUPPORTED_ADMIN_VERSIONS
   LATEST_SUPPORTED_ADMIN_VERSION = ShopifyAPI::AdminVersions::LATEST_SUPPORTED_ADMIN_VERSION
+  RELEASE_CANDIDATE_ADMIN_VERSION = ShopifyAPI::AdminVersions::RELEASE_CANDIDATE_ADMIN_VERSION
 end

lib/shopify_api/context.rb

@@ -101,10 +101,11 @@ def load_rest_resources(api_version:)
         @rest_resource_loader&.setup
         @rest_resource_loader&.unload
 
-        # No resources for the unstable version
-        return if api_version == "unstable"
+        # No resources for the unstable version or the release candidate version
+        return if api_version == "unstable" || api_version == RELEASE_CANDIDATE_ADMIN_VERSION
 
         version_folder_name = api_version.gsub("-", "_")
+
         path = "#{__dir__}/rest/resources/#{version_folder_name}"
 
         unless Dir.exist?(path)

test/admin_versions_test.rb

@@ -12,5 +12,9 @@ def test_supported_admin_versions
     def test_supported_latest_supported_admin_version
       assert_instance_of(String, ShopifyAPI::AdminVersions::LATEST_SUPPORTED_ADMIN_VERSION)
     end
+
+    def test_supported_release_candidate_admin_version
+      assert_instance_of(String, ShopifyAPI::AdminVersions::RELEASE_CANDIDATE_ADMIN_VERSION)
+    end
   end
 end