Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Rename assets → media in admin API, SDK, and SPA

Damian Legawiecea9ea026d978
diff --git a/packages/admin-sdk/src/admin-client.ts b/packages/admin-sdk/src/admin-client.ts
index 34f3c0bdfa..6c57ee651f 100644
--- a/packages/admin-sdk/src/admin-client.ts
+++ b/packages/admin-sdk/src/admin-client.ts
@@ -38,13 +38,13 @@ export interface MeResponse {
};
permissions: PermissionRule[];
}
-import type { Store, Product, Order, Asset, Category, TaxCategory } from './types';
+import type { Store, Product, Order, Media, Category, TaxCategory } from './types';
import type {
StoreUpdateParams,
ProductUpdateParams,
OrderUpdateParams,
- AssetCreateParams,
- AssetUpdateParams,
+ MediaCreateParams,
+ MediaUpdateParams,
LineItemCreateParams,
LineItemUpdateParams,
AdjustmentCreateParams,
@@ -117,21 +117,21 @@ export class AdminClient {
delete: (id: string, options?: RequestOptions): Promise<void> =>
this.request<void>('DELETE', `/products/${id}`, options),
- assets: {
- list: (productId: string, params?: ListParams & Record<string, unknown>, options?: RequestOptions): Promise<PaginatedResponse<Asset>> =>
- this.request<PaginatedResponse<Asset>>('GET', `/products/${productId}/assets`, {
+ media: {
+ list: (productId: string, params?: ListParams & Record<string, unknown>, options?: RequestOptions): Promise<PaginatedResponse<Media>> =>
+ this.request<PaginatedResponse<Media>>('GET', `/products/${productId}/media`, {
...options,
params: params ? transformListParams(params) : undefined,
}),
- create: (productId: string, params: AssetCreateParams, options?: RequestOptions): Promise<Asset> =>
- this.request<Asset>('POST', `/products/${productId}/assets`, { ...options, body: params }),
+ create: (productId: string, params: MediaCreateParams, options?: RequestOptions): Promise<Media> =>
+ this.request<Media>('POST', `/products/${productId}/media`, { ...options, body: params }),
- update: (productId: string, id: string, params: AssetUpdateParams, options?: RequestOptions): Promise<Asset> =>
- this.request<Asset>('PATCH', `/products/${productId}/assets/${id}`, { ...options, body: params }),
+ update: (productId: string, id: string, params: MediaUpdateParams, options?: RequestOptions): Promise<Media> =>
+ this.request<Media>('PATCH', `/products/${productId}/media/${id}`, { ...options, body: params }),
delete: (productId: string, id: string, options?: RequestOptions): Promise<void> =>
- this.request<void>('DELETE', `/products/${productId}/assets/${id}`, options),
+ this.request<void>('DELETE', `/products/${productId}/media/${id}`, options),
},
};
diff --git a/packages/admin-sdk/src/params.ts b/packages/admin-sdk/src/params.ts
index af7798cd1f..ac60d4879d 100644
--- a/packages/admin-sdk/src/params.ts
+++ b/packages/admin-sdk/src/params.ts
@@ -129,7 +129,7 @@ export interface DirectUploadCreateParams {
};
}
-export interface AssetCreateParams {
+export interface MediaCreateParams {
alt?: string;
position?: number;
type?: string;
@@ -137,7 +137,7 @@ export interface AssetCreateParams {
signed_id?: string;
}
-export interface AssetUpdateParams {
+export interface MediaUpdateParams {
alt?: string;
position?: number;
}
diff --git a/packages/admin-sdk/tests/mocks/admin-handlers.ts b/packages/admin-sdk/tests/mocks/admin-handlers.ts
index 952df09ce7..65663c3bfc 100644
--- a/packages/admin-sdk/tests/mocks/admin-handlers.ts
+++ b/packages/admin-sdk/tests/mocks/admin-handlers.ts
@@ -21,7 +21,7 @@ export const adminFixtures = {
weight: '1.5',
track_inventory: true,
},
- asset: {
+ media: {
id: 'asset_1',
alt: 'Product image',
position: 1,
@@ -256,46 +256,46 @@ export const adminHandlers = [
// ============================================
// Product Assets
// ============================================
- http.get(`${API_PREFIX}/products/:productId/assets`, () =>
- HttpResponse.json({ data: [adminFixtures.asset], meta: paginationMeta })
+ http.get(`${API_PREFIX}/products/:productId/media`, () =>
+ HttpResponse.json({ data: [adminFixtures.media], meta: paginationMeta })
),
- http.post(`${API_PREFIX}/products/:productId/assets`, async ({ request }) => {
+ http.post(`${API_PREFIX}/products/:productId/media`, async ({ request }) => {
const body = await request.json() as Record<string, unknown>;
if (body.url) {
return new HttpResponse(null, { status: 202 });
}
- return HttpResponse.json(adminFixtures.asset, { status: 201 });
+ return HttpResponse.json(adminFixtures.media, { status: 201 });
}),
- http.patch(`${API_PREFIX}/products/:productId/assets/:id`, () =>
- HttpResponse.json({ ...adminFixtures.asset, alt: 'Updated alt' })
+ http.patch(`${API_PREFIX}/products/:productId/media/:id`, () =>
+ HttpResponse.json({ ...adminFixtures.media, alt: 'Updated alt' })
),
- http.delete(`${API_PREFIX}/products/:productId/assets/:id`, () =>
+ http.delete(`${API_PREFIX}/products/:productId/media/:id`, () =>
new HttpResponse(null, { status: 204 })
),
// ============================================
// Variant Assets
// ============================================
- http.get(`${API_PREFIX}/products/:productId/variants/:variantId/assets`, () =>
- HttpResponse.json({ data: [adminFixtures.asset], meta: paginationMeta })
+ http.get(`${API_PREFIX}/products/:productId/variants/:variantId/media`, () =>
+ HttpResponse.json({ data: [adminFixtures.media], meta: paginationMeta })
),
- http.post(`${API_PREFIX}/products/:productId/variants/:variantId/assets`, async ({ request }) => {
+ http.post(`${API_PREFIX}/products/:productId/variants/:variantId/media`, async ({ request }) => {
const body = await request.json() as Record<string, unknown>;
if (body.url) {
return new HttpResponse(null, { status: 202 });
}
- return HttpResponse.json(adminFixtures.asset, { status: 201 });
+ return HttpResponse.json(adminFixtures.media, { status: 201 });
}),
- http.patch(`${API_PREFIX}/products/:productId/variants/:variantId/assets/:id`, () =>
- HttpResponse.json({ ...adminFixtures.asset, alt: 'Updated variant alt' })
+ http.patch(`${API_PREFIX}/products/:productId/variants/:variantId/media/:id`, () =>
+ HttpResponse.json({ ...adminFixtures.media, alt: 'Updated variant alt' })
),
- http.delete(`${API_PREFIX}/products/:productId/variants/:variantId/assets/:id`, () =>
+ http.delete(`${API_PREFIX}/products/:productId/variants/:variantId/media/:id`, () =>
new HttpResponse(null, { status: 204 })
),
diff --git a/packages/admin/src/hooks/use-product-assets.ts b/packages/admin/src/hooks/use-product-media.ts
similarity index 63%
rename from packages/admin/src/hooks/use-product-assets.ts
rename to packages/admin/src/hooks/use-product-media.ts
index eaf6afa16d..3581704e2b 100644
--- a/packages/admin/src/hooks/use-product-assets.ts
+++ b/packages/admin/src/hooks/use-product-media.ts
@@ -1,47 +1,47 @@
import { useQuery, useMutation, useQueryClient } from '@tanstack/react-query'
import { adminClient } from '@/client'
-export function useProductAssets(productId: string) {
+export function useProductMedia(productId: string) {
return useQuery({
- queryKey: ['products', productId, 'assets'],
- queryFn: () => adminClient.products.assets.list(productId),
+ queryKey: ['products', productId, 'media'],
+ queryFn: () => adminClient.products.media.list(productId),
enabled: !!productId,
})
}
-export function useCreateProductAsset(productId: string) {
+export function useCreateProductMedia(productId: string) {
const queryClient = useQueryClient()
return useMutation({
mutationFn: (params: { signed_id: string; alt?: string; position?: number }) =>
- adminClient.products.assets.create(productId, params),
+ adminClient.products.media.create(productId, params),
onSuccess: () => {
- queryClient.invalidateQueries({ queryKey: ['products', productId, 'assets'] })
+ queryClient.invalidateQueries({ queryKey: ['products', productId, 'media'] })
queryClient.invalidateQueries({ queryKey: ['products', productId] })
},
})
}
-export function useUpdateProductAsset(productId: string) {
+export function useUpdateProductMedia(productId: string) {
const queryClient = useQueryClient()
return useMutation({
mutationFn: ({ id, ...params }: { id: string; alt?: string; position?: number }) =>
- adminClient.products.assets.update(productId, id, params),
+ adminClient.products.media.update(productId, id, params),
onSuccess: () => {
- queryClient.invalidateQueries({ queryKey: ['products', productId, 'assets'] })
+ queryClient.invalidateQueries({ queryKey: ['products', productId, 'media'] })
},
})
}
-export function useDeleteProductAsset(productId: string) {
+export function useDeleteProductMedia(productId: string) {
const queryClient = useQueryClient()
return useMutation({
mutationFn: (id: string) =>
- adminClient.products.assets.delete(productId, id),
+ adminClient.products.media.delete(productId, id),
onSuccess: () => {
- queryClient.invalidateQueries({ queryKey: ['products', productId, 'assets'] })
+ queryClient.invalidateQueries({ queryKey: ['products', productId, 'media'] })
queryClient.invalidateQueries({ queryKey: ['products', productId] })
},
})
diff --git a/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx b/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
index e6e4907fbe..4dc5cc3336 100644
--- a/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
+++ b/packages/admin/src/routes/_authenticated/$storeId/products/$productId.tsx
@@ -57,10 +57,10 @@ import { Textarea } from '@/components/ui/textarea'
import { useDirectUpload } from '@/hooks/use-direct-upload'
import { useProduct, useUpdateProduct, useDeleteProduct } from '@/hooks/use-product'
import {
- useProductAssets,
- useCreateProductAsset,
- useDeleteProductAsset,
-} from '@/hooks/use-product-assets'
+ useProductMedia,
+ useCreateProductMedia,
+ useDeleteProductMedia,
+} from '@/hooks/use-product-media'
import { useTaxCategories } from '@/hooks/use-tax-categories'
import { useCategories } from '@/hooks/use-categories'
import { productFormSchema, type ProductFormValues } from '@/schemas/product'
@@ -280,14 +280,14 @@ interface PendingUpload {
}
function MediaCard({ productId }: { productId: string }) {
- const { data: assetsResponse } = useProductAssets(productId)
- const createAsset = useCreateProductAsset(productId)
- const deleteAsset = useDeleteProductAsset(productId)
+ const { data: mediaResponse } = useProductMedia(productId)
+ const createMedia = useCreateProductMedia(productId)
+ const deleteMedia = useDeleteProductMedia(productId)
const directUpload = useDirectUpload()
const [pending, setPending] = useState<PendingUpload[]>([])
const fileInputRef = useRef<HTMLInputElement>(null)
- const assets = assetsResponse?.data ?? []
+ const mediaItems = mediaResponse?.data ?? []
const handleFiles = useCallback(
async (files: FileList | File[]) => {
@@ -306,10 +306,10 @@ function MediaCard({ productId }: { productId: string }) {
prev.map((p) => (p.id === uploadId ? { ...p, progress: 'attaching' as const } : p)),
)
- await createAsset.mutateAsync({
+ await createMedia.mutateAsync({
signed_id: result.signedId,
alt: file.name,
- position: assets.length + fileArray.indexOf(file) + 1,
+ position: mediaItems.length + fileArray.indexOf(file) + 1,
})
setPending((prev) => prev.filter((p) => p.id !== uploadId))
@@ -324,7 +324,7 @@ function MediaCard({ productId }: { productId: string }) {
}
}
},
- [directUpload, createAsset, assets.length],
+ [directUpload, createMedia, mediaItems.length],
)
const handleDrop = useCallback(
@@ -341,9 +341,9 @@ function MediaCard({ productId }: { productId: string }) {
e.preventDefault()
}, [])
- const handleDeleteAsset = async (assetId: string) => {
+ const handleDeleteMedia = async (mediaId: string) => {
try {
- await deleteAsset.mutateAsync(assetId)
+ await deleteMedia.mutateAsync(mediaId)
toast.success('Image deleted')
} catch {
toast.error('Failed to delete image')
@@ -357,13 +357,13 @@ function MediaCard({ productId }: { productId: string }) {
</CardHeader>
<CardContent className="flex flex-col gap-4">
{/* Image grid */}
- {(assets.length > 0 || pending.length > 0) && (
+ {(mediaItems.length > 0 || pending.length > 0) && (
<div className="grid grid-cols-4 gap-3">
- {assets.map((asset) => (
+ {mediaItems.map((mediaItem) => (
<MediaThumbnail
- key={asset.id}
- asset={asset as unknown as Media}
- onDelete={() => handleDeleteAsset(asset.id)}
+ key={mediaItem.id}
+ mediaItem={mediaItem as unknown as Media}
+ onDelete={() => handleDeleteMedia(mediaItem.id)}
/>
))}
{pending.map((upload) => (
@@ -418,18 +418,18 @@ function MediaCard({ productId }: { productId: string }) {
}
function MediaThumbnail({
- asset,
+ mediaItem,
onDelete,
}: {
- asset: Media
+ mediaItem: Media
onDelete: () => void
}) {
- const imageUrl = asset.small_url || asset.mini_url || asset.original_url
+ const imageUrl = mediaItem.small_url || mediaItem.mini_url || mediaItem.original_url
return (
<div className="group relative aspect-square overflow-hidden rounded-lg border border-gray-200 bg-gray-50">
{imageUrl ? (
- <img src={imageUrl} alt={asset.alt ?? ''} className="size-full object-cover" />
+ <img src={imageUrl} alt={mediaItem.alt ?? ''} className="size-full object-cover" />
) : (
<div className="flex size-full items-center justify-center text-gray-400">
<ImagePlusIcon className="size-6" />
diff --git a/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/media_controller.rb
similarity index 83%
rename from spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb
rename to spree/api/app/controllers/spree/api/v3/admin/media_controller.rb
index 63a918df53..2b395331da 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/assets_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/media_controller.rb
@@ -2,7 +2,7 @@ module Spree
module Api
module V3
module Admin
- class AssetsController < ResourceController
+ class MediaController < ResourceController
def create
if permitted_params[:url].present?
create_from_url
@@ -27,7 +27,7 @@ module Spree
end
def serializer_class
- Spree.api.admin_asset_serializer
+ Spree.api.admin_media_serializer
end
def set_parent
@@ -45,19 +45,19 @@ module Spree
:images
end
- ALLOWED_ASSET_TYPES = -> { [Spree::Asset, *Spree::Asset.descendants].map(&:name).to_set.freeze }
+ ALLOWED_MEDIA_TYPES = -> { [Spree::Asset, *Spree::Asset.descendants].map(&:name).to_set.freeze }
def build_resource
- asset_type = permitted_params[:type] || 'Spree::Image'
+ media_type = permitted_params[:type] || 'Spree::Image'
- unless ALLOWED_ASSET_TYPES.call.include?(asset_type)
- raise ArgumentError, "Invalid asset type: #{asset_type}"
+ unless ALLOWED_MEDIA_TYPES.call.include?(media_type)
+ raise ArgumentError, "Invalid media type: #{media_type}"
end
- asset = @parent.images.build(permitted_params.except(:type, :url, :signed_id))
- asset.type = asset_type
+ media = @parent.images.build(permitted_params.except(:type, :url, :signed_id))
+ media.type = media_type
- asset
+ media
end
def permitted_params
diff --git a/spree/api/config/routes.rb b/spree/api/config/routes.rb
index 64c8263629..84ca88b717 100644
--- a/spree/api/config/routes.rb
+++ b/spree/api/config/routes.rb
@@ -110,9 +110,9 @@ Spree::Core::Engine.add_routes do
post :clone
end
resources :variants, controller: 'products/variants' do
- resources :assets, controller: 'assets', only: [:index, :create, :update, :destroy]
+ resources :media, controller: 'media', only: [:index, :create, :update, :destroy]
end
- resources :assets, controller: 'assets', only: [:index, :create, :update, :destroy]
+ resources :media, controller: 'media', only: [:index, :create, :update, :destroy]
end
# Categories
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/products/assets_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/products/media_controller_spec.rb
similarity index 95%
rename from spree/api/spec/controllers/spree/api/v3/admin/products/assets_controller_spec.rb
rename to spree/api/spec/controllers/spree/api/v3/admin/products/media_controller_spec.rb
index 3c42bdae92..807c4407cc 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/products/assets_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/products/media_controller_spec.rb
@@ -1,6 +1,6 @@
require 'spec_helper'
-RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
+RSpec.describe Spree::Api::V3::Admin::MediaController, type: :controller do
render_views
include_context 'API v3 Admin authenticated'
@@ -12,7 +12,7 @@ RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
describe 'product assets' do
describe 'GET #index' do
- it 'returns assets for the product' do
+ it 'returns media for the product' do
get :index, params: { product_id: product.prefixed_id }, as: :json
expect(response).to have_http_status(:ok)
@@ -63,7 +63,7 @@ RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
end
describe 'PATCH #update' do
- it 'updates the asset alt text' do
+ it 'updates the media alt text' do
patch :update, params: {
product_id: product.prefixed_id,
id: image.prefixed_id,
@@ -75,7 +75,7 @@ RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
expect(image.reload.alt).to eq('Updated alt text')
end
- it 'updates the asset position' do
+ it 'updates the media position' do
patch :update, params: {
product_id: product.prefixed_id,
id: image.prefixed_id,
@@ -106,7 +106,7 @@ RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
let!(:variant_image) { create(:image, viewable: variant) }
describe 'GET #index' do
- it 'returns assets for the variant' do
+ it 'returns media for the variant' do
get :index, params: { product_id: product.prefixed_id, variant_id: variant.prefixed_id }, as: :json
expect(response).to have_http_status(:ok)
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/products/media_signed_id_spec.rb
similarity index 86%
rename from spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rb
rename to spree/api/spec/controllers/spree/api/v3/admin/products/media_signed_id_spec.rb
index 79190df5b8..cdf0e43af6 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/products/assets_signed_id_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/products/media_signed_id_spec.rb
@@ -1,6 +1,6 @@
require 'spec_helper'
-RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
+RSpec.describe Spree::Api::V3::Admin::MediaController, type: :controller do
render_views
include_context 'API v3 Admin authenticated'
@@ -18,7 +18,7 @@ RSpec.describe Spree::Api::V3::Admin::AssetsController, type: :controller do
)
end
- it 'creates an asset from a signed blob ID' do
+ it 'creates a media item from a signed blob ID' do
post :create, params: {
product_id: product.prefixed_id,
signed_id: blob.signed_id,
diff --git a/spree/api/spec/integration/spree/api/v3/admin/product_assets_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/product_media_spec.rb
similarity index 93%
rename from spree/api/spec/integration/spree/api/v3/admin/product_assets_spec.rb
rename to spree/api/spec/integration/spree/api/v3/admin/product_media_spec.rb
index e04bbb90c4..21678551c2 100644
--- a/spree/api/spec/integration/spree/api/v3/admin/product_assets_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/admin/product_media_spec.rb
@@ -2,14 +2,14 @@
require 'swagger_helper'
-RSpec.describe 'Admin Product Assets API', type: :request, swagger_doc: 'api-reference/admin.yaml' do
+RSpec.describe 'Admin Product Media API', type: :request, swagger_doc: 'api-reference/admin.yaml' do
include_context 'API v3 Admin'
let!(:product) { create(:product, stores: [store]) }
let!(:image) { create(:image, viewable: product.master) }
let(:Authorization) { "Bearer #{admin_jwt_token}" }
- path '/api/v3/admin/products/{product_id}/assets' do
+ path '/api/v3/admin/products/{product_id}/media' do
get 'List product assets' do
tags 'Product Assets'
produces 'application/json'
@@ -23,7 +23,7 @@ RSpec.describe 'Admin Product Assets API', type: :request, swagger_doc: 'api-ref
parameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'
parameter name: :limit, in: :query, type: :integer, required: false, description: 'Number of records per page'
- response '200', 'assets found' do
+ response '200', 'media found' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
@@ -75,7 +75,7 @@ RSpec.describe 'Admin Product Assets API', type: :request, swagger_doc: 'api-ref
end
end
- path '/api/v3/admin/products/{product_id}/assets/{id}' do
+ path '/api/v3/admin/products/{product_id}/media/{id}' do
patch 'Update a product asset' do
tags 'Product Assets'
consumes 'application/json'
@@ -96,7 +96,7 @@ RSpec.describe 'Admin Product Assets API', type: :request, swagger_doc: 'api-ref
}
}
- response '200', 'asset updated' do
+ response '200', 'media updated' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
let(:id) { image.prefixed_id }
@@ -120,7 +120,7 @@ RSpec.describe 'Admin Product Assets API', type: :request, swagger_doc: 'api-ref
parameter name: :product_id, in: :path, type: :string, required: true, description: 'Product prefixed ID'
parameter name: :id, in: :path, type: :string, required: true, description: 'Asset prefixed ID'
- response '204', 'asset deleted' do
+ response '204', 'media deleted' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
let(:id) { image.prefixed_id }
diff --git a/spree/api/spec/integration/spree/api/v3/admin/variant_assets_spec.rb b/spree/api/spec/integration/spree/api/v3/admin/variant_media_spec.rb
similarity index 95%
rename from spree/api/spec/integration/spree/api/v3/admin/variant_assets_spec.rb
rename to spree/api/spec/integration/spree/api/v3/admin/variant_media_spec.rb
index 7ab07c4a90..be290d5972 100644
--- a/spree/api/spec/integration/spree/api/v3/admin/variant_assets_spec.rb
+++ b/spree/api/spec/integration/spree/api/v3/admin/variant_media_spec.rb
@@ -2,7 +2,7 @@
require 'swagger_helper'
-RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-reference/admin.yaml' do
+RSpec.describe 'Admin Variant Media API', type: :request, swagger_doc: 'api-reference/admin.yaml' do
include_context 'API v3 Admin'
let!(:product) { create(:product, stores: [store]) }
@@ -10,7 +10,7 @@ RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-ref
let!(:variant_image) { create(:image, viewable: variant) }
let(:Authorization) { "Bearer #{admin_jwt_token}" }
- path '/api/v3/admin/products/{product_id}/variants/{variant_id}/assets' do
+ path '/api/v3/admin/products/{product_id}/variants/{variant_id}/media' do
get 'List variant assets' do
tags 'Variant Assets'
produces 'application/json'
@@ -25,7 +25,7 @@ RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-ref
parameter name: :page, in: :query, type: :integer, required: false, description: 'Page number'
parameter name: :limit, in: :query, type: :integer, required: false, description: 'Number of records per page'
- response '200', 'variant assets found' do
+ response '200', 'variant media found' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
let(:variant_id) { variant.prefixed_id }
@@ -83,7 +83,7 @@ RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-ref
end
end
- path '/api/v3/admin/products/{product_id}/variants/{variant_id}/assets/{id}' do
+ path '/api/v3/admin/products/{product_id}/variants/{variant_id}/media/{id}' do
patch 'Update a variant asset' do
tags 'Variant Assets'
consumes 'application/json'
@@ -105,7 +105,7 @@ RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-ref
}
}
- response '200', 'variant asset updated' do
+ response '200', 'variant media updated' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
let(:variant_id) { variant.prefixed_id }
@@ -131,7 +131,7 @@ RSpec.describe 'Admin Variant Assets API', type: :request, swagger_doc: 'api-ref
parameter name: :variant_id, in: :path, type: :string, required: true, description: 'Variant prefixed ID'
parameter name: :id, in: :path, type: :string, required: true, description: 'Asset prefixed ID'
- response '204', 'variant asset deleted' do
+ response '204', 'variant media deleted' do
let(:'x-spree-api-key') { secret_api_key.plaintext_token }
let(:product_id) { product.prefixed_id }
let(:variant_id) { variant.prefixed_id }