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

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

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-21 07:20:13 +00:00
committed by GitHub
parent c999b414e7
commit cc3e84f081
16 changed files with 734 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml
View File

@@ -28,18 +28,20 @@ post:
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.
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: |-
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.
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.

1
www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml
View File

@@ -71,6 +71,7 @@ post:
description: SUMMARY
required:
- order_id
- amount
properties:
order_id:
type: string

116
www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}.yaml Normal file
View File

@@ -0,0 +1,116 @@
delete:
operationId: DeletePaymentCollectionsId
summary: Delete a Payment Collection
description: Delete a payment collection.
x-authenticated: true
parameters:
- name: id
in: path
description: The payment collection'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_payment-collections_{id}/delete.sh
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
description: SUMMARY
required:
- id
- object
- deleted
properties:
id:
type: string
title: id
description: The payment collection's ID.
object:
type: string
title: object
description: The payment collection's object.
deleted:
type: boolean
title: deleted
description: The payment collection's deleted.
parent:
type: object
description: The payment collection's parent.
'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

109
www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml Normal file
View File

@@ -0,0 +1,109 @@
post:
operationId: PostPaymentCollectionsIdMarkAsPaid
summary: Add Mark As Paids to Payment Collection
description: Add a list of mark as paids to a payment collection.
x-authenticated: true
parameters:
- name: id
in: path
description: The payment collection'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:
type: object
description: SUMMARY
required:
- order_id
properties:
order_id:
type: string
title: order_id
description: The payment collection's order id.
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/admin_payment-collections_{id}_mark-as-paid/post.sh
tags:
- Payment Collections
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPaymentCollectionResponse.yaml
'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