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

chore(docs): Updated API Reference (v2) (#8384)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action
This commit is contained in:
github-actions[bot]
2024-08-01 07:43:40 +00:00
committed by GitHub
parent 123dad7db8
commit 31ec4d0d71
10 changed files with 38 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/admin/openapi.full.yaml
+4 -21
View File
@@ -1413,18 +1413,12 @@ paths:
description: Comma-separated relations that should be expanded in the returned data. description: Comma-separated relations that should be expanded in the returned data.
- name: fields - name: fields
in: query in: query
description: |- 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.
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.
required: false required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- 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.
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.
- name: offset - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -1467,8 +1461,6 @@ paths:
tags: tags:
- Claims - Claims
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -2868,18 +2860,12 @@ paths:
description: Comma-separated relations that should be expanded in the returned data. description: Comma-separated relations that should be expanded in the returned data.
- name: fields - name: fields
in: query in: query
description: |- 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.
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.
required: false required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- 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.
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.
- name: offset - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -2917,8 +2903,6 @@ paths:
tags: tags:
- Claims - Claims
responses: responses:
'200':
description: OK
'400': '400':
$ref: '#/components/responses/400_error' $ref: '#/components/responses/400_error'
'401': '401':
@@ -13344,7 +13328,6 @@ paths:
description: The product's tags. description: The product's tags.
required: false required: false
schema: schema:
type: object
description: The product's tags. description: The product's tags.
properties: properties:
value: value:
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml
+9 -9
View File
@@ -22,18 +22,20 @@ post:
data. data.
- name: fields - name: fields
in: query in: query
description: |- description: >-
Comma-separated fields that should be included in the returned data. Comma-separated fields that should be included in the returned data. if
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. a field is prefixed with `+` it will be added to the default fields,
* without prefix it will replace the entire default fields. using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- description: >-
Comma-separated fields that should be included in the returned data. 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. if a field is prefixed with `+` it will be added to the default
* without prefix it will replace the entire default fields. fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -80,8 +82,6 @@ post:
tags: tags:
- Claims - Claims
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml
+9 -9
View File
@@ -119,18 +119,20 @@ delete:
data. data.
- name: fields - name: fields
in: query in: query
description: |- description: >-
Comma-separated fields that should be included in the returned data. Comma-separated fields that should be included in the returned data. if
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. a field is prefixed with `+` it will be added to the default fields,
* without prefix it will replace the entire default fields. using `-` will remove it from the default fields. without prefix it will
replace the entire default fields.
required: false required: false
schema: schema:
type: string type: string
title: fields title: fields
description: |- description: >-
Comma-separated fields that should be included in the returned data. 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. if a field is prefixed with `+` it will be added to the default
* without prefix it will replace the entire default fields. fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
- name: offset - name: offset
in: query in: query
description: The number of items to skip when retrieving a list. description: The number of items to skip when retrieving a list.
@@ -172,8 +174,6 @@ delete:
tags: tags:
- Claims - Claims
responses: responses:
'200':
description: OK
'400': '400':
$ref: ../components/responses/400_error.yaml $ref: ../components/responses/400_error.yaml
'401': '401':
www/apps/api-reference/specs/admin/paths/admin_products.yaml
-1
View File
@@ -178,7 +178,6 @@ get:
description: The product's tags. description: The product's tags.
required: false required: false
schema: schema:
type: object
description: The product's tags. description: The product's tags.
properties: properties:
value: value:
www/apps/api-reference/specs/store/openapi.full.yaml
-5
View File
@@ -3143,7 +3143,6 @@ paths:
description: The product's category id. description: The product's category id.
required: true required: true
schema: schema:
type: array
description: The product's category id. description: The product's category id.
items: items:
type: string type: string
@@ -3154,7 +3153,6 @@ paths:
description: The product's sales channel id. description: The product's sales channel id.
required: true required: true
schema: schema:
type: array
description: The product's sales channel id. description: The product's sales channel id.
items: items:
type: string type: string
@@ -3165,7 +3163,6 @@ paths:
description: The product's collection id. description: The product's collection id.
required: true required: true
schema: schema:
type: array
description: The product's collection id. description: The product's collection id.
items: items:
type: string type: string
@@ -3176,7 +3173,6 @@ paths:
description: The product's tags. description: The product's tags.
required: false required: false
schema: schema:
type: array
description: The product's tags. description: The product's tags.
items: items:
type: string type: string
@@ -3187,7 +3183,6 @@ paths:
description: The product's type id. description: The product's type id.
required: false required: false
schema: schema:
type: array
description: The product's type id. description: The product's type id.
items: items:
type: string type: string
www/apps/api-reference/specs/store/paths/store_products.yaml
-5
View File
@@ -163,7 +163,6 @@ get:
description: The product's category id. description: The product's category id.
required: true required: true
schema: schema:
type: array
description: The product's category id. description: The product's category id.
items: items:
type: string type: string
@@ -174,7 +173,6 @@ get:
description: The product's sales channel id. description: The product's sales channel id.
required: true required: true
schema: schema:
type: array
description: The product's sales channel id. description: The product's sales channel id.
items: items:
type: string type: string
@@ -185,7 +183,6 @@ get:
description: The product's collection id. description: The product's collection id.
required: true required: true
schema: schema:
type: array
description: The product's collection id. description: The product's collection id.
items: items:
type: string type: string
@@ -196,7 +193,6 @@ get:
description: The product's tags. description: The product's tags.
required: false required: false
schema: schema:
type: array
description: The product's tags. description: The product's tags.
items: items:
type: string type: string
@@ -207,7 +203,6 @@ get:
description: The product's type id. description: The product's type id.
required: false required: false
schema: schema:
type: array
description: The product's type id. description: The product's type id.
items: items:
type: string type: string
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts
+8 -10
View File
@@ -22,18 +22,18 @@
* description: Comma-separated relations that should be expanded in the returned data. * description: Comma-separated relations that should be expanded in the returned data.
* - name: fields * - name: fields
* in: query * in: query
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* required: false * required: false
* schema: * schema:
* type: string * type: string
* title: fields * title: fields
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* - name: offset * - name: offset
* in: query * in: query
* description: The number of items to skip when retrieving a list. * description: The number of items to skip when retrieving a list.
@@ -75,8 +75,6 @@
* tags: * tags:
* - Claims * - Claims
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
www/utils/generated/oas-output/operations/admin/get_admin_products.ts
-1
View File
@@ -173,7 +173,6 @@
* description: The product's tags. * description: The product's tags.
* required: false * required: false
* schema: * schema:
* type: object
* description: The product's tags. * description: The product's tags.
* properties: * properties:
* value: * value:
www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_cancel.ts
+8 -10
View File
@@ -21,18 +21,18 @@
* description: Comma-separated relations that should be expanded in the returned data. * description: Comma-separated relations that should be expanded in the returned data.
* - name: fields * - name: fields
* in: query * in: query
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* required: false * required: false
* schema: * schema:
* type: string * type: string
* title: fields * title: fields
* description: >- * description: Comma-separated fields that should be included in the returned
* Comma-separated fields that should be included in the returned data. * data. if a field is prefixed with `+` it will be added to the default
* * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * fields, using `-` will remove it from the default fields. without prefix
* * without prefix it will replace the entire default fields. * it will replace the entire default fields.
* - name: offset * - name: offset
* in: query * in: query
* description: The number of items to skip when retrieving a list. * description: The number of items to skip when retrieving a list.
@@ -79,8 +79,6 @@
* tags: * tags:
* - Claims * - Claims
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
www/utils/generated/oas-output/operations/store/get_store_products.ts
-5
View File
@@ -158,7 +158,6 @@
* description: The product's category id. * description: The product's category id.
* required: true * required: true
* schema: * schema:
* type: array
* description: The product's category id. * description: The product's category id.
* items: * items:
* type: string * type: string
@@ -169,7 +168,6 @@
* description: The product's sales channel id. * description: The product's sales channel id.
* required: true * required: true
* schema: * schema:
* type: array
* description: The product's sales channel id. * description: The product's sales channel id.
* items: * items:
* type: string * type: string
@@ -180,7 +178,6 @@
* description: The product's collection id. * description: The product's collection id.
* required: true * required: true
* schema: * schema:
* type: array
* description: The product's collection id. * description: The product's collection id.
* items: * items:
* type: string * type: string
@@ -191,7 +188,6 @@
* description: The product's tags. * description: The product's tags.
* required: false * required: false
* schema: * schema:
* type: array
* description: The product's tags. * description: The product's tags.
* items: * items:
* type: string * type: string
@@ -202,7 +198,6 @@
* description: The product's type id. * description: The product's type id.
* required: false * required: false
* schema: * schema:
* type: array
* description: The product's type id. * description: The product's type id.
* items: * items:
* type: string * type: string