spree_api 4.3.0.rc1 → 4.3.1

data/lib/spree/api/testing_support/v2/platform_contexts.rb

@@ -50,12 +50,12 @@ JSON_API_FILTER_DESCRIPTION = ''
 
 def json_api_include_parameter(example = '')
   let(:include) { nil }
-  parameter name: :include, in: :query, type: :string, descripton: JSON_API_INCLUDES_DESCRIPTION, example: example
+  parameter name: :include, in: :query, type: :string, description: JSON_API_INCLUDES_DESCRIPTION, example: example
 end
 
 def json_api_filter_parameter(example = '')
   let(:filter) { nil }
-  parameter name: :filter, in: :query, type: :string, descripton: JSON_API_FILTER_DESCRIPTION, example: example
+  parameter name: :filter, in: :query, type: :string, description: JSON_API_FILTER_DESCRIPTION, example: example
 end
 
 shared_examples 'authentication failed' do
@@ -121,6 +121,8 @@ shared_examples 'GET records list' do |resource_name, include_example, filter_ex
   get "Returns a list of #{resource_name.pluralize}" do
     tags resource_name.pluralize
     security [ bearer_auth: [] ]
+    description "Returns a list of #{resource_name.pluralize}"
+    operationId "#{resource_name.parameterize.pluralize.to_sym}-list"
     include_context 'jsonapi pagination'
     json_api_include_parameter(include_example)
     json_api_filter_parameter(filter_example)
@@ -137,6 +139,8 @@ shared_examples 'GET record' do |resource_name, include_example|
   get "Returns #{resource_name.articleize}" do
     tags resource_name.pluralize
     security [ bearer_auth: [] ]
+    description "Returns #{resource_name.articleize}"
+    operationId "show-#{resource_name.parameterize.to_sym}"
     parameter name: :id, in: :path, type: :string
     json_api_include_parameter(include_example)
 
@@ -148,12 +152,14 @@ end
 
 # create
 shared_examples 'POST create record' do |resource_name, include_example|
-  param_name = resource_name.parameterize.to_sym
+  param_name = resource_name.parameterize(separator: '_').to_sym
 
   post "Creates #{resource_name.articleize}" do
     tags resource_name.pluralize
     consumes 'application/json'
     security [ bearer_auth: [] ]
+    description "Creates #{resource_name.articleize}"
+    operationId "create-#{resource_name.parameterize.to_sym}"
     parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
     json_api_include_parameter(include_example)
 
@@ -166,11 +172,13 @@ end
 
 # update
 shared_examples 'PUT update record' do |resource_name, include_example|
-  param_name = resource_name.parameterize.to_sym
+  param_name = resource_name.parameterize(separator: '_').to_sym
 
   put "Updates #{resource_name.articleize}" do
     tags resource_name.pluralize
     security [ bearer_auth: [] ]
+    description "Updates #{resource_name.articleize}"
+    operationId "update-#{resource_name.parameterize.to_sym}"
     consumes 'application/json'
     parameter name: :id, in: :path, type: :string
     parameter name: param_name, in: :body, schema: { '$ref' => "#/components/schemas/#{param_name}_params" }
@@ -190,6 +198,8 @@ shared_examples 'DELETE record' do |resource_name|
   delete "Deletes #{resource_name.articleize}" do
     tags resource_name.pluralize
     security [ bearer_auth: [] ]
+    description "Deletes #{resource_name.articleize}"
+    operationId "delete-#{resource_name.parameterize.to_sym}"
     parameter name: :id, in: :path, type: :string
 
     it_behaves_like 'record deleted'
@@ -199,7 +209,7 @@ shared_examples 'DELETE record' do |resource_name|
 end
 
 shared_examples 'CRUD examples' do |resource_name, include_example, filter_example|
-  resource_path = resource_name.pluralize.parameterize
+  resource_path = resource_name.parameterize(separator: '_').pluralize
 
   path "/api/v2/platform/#{resource_path}" do
     include_examples 'GET records list', resource_name, include_example, filter_example

data/spree_api.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.metadata = {
     "bug_tracker_uri"   => "https://github.com/spree/spree/issues",
     "changelog_uri"     => "https://github.com/spree/spree/releases/tag/v#{s.version}",
-    "documentation_uri" => "https://guides.spreecommerce.org/",
+    "documentation_uri" => "https://dev-docs.spreecommerce.org/",
     "source_code_uri"   => "https://github.com/spree/spree/tree/v#{s.version}",
   }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_api
 version: !ruby/object:Gem::Version
-  version: 4.3.0.rc1
+  version: 4.3.1
 platform: ruby
 authors:
 - Ryan Bigg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-11 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi-rspec
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0.rc1
+        version: 4.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.3.0.rc1
+        version: 4.3.1
 - !ruby/object:Gem::Dependency
   name: rabl
   requirement: !ruby/object:Gem::Requirement
@@ -145,6 +145,7 @@ files:
 - Gemfile
 - LICENSE
 - Rakefile
+- app/controllers/concerns/spree/api/v2/caching.rb
 - app/controllers/concerns/spree/api/v2/product_list_includes.rb
 - app/controllers/concerns/spree/api/v2/storefront/order_concern.rb
 - app/controllers/spree/api/base_controller.rb
@@ -214,7 +215,10 @@ files:
 - app/models/concerns/spree/user_api_methods.rb
 - app/models/spree/api_configuration.rb
 - app/models/spree/api_dependencies.rb
+- app/presenters/spree/api/products/filters_presenter.rb
+- app/serializers/concerns/spree/api/v2/image_transformation_concern.rb
 - app/serializers/concerns/spree/api/v2/resource_serializer_concern.rb
+- app/serializers/concerns/spree/api/v2/taxon_image_transformation_concern.rb
 - app/serializers/spree/api/v2/base_serializer.rb
 - app/serializers/spree/api/v2/platform/address_serializer.rb
 - app/serializers/spree/api/v2/platform/base_serializer.rb
@@ -222,6 +226,7 @@ files:
 - app/serializers/spree/api/v2/platform/cms_page_serializer.rb
 - app/serializers/spree/api/v2/platform/cms_section_serializer.rb
 - app/serializers/spree/api/v2/platform/country_serializer.rb
+- app/serializers/spree/api/v2/platform/icon_serializer.rb
 - app/serializers/spree/api/v2/platform/image_serializer.rb
 - app/serializers/spree/api/v2/platform/menu_item_serializer.rb
 - app/serializers/spree/api/v2/platform/menu_serializer.rb
@@ -247,6 +252,7 @@ files:
 - app/serializers/spree/v2/storefront/country_serializer.rb
 - app/serializers/spree/v2/storefront/credit_card_serializer.rb
 - app/serializers/spree/v2/storefront/estimated_shipping_rate_serializer.rb
+- app/serializers/spree/v2/storefront/icon_serializer.rb
 - app/serializers/spree/v2/storefront/image_serializer.rb
 - app/serializers/spree/v2/storefront/line_item_serializer.rb
 - app/serializers/spree/v2/storefront/menu_item_serializer.rb
@@ -406,9 +412,9 @@ licenses:
 - BSD-3-Clause
 metadata:
   bug_tracker_uri: https://github.com/spree/spree/issues
-  changelog_uri: https://github.com/spree/spree/releases/tag/v4.3.0.rc1
-  documentation_uri: https://guides.spreecommerce.org/
-  source_code_uri: https://github.com/spree/spree/tree/v4.3.0.rc1
+  changelog_uri: https://github.com/spree/spree/releases/tag/v4.3.1
+  documentation_uri: https://dev-docs.spreecommerce.org/
+  source_code_uri: https://github.com/spree/spree/tree/v4.3.1
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -420,11 +426,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Spree's API