spree_api 5.4.0.beta4 → 5.4.0.beta6

data/lib/spree/api/openapi/schema_helper.rb

@@ -7,7 +7,7 @@ module Spree
       module SchemaHelper
         extend self
 
-        # Reference a schema by name (e.g., 'StoreProduct', 'StoreOrder')
+        # Reference a schema by name (e.g., 'Product', 'Order')
         def ref(schema_name)
           { '$ref' => "#/components/schemas/#{schema_name}" }
         end
@@ -40,10 +40,15 @@ module Spree
               properties: {
                 page: { type: :integer, example: 1 },
                 limit: { type: :integer, example: 25 },
-                count: { type: :integer, example: 100 },
-                pages: { type: :integer, example: 4 }
+                count: { type: :integer, example: 100, description: 'Total number of records' },
+                pages: { type: :integer, example: 4, description: 'Total number of pages' },
+                from: { type: :integer, example: 1, description: 'Index of first record on this page' },
+                to: { type: :integer, example: 25, description: 'Index of last record on this page' },
+                in: { type: :integer, example: 25, description: 'Number of records on this page' },
+                previous: { type: :integer, nullable: true, example: nil, description: 'Previous page number' },
+                next: { type: :integer, nullable: true, example: 2, description: 'Next page number' }
               },
-              required: %w[page limit count pages]
+              required: %w[page limit count pages from to in]
             },
             ErrorResponse: {
               type: :object,
@@ -76,7 +81,7 @@ module Spree
               type: :object,
               properties: {
                 token: { type: :string, description: 'JWT access token' },
-                user: { '$ref' => '#/components/schemas/StoreCustomer' }
+                user: { '$ref' => '#/components/schemas/Customer' }
               },
               required: %w[token user]
             }
@@ -100,12 +105,27 @@ module Spree
 
         def typelizer_schemas
           with_typelizer_enabled do
-            schemas = Typelizer.openapi_schemas
-            schemas.each_value { |s| s[:'x-typelizer'] = true }
+            schemas = Typelizer.openapi_schemas(writer_name: :store)
+            schemas.each_value do |s|
+              s[:'x-typelizer'] = true
+              strip_null_from_enums(s)
+            end
             schemas
           end
         end
 
+        # Typelizer adds nil to enum arrays for nullable fields.
+        # OpenAPI 3.0 handles nullability via `nullable: true`, so the nil entry is redundant
+        # and causes issues with code generators.
+        def strip_null_from_enums(schema)
+          properties = schema[:properties] || {}
+          properties.each_value do |prop|
+            next unless prop.is_a?(Hash) && prop[:enum].is_a?(Array)
+
+            prop[:enum].reject!(&:nil?)
+          end
+        end
+
         # Typelizer is normally disabled in test/production, but we need it
         # enabled to generate OpenAPI schemas from serializer type hints
         def with_typelizer_enabled

data/lib/spree/api/testing_support/v3/base.rb

@@ -13,7 +13,10 @@ module Spree
             aud: audience,
             exp: Time.current.to_i + expiration
           }
-          secret = Rails.application.credentials.jwt_secret_key || ENV['JWT_SECRET_KEY'] || Rails.application.secret_key_base
+          secret = Spree::Api::Config[:jwt_secret_key].presence ||
+                   Rails.application.credentials.jwt_secret_key ||
+                   ENV['JWT_SECRET_KEY'] ||
+                   Rails.application.secret_key_base
           JWT.encode(payload, secret, 'HS256')
         end
       end
@@ -47,6 +50,26 @@ shared_context 'API v3 Store guest' do
   let(:headers) { api_key_headers }
 end
 
+shared_context 'API v3 Admin' do
+  let(:store) { @default_store || create(:store, default: true) }
+  let(:secret_api_key) { create(:api_key, :secret, store: store) }
+  let(:api_key_headers) { { 'x-spree-api-key' => secret_api_key.plaintext_token } }
+
+  let(:admin_user) { create(:admin_user) }
+  let(:admin_jwt_token) { Spree::Api::V3::TestingSupport.generate_jwt(admin_user, audience: Spree::Api::V3::JwtAuthentication::JWT_AUDIENCE_ADMIN) }
+  let(:bearer_headers) { api_key_headers.merge('Authorization' => "Bearer #{admin_jwt_token}") }
+
+  before do
+    allow_any_instance_of(Spree::Api::V3::BaseController).to receive(:current_store).and_return(store)
+  end
+end
+
+shared_context 'API v3 Admin authenticated' do
+  include_context 'API v3 Admin'
+
+  let(:headers) { bearer_headers }
+end
+
 # Shared examples for common response patterns
 shared_examples 'returns 200 OK' do
   it 'returns 200 status' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 5.4.0.beta4
+  version: 5.4.0.beta6
 platform: ruby
 authors:
 - Vendo Connect Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-04 00:00:00.000000000 Z
+date: 2026-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rswag-specs
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: spree_core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.beta4
+        version: 5.4.0.beta6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.4.0.beta4
+        version: 5.4.0.beta6
 description: Spree's API
 email:
 - hello@spreecommerce.org
@@ -106,25 +106,31 @@ files:
 - app/controllers/concerns/spree/api/v3/api_key_authentication.rb
 - app/controllers/concerns/spree/api/v3/error_handler.rb
 - app/controllers/concerns/spree/api/v3/http_caching.rb
+- app/controllers/concerns/spree/api/v3/idempotent.rb
 - app/controllers/concerns/spree/api/v3/jwt_authentication.rb
 - app/controllers/concerns/spree/api/v3/locale_and_currency.rb
 - app/controllers/concerns/spree/api/v3/order_concern.rb
 - app/controllers/concerns/spree/api/v3/order_lock.rb
+- app/controllers/concerns/spree/api/v3/rate_limit_headers.rb
 - app/controllers/concerns/spree/api/v3/resource_serializer.rb
 - app/controllers/concerns/spree/api/v3/security_headers.rb
+- app/controllers/spree/api/v3/admin/base_controller.rb
+- app/controllers/spree/api/v3/admin/resource_controller.rb
 - app/controllers/spree/api/v3/base_controller.rb
 - app/controllers/spree/api/v3/resource_controller.rb
 - app/controllers/spree/api/v3/store/auth_controller.rb
 - app/controllers/spree/api/v3/store/base_controller.rb
 - app/controllers/spree/api/v3/store/cart_controller.rb
+- app/controllers/spree/api/v3/store/categories/products_controller.rb
+- app/controllers/spree/api/v3/store/categories_controller.rb
 - app/controllers/spree/api/v3/store/countries_controller.rb
 - app/controllers/spree/api/v3/store/currencies_controller.rb
-- app/controllers/spree/api/v3/store/customer/account_controller.rb
 - app/controllers/spree/api/v3/store/customer/addresses_controller.rb
 - app/controllers/spree/api/v3/store/customer/credit_cards_controller.rb
 - app/controllers/spree/api/v3/store/customer/gift_cards_controller.rb
 - app/controllers/spree/api/v3/store/customer/orders_controller.rb
 - app/controllers/spree/api/v3/store/customer/payment_setup_sessions_controller.rb
+- app/controllers/spree/api/v3/store/customers_controller.rb
 - app/controllers/spree/api/v3/store/digitals_controller.rb
 - app/controllers/spree/api/v3/store/locales_controller.rb
 - app/controllers/spree/api/v3/store/markets/countries_controller.rb
@@ -140,26 +146,46 @@ files:
 - app/controllers/spree/api/v3/store/products/filters_controller.rb
 - app/controllers/spree/api/v3/store/products_controller.rb
 - app/controllers/spree/api/v3/store/resource_controller.rb
-- app/controllers/spree/api/v3/store/stores_controller.rb
-- app/controllers/spree/api/v3/store/taxonomies_controller.rb
-- app/controllers/spree/api/v3/store/taxons/products_controller.rb
-- app/controllers/spree/api/v3/store/taxons_controller.rb
 - app/controllers/spree/api/v3/store/wishlist_items_controller.rb
 - app/controllers/spree/api/v3/store/wishlists_controller.rb
 - app/jobs/spree/api_keys/mark_as_used.rb
 - app/jobs/spree/webhook_delivery_job.rb
 - app/serializers/spree/api/v3/address_serializer.rb
+- app/serializers/spree/api/v3/admin/address_serializer.rb
+- app/serializers/spree/api/v3/admin/adjustment_serializer.rb
+- app/serializers/spree/api/v3/admin/admin_user_serializer.rb
+- app/serializers/spree/api/v3/admin/asset_serializer.rb
+- app/serializers/spree/api/v3/admin/category_serializer.rb
+- app/serializers/spree/api/v3/admin/credit_card_serializer.rb
 - app/serializers/spree/api/v3/admin/customer_serializer.rb
+- app/serializers/spree/api/v3/admin/digital_link_serializer.rb
+- app/serializers/spree/api/v3/admin/image_serializer.rb
 - app/serializers/spree/api/v3/admin/line_item_serializer.rb
 - app/serializers/spree/api/v3/admin/metafield_serializer.rb
+- app/serializers/spree/api/v3/admin/option_type_serializer.rb
+- app/serializers/spree/api/v3/admin/option_value_serializer.rb
+- app/serializers/spree/api/v3/admin/order_promotion_serializer.rb
 - app/serializers/spree/api/v3/admin/order_serializer.rb
+- app/serializers/spree/api/v3/admin/payment_method_serializer.rb
+- app/serializers/spree/api/v3/admin/payment_serializer.rb
+- app/serializers/spree/api/v3/admin/payment_source_serializer.rb
 - app/serializers/spree/api/v3/admin/price_serializer.rb
 - app/serializers/spree/api/v3/admin/product_serializer.rb
-- app/serializers/spree/api/v3/admin/taxon_serializer.rb
-- app/serializers/spree/api/v3/admin/taxonomy_serializer.rb
+- app/serializers/spree/api/v3/admin/refund_serializer.rb
+- app/serializers/spree/api/v3/admin/reimbursement_serializer.rb
+- app/serializers/spree/api/v3/admin/return_authorization_serializer.rb
+- app/serializers/spree/api/v3/admin/shipment_serializer.rb
+- app/serializers/spree/api/v3/admin/shipping_category_serializer.rb
+- app/serializers/spree/api/v3/admin/shipping_method_serializer.rb
+- app/serializers/spree/api/v3/admin/shipping_rate_serializer.rb
+- app/serializers/spree/api/v3/admin/stock_item_serializer.rb
+- app/serializers/spree/api/v3/admin/stock_location_serializer.rb
+- app/serializers/spree/api/v3/admin/store_credit_serializer.rb
+- app/serializers/spree/api/v3/admin/tax_category_serializer.rb
 - app/serializers/spree/api/v3/admin/variant_serializer.rb
 - app/serializers/spree/api/v3/asset_serializer.rb
 - app/serializers/spree/api/v3/base_serializer.rb
+- app/serializers/spree/api/v3/category_serializer.rb
 - app/serializers/spree/api/v3/country_serializer.rb
 - app/serializers/spree/api/v3/credit_card_serializer.rb
 - app/serializers/spree/api/v3/currency_serializer.rb
@@ -197,6 +223,7 @@ files:
 - app/serializers/spree/api/v3/return_authorization_serializer.rb
 - app/serializers/spree/api/v3/return_item_serializer.rb
 - app/serializers/spree/api/v3/shipment_serializer.rb
+- app/serializers/spree/api/v3/shipping_category_serializer.rb
 - app/serializers/spree/api/v3/shipping_method_serializer.rb
 - app/serializers/spree/api/v3/shipping_rate_serializer.rb
 - app/serializers/spree/api/v3/state_serializer.rb
@@ -205,14 +232,11 @@ files:
 - app/serializers/spree/api/v3/stock_movement_serializer.rb
 - app/serializers/spree/api/v3/stock_transfer_serializer.rb
 - app/serializers/spree/api/v3/store_credit_serializer.rb
-- app/serializers/spree/api/v3/store_serializer.rb
-- app/serializers/spree/api/v3/taxon_serializer.rb
-- app/serializers/spree/api/v3/taxonomy_serializer.rb
+- app/serializers/spree/api/v3/tax_category_serializer.rb
 - app/serializers/spree/api/v3/variant_serializer.rb
 - app/serializers/spree/api/v3/wished_item_serializer.rb
 - app/serializers/spree/api/v3/wishlist_serializer.rb
 - app/services/spree/api/v3/filters_aggregator.rb
-- app/services/spree/api/v3/orders/update.rb
 - app/services/spree/webhooks/deliver_webhook.rb
 - app/subscribers/spree/webhook_event_subscriber.rb
 - config/brakeman.ignore
@@ -239,9 +263,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.beta4
+  changelog_uri: https://github.com/spree/spree/releases/tag/v5.4.0.beta6
   documentation_uri: https://docs.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.beta4
+  source_code_uri: https://github.com/spree/spree/tree/v5.4.0.beta6
 post_install_message:
 rdoc_options: []
 require_paths:

data/app/controllers/spree/api/v3/store/customer/account_controller.rb

@@ -1,38 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Store
-        module Customer
-          class AccountController < Store::BaseController
-            prepend_before_action :require_authentication!
-
-            # GET /api/v3/store/customer
-            def show
-              render json: serialize_resource(current_user)
-            end
-
-            # PATCH /api/v3/store/customer
-            def update
-              if current_user.update(permitted_params)
-                render json: serialize_resource(current_user)
-              else
-                render_errors(current_user.errors)
-              end
-            end
-
-            protected
-
-            def serializer_class
-              Spree.api.customer_serializer
-            end
-
-            def permitted_params
-              params.permit(:email, :password, :password_confirmation, :first_name, :last_name,
-                            :accepts_email_marketing, :phone)
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v3/store/stores_controller.rb

@@ -1,26 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Store
-        class StoresController < ResourceController
-          skip_before_action :set_resource
-
-          # GET /api/v3/store/store
-          def show
-            render json: serialize_resource(current_store)
-          end
-
-          protected
-
-          def model_class
-            Spree::Store
-          end
-
-          def serializer_class
-            Spree.api.store_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v3/store/taxonomies_controller.rb

@@ -1,19 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Store
-        class TaxonomiesController < ResourceController
-          protected
-
-          def model_class
-            Spree::Taxonomy
-          end
-
-          def serializer_class
-            Spree.api.taxonomy_serializer
-          end
-        end
-      end
-    end
-  end
-end

data/app/controllers/spree/api/v3/store/taxons/products_controller.rb

@@ -1,37 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Store
-        module Taxons
-          class ProductsController < Store::ProductsController
-            before_action :set_taxon
-
-            protected
-
-            def set_taxon
-              @taxon = find_taxon
-            end
-
-            def scope
-              super.in_taxon(@taxon)
-            end
-
-            private
-
-            def find_taxon
-              id = params[:taxon_id]
-              taxon_scope = Spree::Taxon.for_store(current_store).accessible_by(current_ability, :show)
-              taxon_scope = taxon_scope.i18n if Spree::Taxon.include?(Spree::TranslatableResource)
-
-              if id.to_s.start_with?('txn_')
-                taxon_scope.find_by_prefix_id!(id)
-              else
-                find_with_fallback_default_locale { taxon_scope.i18n.find_by!(permalink: id) }
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v3/admin/taxon_serializer.rb

@@ -1,20 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Admin
-        # Admin API Taxon Serializer
-        # Full taxon data including admin-only fields
-        class TaxonSerializer < V3::TaxonSerializer
-          typelize lft: :number, rgt: :number
-
-          # Nested set columns for tree operations
-          attributes :lft, :rgt
-
-          many :metafields,
-               resource: Spree.api.admin_metafield_serializer,
-               if: proc { params[:expand]&.include?('metafields') }
-        end
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v3/admin/taxonomy_serializer.rb

@@ -1,15 +0,0 @@
-module Spree
-  module Api
-    module V3
-      module Admin
-        # Admin API Taxonomy Serializer
-        # Full taxonomy data including admin-only fields
-        class TaxonomySerializer < V3::TaxonomySerializer
-          many :metafields,
-               resource: Spree.api.admin_metafield_serializer,
-               if: proc { params[:expand]&.include?('metafields') }
-        end
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v3/store_serializer.rb

@@ -1,38 +0,0 @@
-module Spree
-  module Api
-    module V3
-      class StoreSerializer < BaseSerializer
-        typelize name: :string, url: :string, meta_description: [:string, nullable: true],
-                 meta_keywords: [:string, nullable: true], seo_title: [:string, nullable: true],
-                 code: :string,
-                 facebook: [:string, nullable: true], twitter: [:string, nullable: true], instagram: [:string, nullable: true],
-                 customer_support_email: [:string, nullable: true],
-                 favicon_image_url: [:string, nullable: true],
-                 logo_image_url: [:string, nullable: true], social_image_url: [:string, nullable: true]
-
-        attributes :name, :url, :meta_description, :meta_keywords, :seo_title,
-                   :code, :facebook, :twitter,
-                   :instagram, :customer_support_email,
-                   created_at: :iso8601, updated_at: :iso8601
-
-        attribute :favicon_image_url do |store|
-          image_url_for(store.favicon_image)
-        end
-
-        attribute :logo_image_url do |store|
-          image_url_for(store.logo)
-        end
-
-        attribute :social_image_url do |store|
-          image_url_for(store.social_image)
-        end
-
-        many :payment_methods,
-             proc { |payment_methods, _params|
-               payment_methods.select { |pm| pm.available_on_front_end? && pm.active? }
-             },
-             resource: Spree.api.payment_method_serializer
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v3/taxon_serializer.rb

@@ -1,78 +0,0 @@
-module Spree
-  module Api
-    module V3
-      class TaxonSerializer < BaseSerializer
-        typelize name: :string, permalink: :string, position: :number, depth: :number,
-                 meta_title: [:string, nullable: true], meta_description: [:string, nullable: true], meta_keywords: [:string, nullable: true],
-                 parent_id: [:string, nullable: true], taxonomy_id: :string, children_count: :number,
-                 description: :string, description_html: :string,
-                 image_url: [:string, nullable: true], square_image_url: [:string, nullable: true],
-                 is_root: :boolean, is_child: :boolean, is_leaf: :boolean
-
-        attributes :name, :permalink, :position, :depth,
-                   :meta_title, :meta_description, :meta_keywords,
-                   :children_count,
-                   created_at: :iso8601, updated_at: :iso8601
-
-        attribute :parent_id do |taxon|
-          taxon.parent&.prefixed_id
-        end
-
-        attribute :taxonomy_id do |taxon|
-          taxon.taxonomy&.prefixed_id
-        end
-
-        attribute :description do |taxon|
-          taxon.description&.to_plain_text.to_s
-        end
-
-        attribute :description_html do |taxon|
-          taxon.description&.body&.to_s.to_s
-        end
-
-        attribute :image_url do |taxon|
-          image_url_for(taxon.image)
-        end
-
-        attribute :square_image_url do |taxon|
-          image_url_for(taxon.square_image)
-        end
-
-        attribute :is_root do |taxon|
-          taxon.root?
-        end
-
-        attribute :is_child do |taxon|
-          taxon.child?
-        end
-
-        attribute :is_leaf do |taxon|
-          taxon.leaf?
-        end
-
-        # Conditional associations
-        # Note: We pass empty expand to nested taxons to prevent infinite recursion
-        # (e.g., ancestors trying to load their own ancestors)
-        one :parent,
-            resource: Spree.api.taxon_serializer,
-            if: proc { params[:expand]&.include?('parent') },
-            params: { expand: [] }
-
-        many :children,
-             resource: Spree.api.taxon_serializer,
-             if: proc { params[:expand]&.include?('children') },
-             params: { expand: [] }
-
-        many :ancestors,
-             resource: Spree.api.taxon_serializer,
-             if: proc { params[:expand]&.include?('ancestors') },
-             params: { expand: [] }
-
-        many :public_metafields,
-             key: :metafields,
-             resource: Spree.api.metafield_serializer,
-             if: proc { params[:expand]&.include?('metafields') }
-      end
-    end
-  end
-end

data/app/serializers/spree/api/v3/taxonomy_serializer.rb

@@ -1,33 +0,0 @@
-module Spree
-  module Api
-    module V3
-      class TaxonomySerializer < BaseSerializer
-        typelize name: :string, position: :number, root_id: [:string, nullable: true]
-
-        attributes :name, :position,
-                   created_at: :iso8601, updated_at: :iso8601
-
-        attribute :root_id do |taxonomy|
-          taxonomy.root&.prefixed_id
-        end
-
-        # Conditional associations
-        # Note: We pass empty expand to nested taxons to prevent infinite recursion
-        one :root,
-            resource: Spree.api.taxon_serializer,
-            if: proc { params[:expand]&.include?('root') },
-            params: { expand: [] }
-
-        many :taxons,
-             resource: Spree.api.taxon_serializer,
-             if: proc { params[:expand]&.include?('taxons') },
-             params: { expand: [] }
-
-        many :public_metafields,
-             key: :metafields,
-             resource: Spree.api.metafield_serializer,
-             if: proc { params[:expand]&.include?('metafields') }
-      end
-    end
-  end
-end