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

chore(docs): Generated API Reference (#3813)

Browse Source 
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-04-12 11:56:12 +02:00
committed by GitHub
parent 25672dbb77
commit d83fcfd9ea
10 changed files with 32 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin.oas.json
+11 -3
View File
@@ -1901,7 +1901,7 @@
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.currencies.update(code, {\n includes_tax: true\n})\n.then(({ currency }) => {\n console.log(currency.id);\n});\n"
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.currencies.update(code, {\n includes_tax: true\n})\n.then(({ currency }) => {\n console.log(currency.code);\n});\n"
},
{
"lang": "Shell",
@@ -21062,7 +21062,7 @@
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.store.addCurrency('eur')\n.then(({ store }) => {\n console.log(store.id);\n});\n"
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.store.addCurrency('eur')\n.then(({ store }) => {\n console.log(store.currencies);\n});\n"
},
{
"lang": "Shell",
@@ -21139,7 +21139,7 @@
{
"lang": "JavaScript",
"label": "JS Client",
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.store.deleteCurrency('eur')\n.then(({ store }) => {\n console.log(store.id);\n});\n"
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.store.deleteCurrency('eur')\n.then(({ store }) => {\n console.log(store.currencies);\n});\n"
},
{
"lang": "Shell",
@@ -28547,6 +28547,10 @@
"type": "string",
"description": "The name to identify the Product Category by."
},
"description": {
"type": "string",
"description": "An optional text field to describe the Product Category by."
},
"handle": {
"type": "string",
"description": "A handle to be used in slugs."
@@ -28579,6 +28583,10 @@
"type": "string",
"description": "The name to identify the Product Category by."
},
"description": {
"type": "string",
"description": "An optional text field to describe the Product Category by."
},
"handle": {
"type": "string",
"description": "An optional handle to be used in slugs, if none is provided we will kebab-case the title."
docs/api/admin.oas.yaml
+9 -3
View File
@@ -1602,7 +1602,7 @@ paths:
includes_tax: true
})
.then(({ currency }) => {
console.log(currency.id);
console.log(currency.code);
});
- lang: Shell
label: cURL
@@ -16196,7 +16196,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.store.addCurrency('eur')
.then(({ store }) => {
console.log(store.id);
console.log(store.currencies);
});
- lang: Shell
label: cURL
@@ -16253,7 +16253,7 @@ paths:
// must be previously logged in or use api token
medusa.admin.store.deleteCurrency('eur')
.then(({ store }) => {
console.log(store.id);
console.log(store.currencies);
});
- lang: Shell
label: cURL
@@ -21814,6 +21814,9 @@ components:
name:
type: string
description: The name to identify the Product Category by.
description:
type: string
description: An optional text field to describe the Product Category by.
handle:
type: string
description: A handle to be used in slugs.
@@ -21837,6 +21840,9 @@ components:
name:
type: string
description: The name to identify the Product Category by.
description:
type: string
description: An optional text field to describe the Product Category by.
handle:
type: string
description: An optional handle to be used in slugs, if none is provided we will kebab-case the title.
docs/api/admin/code_samples/JavaScript/admin_currencies_{code}/post.js
+1 -1
View File
@@ -5,5 +5,5 @@ medusa.admin.currencies.update(code, {
includes_tax: true
})
.then(({ currency }) => {
console.log(currency.id);
console.log(currency.code);
});
docs/api/admin/code_samples/JavaScript/admin_store_currencies_{code}/delete.js
+1 -1
View File
@@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.store.deleteCurrency('eur')
.then(({ store }) => {
console.log(store.id);
console.log(store.currencies);
});
docs/api/admin/code_samples/JavaScript/admin_store_currencies_{code}/post.js
+1 -1
View File
@@ -3,5 +3,5 @@ const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.store.addCurrency('eur')
.then(({ store }) => {
console.log(store.id);
console.log(store.currencies);
});
docs/api/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml
+3
View File
@@ -3,6 +3,9 @@ properties:
name:
type: string
description: The name to identify the Product Category by.
description:
type: string
description: An optional text field to describe the Product Category by.
handle:
type: string
description: A handle to be used in slugs.
docs/api/admin/components/schemas/AdminPostProductCategoriesReq.yaml
+3
View File
@@ -5,6 +5,9 @@ properties:
name:
type: string
description: The name to identify the Product Category by.
description:
type: string
description: An optional text field to describe the Product Category by.
handle:
type: string
description: >-
docs/api/store.oas.json
+1 -1
View File
@@ -14280,7 +14280,7 @@
],
"properties": {
"code": {
"description": "The code that a Discount is identifed by.",
"description": "The code that a Discount is identified by.",
"type": "string"
}
}
docs/api/store.oas.yaml
+1 -1
View File
@@ -11288,7 +11288,7 @@ components:
- code
properties:
code:
description: The code that a Discount is identifed by.
description: The code that a Discount is identified by.
type: string
customer_id:
description: The ID of the Customer to associate the Cart with.
docs/api/store/components/schemas/StorePostCartsCartReq.yaml
+1 -1
View File
@@ -51,7 +51,7 @@ properties:
- code
properties:
code:
description: The code that a Discount is identifed by.
description: The code that a Discount is identified by.
type: string
customer_id:
description: The ID of the Customer to associate the Cart with.