solidus_api 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a182483bb4316706abeabf33d4edc60a128dfdc32765f9c637e1a46f67aba85b
-  data.tar.gz: 8c279ed0daeeaacec566c63e572db03838574f1a7836fac953d1c18e99fe29ca
+  metadata.gz: c2e97aae9b9a89da9adc6ccb4aff753d8226089a4567042aca7d1bc5abb3ffd9
+  data.tar.gz: c4f276a907bcc0f33e38df478f5f092118440d048740ee8cf94c95a70339e4db
 SHA512:
-  metadata.gz: a40c60e2f38aebd01156f3869580aff5ba6fc11d3aa3084e614737b6c422f3f8de8e5ed102690801f1ba7cbd03e966630307613eb4710cacd50d3381d64c3e46
-  data.tar.gz: dddb0e1ead11d14a27a91d1bdd1d9c1d61b7a7367f07dfaa89e7c582493290a070e299df638e0d55be36a67cac299aa28161007a99b399c85bac912894341ba2
+  metadata.gz: b1cccc0ea3b020ec33d3cf583c37f175b434c9b0f052c7f946624512b667d2b5beaec0151c84e65c5ad9dd8b6639cf1e09d8aeb0ffd6e35b0b7050a77ba387c5
+  data.tar.gz: bb950c56a91378c8dbe7ea0d5a78589038755ba832ba7ecf2384454921acde6ac9c43170a13ae3aa292faee3311773bef76d2933eed2d461d0fada6ffda96cd2

data/app/controllers/spree/api/checkouts_controller.rb

@@ -42,7 +42,7 @@ module Spree
       def update
         authorize! :update, @order, order_token
 
-        if OrderUpdateAttributes.new(@order, update_params, request_env: request.headers.env).apply
+        if Spree::Config.order_update_attributes_class.new(@order, update_params, request_env: request.headers.env).call
           if can?(:admin, @order) && user_id.present?
             @order.associate_user!(Spree.user_class.find(user_id))
           end

data/app/controllers/spree/api/shipments_controller.rb

@@ -127,7 +127,8 @@ module Spree
           current_shipment: @original_shipment,
           desired_shipment: @desired_shipment,
           variant: @variant,
-          quantity: @quantity
+          quantity: @quantity,
+          track_inventory: Spree::Config.track_inventory_levels
         )
 
         if fulfilment_changer.run!

data/openapi/authentication.md

@@ -10,6 +10,8 @@ You can use your API key to access all resources in the API. The API key must be
 Authorization: Bearer API_KEY
 ```
 
+For a client to obtain the API key for a user, you'll first need to implement a custom sign-in strategy. It might depend on your setup, but a common approach is leveraging solidus_auth_devise, as [explained in our guides](https://guides.solidus.io/how-tos/how-to-sign-in-to-the-solidus-api-using-solidus_auth_devise).
+
 As an admin, you can find your API token in the admin section under Users > Your e-email > API Access (at `admin/users/<user_id>/edit`)
 
 Example:
@@ -20,6 +22,8 @@ curl --header "Authorization: Bearer 1a6a9936ad150a2ee345c65331da7a3ccc2de" http
 
 By default, API keys are only generated for admins, but you can easily customize Solidus to generate them for all users, which is useful for instance if you want users to be able to sign in and manage their profile via the API.
 
+The `API key` is mandatory for each endpoint by default. You can change this configuration [with the Spree::Api::Config.requires_authentication preference](https://github.com/solidusio/solidus/blob/2b79f72aa53f5caa850c587888fff46c1c91f7b7/api/lib/spree/api_configuration.rb#L5) to avoid the default behavior and expose some endpoints without an API key. An example could be the [GET product list](https://solidus.stoplight.io/docs/solidus/08307f3d809e7-list-products) endpoint.
+
 ### Order token
 
 For allowing guests to manage their cart and place their order, you can use the order's guest token. This token is contained in the `guest_token` property of the order, and it allows you to perform certain checkout-related operations on the order such as managing line items, completing the checkout flow etc.

data/openapi/solidus-api.oas.yml

@@ -1,4 +1,7 @@
 openapi: 3.0.3
+x-stoplight:
+  docs:
+    showModels: false
 info:
   title: Solidus API
   version: '1.0'
@@ -8,9 +11,6 @@ info:
     url: 'https://solidus.io'
   license:
     name: ''
-x-stoplight:
-  docs:
-    showModels: false
 paths:
   /products:
     get:
@@ -229,7 +229,6 @@ paths:
         - Orders
       security:
         - api-key: []
-        - order-token: []
   /countries:
     get:
       responses:
@@ -5925,9 +5924,9 @@ components:
                 type: integer
   securitySchemes:
     api-key:
-      type: apiKey
-      name: Authorization
-      in: header
+      type: http
+      scheme: bearer
+      description: 'The `API key` is mandatory for each endpoint by default. You can change this configuration [with the Spree::Api::Config.requires_authentication preference](https://github.com/solidusio/solidus/blob/2b79f72aa53f5caa850c587888fff46c1c91f7b7/api/lib/spree/api_configuration.rb#L5) to avoid the default behavior and expose some endpoints without an API key. An example could be the [GET product list](https://solidus.stoplight.io/docs/solidus/08307f3d809e7-list-products) endpoint.'
     order-token:
       type: apiKey
       name: X-Spree-Order-Token

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_api
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.4.0
 platform: ruby
 authors:
 - Solidus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-14 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: 3.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: 3.4.0
 description: REST API for the Solidus e-commerce framework.
 email: contact@solidus.io
 executables: []