Skip to content

Commit 604ff55

Browse files
shahednassershahednasser
authored
docs: generate OAS for 2.11.2 (medusajs#13925)
1 parent 13d7d15 commit 604ff55

File tree

403 files changed

+22374
-10293
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

403 files changed

+22374
-10293
lines changed

‎www/apps/api-reference/generated/generated-admin-sidebar.mjs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,13 @@ const generatedgeneratedAdminSidebarSidebar = {
301301
"loaded": false,
302302
"showLoadingIfEmpty": true
303303
},
304+
{
305+
"type": "category",
306+
"title": "Index",
307+
"children": [],
308+
"loaded": false,
309+
"showLoadingIfEmpty": true
310+
},
304311
{
305312
"type": "category",
306313
"title": "Inventory Items",

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_images_{image_id}_variants_batch/post.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import Medusa from "@medusajs/js-sdk"
2+
3+
export const sdk = new Medusa({
4+
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
5+
debug: import.meta.env.DEV,
6+
auth: {
7+
type: "session",
8+
},
9+
})
10+
11+
sdk.admin.product.batchImageVariants("prod_123", "img_123", {
12+
add: ["variant_123", "variant_456"],
13+
remove: ["variant_789"]
14+
})
15+
.then(({ added, removed }) => {
16+
console.log(added, removed)
17+
})

‎www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_products_{id}_variants_{variant_id}_images_batch/post.js‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import Medusa from "@medusajs/js-sdk"
2+
3+
export const sdk = new Medusa({
4+
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
5+
debug: import.meta.env.DEV,
6+
auth: {
7+
type: "session",
8+
},
9+
})
10+
11+
sdk.admin.product.batchVariantImages("prod_123", "variant_123", {
12+
add: ["img_123", "img_456"],
13+
remove: ["img_789"]
14+
})
15+
.then(({ added, removed }) => {
16+
console.log(added, removed)
17+
})

‎www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_details/get.sh‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
curl '{backend_url}/admin/index/details' \
2+
-H 'Authorization: Bearer {access_token}'

‎www/apps/api-reference/specs/admin/code_samples/Shell/admin_index_sync/post.sh‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
curl -X POST '{backend_url}/admin/index/sync' \
2+
-H 'Authorization: Bearer {access_token}' \
3+
-H 'Content-Type: application/json' \
4+
--data-raw '{
5+
"strategy": "full"
6+
}'

‎www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_images_{image_id}_variants_batch/post.sh‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
curl -X POST '{backend_url}/admin/products/{id}/images/{image_id}/variants/batch' \
2+
-H 'Authorization: Bearer {access_token}' \
3+
-H 'Content-Type: application/json' \
4+
--data-raw '{
5+
"add": ["variant_123", "variant_456"],
6+
"remove": ["variant_789"]
7+
}'

‎www/apps/api-reference/specs/admin/code_samples/Shell/admin_products_{id}_variants_{variant_id}_images_batch/post.sh‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
curl -X POST '{backend_url}/admin/products/{id}/variants/{variant_id}/images/batch' \
2+
-H 'Authorization: Bearer {access_token}' \
3+
-H 'Content-Type: application/json' \
4+
--data-raw '{
5+
"add": ["img_123", "img_456"],
6+
"remove": ["img_789"]
7+
}'

www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimItemsReqSchema.yaml renamed to www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimItems.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
type: object
22
description: The details of the order items to add to the claim.
3-
x-schemaName: AdminPostClaimItemsReqSchema
3+
x-schemaName: AdminAddClaimItems
44
properties:
55
items:
66
type: array

‎www/apps/api-reference/specs/admin/components/schemas/AdminAddClaimOutboundItems.yaml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
type: object
2+
description: The details of the outbound items to add to the claim.
3+
x-schemaName: AdminAddClaimOutboundItems
4+
properties:
5+
items:
6+
type: array
7+
description: The outbound item's details.
8+
items:
9+
type: object
10+
description: An item's details.
11+
required:
12+
- id
13+
- quantity
14+
properties:
15+
quantity:
16+
type: number
17+
title: quantity
18+
description: The quantity to send to the customer.
19+
internal_note:
20+
type: string
21+
title: internal_note
22+
description: A note viewed only by admin users.
23+
id:
24+
type: string
25+
title: id
26+
description: The item's ID.
27+
reason:
28+
type: string
29+
description: The item's reason.
30+
enum:
31+
- missing_item
32+
- wrong_item
33+
- production_failure
34+
- other
35+
description:
36+
type: string
37+
title: description
38+
description: The item's description.

www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesReturnRequestItemsReqSchema.yaml renamed to www/apps/api-reference/specs/admin/components/schemas/AdminAddExchangeInboundItems.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
type: object
22
description: The details of the inbound (return) items.
3-
x-schemaName: AdminPostExchangesReturnRequestItemsReqSchema
3+
x-schemaName: AdminAddExchangeInboundItems
44
properties:
55
items:
66
type: array

0 commit comments

Comments
 (0)