Skip to content

Commit c6a2849

Browse files
github-actions[bot]NicolasGorgashahednasser
authored
chore(docs): Updated API Reference (automated) (#14808)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action --- > [!NOTE] > **Medium Risk** > Medium risk because it changes the published OpenAPI contract (adds `DELETE /admin/users/{id}/roles/{role_id}` and removes store credit endpoints), which can affect generated clients and documentation consumers. > > **Overview** > **Regenerates the API Reference/OpenAPI outputs** across `www/apps/api-reference` and `www/utils/generated`. > > Adds the `DELETE /admin/users/{id}/roles/{role_id}` endpoint (with new path spec and cURL sample) and removes store credit routes from the specs (`POST /admin/store-credit-accounts/{id}/credit` and `POST /store/store-credit-accounts/claim`), along with related code-sample files. > > Updates schemas to make stock location address `metadata` required and removes `images` from the *required* lists of product variant schemas; also removes the `AdminTransactionGroup` schema and related sidebar entries. Fixes several generated code-sample formatting issues (e.g., stray markdown fences, ID placeholders in order-edit examples). > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit 2e4ff86. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> Co-authored-by: Nicolas Gorga <62995075+NicolasGorga@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
1 parent fb7865f commit c6a2849

42 files changed

Lines changed: 201 additions & 690 deletions

File tree

Some content is hidden

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

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

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -621,13 +621,6 @@ const generatedgeneratedAdminSidebarSidebar = {
621621
"loaded": false,
622622
"showLoadingIfEmpty": true
623623
},
624-
{
625-
"type": "category",
626-
"title": "Rbac",
627-
"children": [],
628-
"loaded": false,
629-
"showLoadingIfEmpty": true
630-
},
631624
{
632625
"type": "category",
633626
"title": "Refund Reasons",
@@ -898,24 +891,6 @@ const generatedgeneratedAdminSidebarSidebar = {
898891
"loaded": false,
899892
"showLoadingIfEmpty": true
900893
},
901-
{
902-
"type": "category",
903-
"title": "Transaction Groups",
904-
"children": [
905-
{
906-
"type": "link",
907-
"path": "transaction-groups_transactiongroup_schema",
908-
"title": "TransactionGroup Object",
909-
"loaded": true,
910-
"badge": {
911-
"variant": "neutral",
912-
"text": "Schema"
913-
}
914-
}
915-
],
916-
"loaded": false,
917-
"showLoadingIfEmpty": true
918-
},
919894
{
920895
"type": "category",
921896
"title": "Translations",

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_item_{item_id}/post.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.updateOriginalItem(
12-
"order_123",
12+
"order_123",
1313
"orli_123",
1414
{
1515
quantity: 1

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/delete.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.removeAddedItem(
12-
"order_123",
12+
"order_123",
1313
"orli_123",
1414
)
1515
.then(({ order_preview }) => {

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_order-edits_{id}_items_{action_id}/post.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export const sdk = new Medusa({
99
})
1010

1111
sdk.admin.orderEdit.updateAddedItem(
12-
"order_123",
12+
"order_123",
1313
"orli_123",
1414
{
1515
quantity: 1

www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_translations_batch/post.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,4 @@ sdk.admin.translation.batch({
2727
})
2828
.then(({ created, updated, deleted }) => {
2929
console.log(created, updated, deleted)
30-
})
31-
```
30+
})

www/apps/api-reference/specs/admin/code_samples/Shell/admin_store-credit-accounts_{id}_credit/post.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
curl -X DELETE '{backend_url}/admin/users/{id}/roles/{role_id}' \
2+
-H 'Authorization: Bearer {access_token}'

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ required:
1111
- ean
1212
- upc
1313
- thumbnail
14-
- images
1514
- allow_backorder
1615
- manage_inventory
1716
- hs_code

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ properties:
4343
externalDocs:
4444
url: https://en.wikipedia.org/wiki/ISO_3166-2
4545
description: Learn more about ISO 3166-2
46+
metadata:
47+
type: object
48+
description: The address's metadata.
4649
required:
4750
- id
4851
- address_1
@@ -53,3 +56,4 @@ required:
5356
- phone
5457
- postal_code
5558
- province
59+
- metadata

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

Lines changed: 0 additions & 40 deletions
This file was deleted.

0 commit comments

Comments
 (0)