chore(docs): Generated API Reference (#4529)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
1 parent
f61488f105
commit
5affae9583
4 files changed
+52
-47
No files matched your search
+29
-28
@@ -4517,36 +4517,17 @@
|
|||||||
"operationId": "PostProductsSearch",
|
"operationId": "PostProductsSearch",
|
||||||
"summary": "Search Products",
|
"summary": "Search Products",
|
||||||
"description": "Run a search query on products using the search engine installed on Medusa",
|
"description": "Run a search query on products using the search engine installed on Medusa",
|
||||||
"parameters": [
|
"requestBody": {
|
||||||
{
|
"content": {
|
||||||
"in": "query",
|
"application/json": {
|
||||||
"name": "q",
|
"schema": {
|
||||||
"required": true,
|
"$ref": "#/components/schemas/StorePostSearchReq"
|
||||||
"description": "The query to run the search with.",
|
}
|
||||||
"schema": {
|
|
||||||
"type": "string"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "offset",
|
|
||||||
"description": "How many products to skip in the result.",
|
|
||||||
"schema": {
|
|
||||||
"type": "integer"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"in": "query",
|
|
||||||
"name": "limit",
|
|
||||||
"description": "Limit the number of products returned.",
|
|
||||||
"schema": {
|
|
||||||
"type": "integer"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
},
|
||||||
"x-codegen": {
|
"x-codegen": {
|
||||||
"method": "search",
|
"method": "search"
|
||||||
"queryParams": "StorePostSearchReq"
|
|
||||||
},
|
},
|
||||||
"x-codeSamples": [
|
"x-codeSamples": [
|
||||||
{
|
{
|
||||||
@@ -4557,7 +4538,7 @@
|
|||||||
{
|
{
|
||||||
"lang": "Shell",
|
"lang": "Shell",
|
||||||
"label": "cURL",
|
"label": "cURL",
|
||||||
"source": "curl --location --request POST 'https://medusa-url.com/store/products/search?q=Shirt'\n"
|
"source": "curl --location --request POST 'https://medusa-url.com/store/products/search' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"q\": \"Shirt\"\n}'\n"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"tags": [
|
"tags": [
|
||||||
@@ -14618,6 +14599,26 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"StorePostSearchReq": {
|
||||||
|
"type": "object",
|
||||||
|
"properties": {
|
||||||
|
"q": {
|
||||||
|
"type": "string",
|
||||||
|
"description": "The query to run the search with."
|
||||||
|
},
|
||||||
|
"offset": {
|
||||||
|
"type": "number",
|
||||||
|
"description": "How many products to skip in the result."
|
||||||
|
},
|
||||||
|
"limit": {
|
||||||
|
"type": "number",
|
||||||
|
"description": "Limit the number of products returned."
|
||||||
|
},
|
||||||
|
"filter": {
|
||||||
|
"description": "Filter based on the search engine."
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"StorePostSearchRes": {
|
"StorePostSearchRes": {
|
||||||
"allOf": [
|
"allOf": [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1 +1,5 @@
|
|||||||
curl --location --request POST 'https://medusa-url.com/store/products/search?q=Shirt'
|
curl --location --request POST 'https://medusa-url.com/store/products/search' \
|
||||||
|
--header 'Content-Type: application/json' \
|
||||||
|
--data-raw '{
|
||||||
|
"q": "Shirt"
|
||||||
|
}'
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
q:
|
||||||
|
type: string
|
||||||
|
description: The query to run the search with.
|
||||||
|
offset:
|
||||||
|
type: number
|
||||||
|
description: How many products to skip in the result.
|
||||||
|
limit:
|
||||||
|
type: number
|
||||||
|
description: Limit the number of products returned.
|
||||||
|
filter:
|
||||||
|
description: Filter based on the search engine.
|
||||||
@@ -2,26 +2,13 @@ post:
|
|||||||
operationId: PostProductsSearch
|
operationId: PostProductsSearch
|
||||||
summary: Search Products
|
summary: Search Products
|
||||||
description: Run a search query on products using the search engine installed on Medusa
|
description: Run a search query on products using the search engine installed on Medusa
|
||||||
parameters:
|
requestBody:
|
||||||
- in: query
|
content:
|
||||||
name: q
|
application/json:
|
||||||
required: true
|
schema:
|
||||||
description: The query to run the search with.
|
$ref: ../components/schemas/StorePostSearchReq.yaml
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- in: query
|
|
||||||
name: offset
|
|
||||||
description: How many products to skip in the result.
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
- in: query
|
|
||||||
name: limit
|
|
||||||
description: Limit the number of products returned.
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
x-codegen:
|
x-codegen:
|
||||||
method: search
|
method: search
|
||||||
queryParams: StorePostSearchReq
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: JavaScript
|
- lang: JavaScript
|
||||||
label: JS Client
|
label: JS Client
|
||||||
|
|||||||
Reference in new issue
Block a user