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

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

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-07-31 07:33:02 +00:00
committed by GitHub
parent aac906f058
commit 749e86b5d8
22 changed files with 881 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_cancel/post.sh Normal file
View File

@@ -0,0 +1,2 @@
curl -X POST '{backend_url}/admin/claims/{id}/cancel' \
-H 'x-medusa-access-token: {api_token}'

2
www/apps/api-reference/specs/admin/code_samples/Shell/admin_claims_{id}_request/delete.sh Normal file
View File

@@ -0,0 +1,2 @@
curl -X DELETE '{backend_url}/admin/claims/{id}/request' \
-H 'x-medusa-access-token: {api_token}'

5
www/apps/api-reference/specs/admin/components/schemas/AdminImportProductRequest.yaml
View File

@@ -1,3 +1,8 @@
type: object
description: SUMMARY
x-schemaName: AdminImportProductRequest
required:
- file
properties:
file:
$ref: ./File.yaml

8
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelClaimReqSchema.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: SUMMARY
x-schemaName: AdminPostCancelClaimReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The claim's no notification.

6
www/apps/api-reference/specs/admin/components/schemas/AdminPostCancelReturnReqSchema.yaml
View File

@@ -1,14 +1,8 @@
type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- internal_note
properties:
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
internal_note:
type: string
title: internal_note
description: The return's internal note.

45
www/apps/api-reference/specs/admin/components/schemas/File.yaml Normal file
View File

@@ -0,0 +1,45 @@
type: object
description: The product's file.
x-schemaName: File
required:
- lastModified
- name
- webkitRelativePath
- size
- type
- arrayBuffer
- stream
- text
properties:
lastModified:
type: number
title: lastModified
description: The file's lastmodified.
name:
type: string
title: name
description: The file's name.
webkitRelativePath:
type: string
title: webkitRelativePath
description: The file's webkitrelativepath.
size:
type: number
title: size
description: The file's size.
type:
type: string
title: type
description: The file's type.
arrayBuffer:
type: object
description: The file's arraybuffer.
slice:
type: object
description: The file's slice.
stream:
type: object
description: The file's stream.
text:
type: object
description: The file's text.

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

@@ -1390,6 +1390,97 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
/admin/claims/{id}/cancel:
post:
operationId: PostClaimsIdCancel
summary: Add Cancels to Claim
description: Add a list of cancels to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: Comma-separated relations that should be expanded in the returned data.
- name: fields
in: query
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.
required: false
schema:
type: string
title: fields
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.
- 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.
- 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.
- 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 `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AdminPostCancelClaimReqSchema'
x-codeSamples:
- lang: Shell
label: cURL
source: |-
curl -X POST '{backend_url}/admin/claims/{id}/cancel' \
-H 'x-medusa-access-token: {api_token}'
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: '#/components/responses/400_error'
'401':
$ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found_error'
'409':
$ref: '#/components/responses/invalid_state_error'
'422':
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
/admin/claims/{id}/claim-items:
post:
operationId: PostClaimsIdClaimItems
@@ -2679,6 +2770,87 @@ paths:
summary: Add Requests to Claim
description: Add a list of requests to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: Comma-separated relations that should be expanded in the returned data.
- name: fields
in: query
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.
required: false
schema:
type: string
title: fields
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.
- 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.
- 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.
- 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 `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source: |-
curl -X POST '{backend_url}/admin/claims/{id}/request' \
-H 'x-medusa-access-token: {api_token}'
tags:
- Claims
responses:
'400':
$ref: '#/components/responses/400_error'
'401':
$ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found_error'
'409':
$ref: '#/components/responses/invalid_state_error'
'422':
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
requestBody:
content:
application/json:
schema: {}
delete:
operationId: DeleteClaimsIdRequest
summary: Remove Requests from Claim
description: Remove a list of requests from a claim. This doesn't delete the Request, only the association between the Request and the claim.
x-authenticated: true
parameters:
- name: id
in: path
@@ -2740,7 +2912,7 @@ paths:
- lang: Shell
label: cURL
source: |-
curl -X POST '{backend_url}/admin/claims/{id}/request' \
curl -X DELETE '{backend_url}/admin/claims/{id}/request' \
-H 'x-medusa-access-token: {api_token}'
tags:
- Claims
@@ -43402,6 +43574,11 @@ components:
type: object
description: SUMMARY
x-schemaName: AdminImportProductRequest
required:
- file
properties:
file:
$ref: '#/components/schemas/File'
AdminImportProductResponse:
type: object
description: SUMMARY
@@ -43532,21 +43709,24 @@ components:
metadata:
type: object
description: The order's metadata.
AdminPostCancelClaimReqSchema:
type: object
description: SUMMARY
x-schemaName: AdminPostCancelClaimReqSchema
properties:
no_notification:
type: boolean
title: no_notification
description: The claim's no notification.
AdminPostCancelReturnReqSchema:
type: object
description: SUMMARY
x-schemaName: AdminPostCancelReturnReqSchema
required:
- internal_note
properties:
no_notification:
type: boolean
title: no_notification
description: The return's no notification.
internal_note:
type: string
title: internal_note
description: The return's internal note.
AdminPostClaimItemsReqSchema:
type: object
description: SUMMARY
@@ -46448,6 +46628,52 @@ components:
- unexpected_state
- invalid_argument
- unknown_error
File:
type: object
description: The product's file.
x-schemaName: File
required:
- lastModified
- name
- webkitRelativePath
- size
- type
- arrayBuffer
- stream
- text
properties:
lastModified:
type: number
title: lastModified
description: The file's lastmodified.
name:
type: string
title: name
description: The file's name.
webkitRelativePath:
type: string
title: webkitRelativePath
description: The file's webkitrelativepath.
size:
type: number
title: size
description: The file's size.
type:
type: string
title: type
description: The file's type.
arrayBuffer:
type: object
description: The file's arraybuffer.
slice:
type: object
description: The file's slice.
stream:
type: object
description: The file's stream.
text:
type: object
description: The file's text.
StoreAddCartLineItem:
type: object
description: SUMMARY

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

@@ -124,6 +124,8 @@ paths:
$ref: paths/admin_campaigns_{id}_promotions.yaml
/admin/claims:
$ref: paths/admin_claims.yaml
/admin/claims/{id}/cancel:
$ref: paths/admin_claims_{id}_cancel.yaml
/admin/claims/{id}/claim-items:
$ref: paths/admin_claims_{id}_claim-items.yaml
/admin/claims/{id}/claim-items/{action_id}:

96
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml Normal file
View File

@@ -0,0 +1,96 @@
post:
operationId: PostClaimsIdCancel
summary: Add Cancels to Claim
description: Add a list of cancels to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
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.
required: false
schema:
type: string
title: fields
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.
- 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.
- 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.
- 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 `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostCancelClaimReqSchema.yaml
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_cancel/post.sh
tags:
- Claims
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

99
www/apps/api-reference/specs/admin/paths/admin_claims_{id}_request.yaml
View File

@@ -3,6 +3,103 @@ post:
summary: Add Requests to Claim
description: Add a list of requests to a claim.
x-authenticated: true
parameters:
- name: id
in: path
description: The claim's ID.
required: true
schema:
type: string
- name: expand
in: query
description: Comma-separated relations that should be expanded in the returned data.
required: false
schema:
type: string
title: expand
description: >-
Comma-separated relations that should be expanded in the returned
data.
- name: fields
in: query
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.
required: false
schema:
type: string
title: fields
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.
- 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.
- 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.
- 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 `-`.
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_request/post.sh
tags:
- Claims
responses:
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema: {}
delete:
operationId: DeleteClaimsIdRequest
summary: Remove Requests from Claim
description: >-
Remove a list of requests from a claim. This doesn't delete the Request,
only the association between the Request and the claim.
x-authenticated: true
parameters:
- name: id
in: path
@@ -71,7 +168,7 @@ post:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_claims_{id}_request/post.sh
$ref: ../code_samples/Shell/admin_claims_{id}_request/delete.sh
tags:
- Claims
responses: