asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: fixes to API and JS SDK references (#13795)

Browse Source
This commit is contained in:
Shahed Nasser
2025-10-21 13:32:25 +03:00
committed by GitHub
parent 3d0f4086b4
commit c6e58e5144
15 changed files with 7188 additions and 7423 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_refund-reasons/post.js
View File

@@ -9,7 +9,7 @@ export const sdk = new Medusa({
})
sdk.admin.refundReason.create({
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

2
www/apps/api-reference/specs/admin/code_samples/JavaScript/admin_refund-reasons_{id}/post.js
View File

@@ -9,7 +9,7 @@ export const sdk = new Medusa({
})
sdk.admin.refundReason.update("ret_123", {
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

1
www/apps/api-reference/specs/admin/code_samples/Shell/admin_refund-reasons/post.sh
View File

@@ -3,5 +3,6 @@ curl -X POST '{backend_url}/admin/refund-reasons' \
-H 'Content-Type: application/json' \
--data-raw '{
"label": "{value}",
"code": "{value}",
"description": "{value}"
}'

81
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -29213,44 +29213,6 @@ paths:
type: boolean
title: include_descendants_tree
description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example, `fields=category_children.id,category_children.name`.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
externalDocs:
url: '#pagination'
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security:
- api_token: []
- cookie_auth: []
@@ -29321,44 +29283,6 @@ paths:
description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. This API route restricts the fields that can be selected. Learn how to override the retrievable fields in the [Retrieve Custom Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
externalDocs:
url: '#pagination'
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security:
- api_token: []
- cookie_auth: []
@@ -38236,7 +38160,7 @@ paths:
})
sdk.admin.refundReason.create({
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {
@@ -38250,6 +38174,7 @@ paths:
-H 'Content-Type: application/json' \
--data-raw '{
"label": "{value}",
"code": "{value}",
"description": "{value}"
}'
tags:
@@ -38392,7 +38317,7 @@ paths:
})
sdk.admin.refundReason.update("ret_123", {
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

86
www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml
View File

@@ -78,49 +78,6 @@ get:
`*category_children` to retreieve the fields of all child categories,
or select specific fields to make the response size smaller. For
example, `fields=category_children.id,category_children.name`.
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
externalDocs:
url: '#pagination'
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security:
- api_token: []
- cookie_auth: []
@@ -193,49 +150,6 @@ post:
documentation.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
required: false
schema:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
required: false
schema:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
The field to sort the data by. By default, the sort order is ascending.
To change the order to descending, prefix the field name with `-`.
required: false
schema:
type: string
title: order
description: >-
The field to sort the data by. By default, the sort order is
ascending. To change the order to descending, prefix the field name
with `-`.
externalDocs:
url: '#pagination'
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security:
- api_token: []
- cookie_auth: []

6
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.refundReason/page.mdx
View File

@@ -95,7 +95,7 @@ To specify the fields and relations to retrieve:
```ts
sdk.admin.refundReason.retrieve("refr_123", {
fields: "id,value"
fields: "id,code"
})
.then(({ refund_reason }) => {
console.log(refund_reason)
@@ -130,7 +130,7 @@ This is available starting from [Medusa v2.11.0](https://github.com/medusajs/med
```ts
sdk.admin.refundReason.create({
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {
@@ -164,7 +164,7 @@ This is available starting from [Medusa v2.11.0](https://github.com/medusajs/med
```ts
sdk.admin.refundReason.update("ret_123", {
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

2
www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.create/page.mdx
View File

@@ -16,7 +16,7 @@ This is available starting from [Medusa v2.11.0](https://github.com/medusajs/med
```ts
sdk.admin.refundReason.create({
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

2
www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.retrieve/page.mdx
View File

@@ -27,7 +27,7 @@ To specify the fields and relations to retrieve:
```ts
sdk.admin.refundReason.retrieve("refr_123", {
fields: "id,value"
fields: "id,code"
})
.then(({ refund_reason }) => {
console.log(refund_reason)

2
www/apps/resources/references/js_sdk/admin/RefundReason/methods/js_sdk.admin.RefundReason.update/page.mdx
View File

@@ -16,7 +16,7 @@ This is available starting from [Medusa v2.11.0](https://github.com/medusajs/med
```ts
sdk.admin.refundReason.update("ret_123", {
value: "refund",
code: "refund",
label: "Refund",
})
.then(({ refund_reason }) => {

38
www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts
View File

@@ -47,44 +47,6 @@
* description: Whether to retrieve a list of child categories. If you enable this, add to the `fields` query parameter `category_children` to set the children of a category in this field. You can either
* pass `*category_children` to retreieve the fields of all child categories, or select specific fields to make the response size smaller. For example,
* `fields=category_children.id,category_children.name`.
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* externalDocs:
* url: "#pagination"
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* externalDocs:
* url: "#pagination"
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* externalDocs:
* url: "#pagination"
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security:
* - api_token: []
* - cookie_auth: []

38
www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts
View File

@@ -25,44 +25,6 @@
* Links](https://docs.medusajs.com/learn/fundamentals/api-routes/retrieve-custom-links) documentation.
* externalDocs:
* url: "#select-fields-and-relations"
* - name: offset
* in: query
* description: The number of items to skip when retrieving a list.
* required: false
* schema:
* type: number
* title: offset
* description: The number of items to skip when retrieving a list.
* externalDocs:
* url: "#pagination"
* - name: limit
* in: query
* description: Limit the number of items returned in the list.
* required: false
* schema:
* type: number
* title: limit
* description: Limit the number of items returned in the list.
* externalDocs:
* url: "#pagination"
* - name: order
* in: query
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* required: false
* schema:
* type: string
* title: order
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
* externalDocs:
* url: "#pagination"
* - name: with_deleted
* in: query
* description: Whether to include deleted records in the result.
* required: false
* schema:
* type: boolean
* title: with_deleted
* description: Whether to include deleted records in the result.
* security:
* - api_token: []
* - cookie_auth: []

3
www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts
View File

@@ -41,7 +41,7 @@
* })
*
* sdk.admin.refundReason.create({
* value: "refund",
* code: "refund",
* label: "Refund",
* })
* .then(({ refund_reason }) => {
@@ -55,6 +55,7 @@
* -H 'Content-Type: application/json' \
* --data-raw '{
* "label": "{value}",
* "code": "{value}",
* "description": "{value}"
* }'
* tags:

2
www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts
View File

@@ -47,7 +47,7 @@
* })
*
* sdk.admin.refundReason.update("ret_123", {
* value: "refund",
* code: "refund",
* label: "Refund",
* })
* .then(({ refund_reason }) => {

4
www/utils/generated/route-examples-output/route-examples.json
View File

@@ -666,10 +666,10 @@
"js-sdk": "sdk.admin.refundReason.retrieve(\"refr_123\")\n.then(({ refund_reason }) => {\n console.log(refund_reason)\n})"
},
"POST /admin/refund-reasons": {
"js-sdk": "sdk.admin.refundReason.create({\n value: \"refund\",\n label: \"Refund\",\n})\n.then(({ refund_reason }) => {\n console.log(refund_reason)\n})"
"js-sdk": "sdk.admin.refundReason.create({\n code: \"refund\",\n label: \"Refund\",\n})\n.then(({ refund_reason }) => {\n console.log(refund_reason)\n})"
},
"POST /admin/refund-reasons/{id}": {
"js-sdk": "sdk.admin.refundReason.update(\"ret_123\", {\n value: \"refund\",\n label: \"Refund\",\n})\n.then(({ refund_reason }) => {\n console.log(refund_reason)\n})"
"js-sdk": "sdk.admin.refundReason.update(\"ret_123\", {\n code: \"refund\",\n label: \"Refund\",\n})\n.then(({ refund_reason }) => {\n console.log(refund_reason)\n})"
},
"DELETE /admin/refund-reasons/{id}": {
"js-sdk": "sdk.admin.refundReason.delete(\"ret_123\")\n.then(({ deleted }) => {\n console.log(deleted)\n})"

14342
www/utils/generated/typedoc-json-output/js-sdk.json
View File

File diff suppressed because it is too large Load Diff