Solidus JSON API 0.3.0
- Support
status
andcode
for Error Objects
When an error is handed back to the user, we now provide the status and the code keys. This adds another feature to the API that is supported by the JSON API specification.
- Add Friendly ID Support for
Spree::Product
When a request came in for /api/v2/products/example-product
and there was a product in the DB with a corresponding slug, it would return a 404. The controller now calls Spree::Product.friendly
before rendering any instance.
- Drop Spree Support
After trying to get the spree support working, I’ve concluded that its just not worth it. I know there’s a lot of you out there that really want this. If you truly need to keep using Spree, please fork this repo and make the necessary changes.
- The project has been renamed from
spree_api_v2
tosolidus_json_api
. Since the Spree project is no longer maintained, then there's no reason to give Spree a second API version. This means that you need to update the following code:
### Before ###
# Gemfile
gem 'spree_api_v2'
# config/initializers/spree_api_v2.rb
SolidusApiV2.setup do |config|
config.parent_serializer = ApplicationSerializer
end
### After ###
# Gemfile
gem 'solidus_json_api'
# config/initializers/solidus_json_api.rb
SolidusJsonApi.setup do |config|
config.parent_serializer = ApplicationSerializer
end
- In Spree, you will receive an error if the stock is not sufficient when updating a line item. This is done in this project since the API requires it. However, when transition to Solidus, we discovered that this feature was constrained to the complete state. We've added a validation check before saving a line item. Please open an issue if you believe this to be an anti-pattern.
- Removed
Spree::Order#considered_risky
from the JSON response since Solidus doesn't support this anymore. Spree::Variant#depth
,Spree::Variant#width
, andSpree::Variant#height
now returnnull
instead of""
when empty.
// Before
{
"type" : "spree_variant",
"data" : {
"attributes" : {
"depth" : "",
"width" : "",
"height" : "",
...
}
}
}
// After
{
"type" : "spree_variant",
"data" : {
"attributes" : {
"depth" : null,
"width" : null,
"height" : null,
...
}
}
}
Spree::LineItem#additional_tax_total
andSpree::LineItem#adjustment_total
now return as strings instead of floats in the api:
// Before
{
"type" : "spree_line_item",
"data" : {
"attributes" : {
"additional_tax_total" : 0,
"adjustment_total" : 0.0,
...
}
}
}
// After
{
"type" : "spree_line_item",
"data" : {
"attributes" : {
"additional_tax_total" : "0",
"adjustment_total" : "0.0",
...
}
}
}
- For Orders, you can now list them. A user can only view their own orders. If the user is an admin, they can view all of the orders.
- POST
/api/v2/line_items
now requires JSON API format instead of the rails format.
# Before
curl "https://example.com/api/v2/line_items"
-X POST
-d token=abc123
-d line_item[order_id]=1
-d line_item[variant_id]=1
-d line_item[quantity]=1
# After
curl "https://example.com/api/v2/line_items"
-X POST
-d token=abc123
-d data[attributes][order_id]=1
-d data[attributes][variant_id]=1
-d data[attributes][quantity]=1