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

chore: generate API reference (#2410)

Browse Source
This commit is contained in:
Shahed Nasser
2022-10-11 10:30:45 +03:00
committed by GitHub
parent 9aeda1b52d
commit 14d4b9d95c
49 changed files with 5045 additions and 1930 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/api/store/code_samples/JavaScript/order-edits_{id}/getundefined Normal file
View File

@@ -0,0 +1,6 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orderEdit.retrieve(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id);
});

6
docs/api/store/code_samples/JavaScript/order-edits_{id}_complete/postundefined Normal file
View File

@@ -0,0 +1,6 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orderEdit.complete(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id)
})

6
docs/api/store/code_samples/JavaScript/order-edits_{id}_decline/postundefined Normal file
View File

@@ -0,0 +1,6 @@
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
medusa.orderEdit.decline(orderEditId)
.then(({ order_edit }) => {
console.log(order_edit.id);
})

1
docs/api/store/code_samples/Shell/order-edits_{id}/getundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request GET 'https://medusa-url.com/store/order-edits/{id}'

1
docs/api/store/code_samples/Shell/order-edits_{id}_complete/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/complete'

1
docs/api/store/code_samples/Shell/order-edits_{id}_decline/postundefined Normal file
View File

@@ -0,0 +1 @@
curl --location --request POST 'https://medusa-url.com/store/order-edits/{id}/decline'

9
docs/api/store/components/schemas/line_item.yaml
View File

@@ -160,6 +160,15 @@ properties:
includes_tax:
description: '[EXPERIMENTAL] Indicates if the line item unit_price include tax'
type: boolean
original_item_id:
description: '[EXPERIMENTAL] The id of the original line item'
type: string
order_edit_id:
description: '[EXPERIMENTAL] The ID of the order edit to which a cloned item belongs'
type: string
order_edit:
description: '[EXPERIMENTAL] The order edit joined'
type: object
created_at:
type: string
description: The date with timezone at which the resource was created.

14
docs/api/store/components/schemas/order_edit.yaml
View File

@@ -60,12 +60,24 @@ properties:
type: string
subtotal:
type: integer
description: The subtotal for line items computed from changes.
description: The total of subtotal
example: 8000
discount_total:
type: integer
description: The total of discount
example: 800
shipping_total:
type: integer
description: The total of the shipping amount
example: 800
gift_card_total:
type: integer
description: The total of the gift card amount
example: 800
gift_card_tax_total:
type: integer
description: The total of the gift card tax amount
example: 800
tax_total:
type: integer
description: The total of tax

145
docs/api/store/openapi.yaml
View File

@@ -15,6 +15,89 @@ info:
<!-- ReDoc-Inject: <SecurityDefinitions> -->
## Expanding Fields
In many endpoints you'll find an `expand` query parameter that can be passed
to the endpoint. You can use the `expand` query parameter to unpack an
entity's relations and return them in the response.
For example, when you list customers you can also retrieve their groups by
passing to the `expand` query parameter the value `groups`.
You can expand more than one relation by separating the relations in the
`expand` query parameter with a comma. For example, to retrieve both the
orders and the groups of a customer, pass to the `expand` query parameter
the value `groups,orders`.
Please note that the parameters you pass to `expand` replace any relations
that are expanded by default.
## Selecting Fields
In many endpoints you'll find a `fields` query parameter that can be passed
to the endpoint. You can use the `fields` query parameter to specify which
fields in the entity should be returned in the response.
You can pass more than one field by seperating the field names in the
`fields` query parameter with a comma.
Only the fields you pass to `field` will be retrieved and returned in the
response. Any fields that are returned by default will not be returned in
this case. This does not affect relations.
For example, to only select the `title` and `description` fields of a
product, pass to the `fields` query parameter the value `title,description`.
## Pagination
### Query Parameters
In listing endpoints, such as list customers or list products, you can
control the pagination using the query parameters `limit` and `offset`.
`limit` is used to specify the maximum number of items that can be return in
the response. `offset` is used to specify how many items to skip before
returning the resulting entities.
You can use the `offset` query parameter to change between pages. For
example, if the limit is 50, at page 1 the offset should be 0; at page 2 the
offset should be 50, and so on.
### Response Fields
In listing fields, aside from the entities retrieved, there are three
pagination-related fields returned: `count`, `limit`, and `offset`.
Similarly to the query parameters, `limit` is the maximum number of items
that can be returned in the response, and `field` is the number of items
that were skipped before the entities in the result.
`count` is the total number of available items of this entity. It can be
used to determine how many pages are there.
For example, if the `count` is 100 and the `limit` is 50, you can divide the
`count` by the `limit` to get the number of pages: `100/50 = 2 pages`.
license:
name: MIT
url: https://github.com/medusajs/medusa/blob/master/LICENSE
@@ -66,6 +149,40 @@ paths:
$ref: paths/auth.yaml
/auth/{email}:
$ref: paths/auth_{email}.yaml
/gift-cards/{code}:
$ref: paths/gift-cards_{code}.yaml
/collections/{id}:
$ref: paths/collections_{id}.yaml
/collections:
$ref: paths/collections.yaml
/customers/me/addresses:
$ref: paths/customers_me_addresses.yaml
/customers:
$ref: paths/customers.yaml
/customers/me/addresses/{address_id}:
$ref: paths/customers_me_addresses_{address_id}.yaml
/customers/me:
$ref: paths/customers_me.yaml
/customers/me/payment-methods:
$ref: paths/customers_me_payment-methods.yaml
/customers/me/orders:
$ref: paths/customers_me_orders.yaml
/customers/password-token:
$ref: paths/customers_password-token.yaml
/customers/password-reset:
$ref: paths/customers_password-reset.yaml
/order-edits/{id}/complete:
$ref: paths/order-edits_{id}_complete.yaml
/order-edits/{id}/decline:
$ref: paths/order-edits_{id}_decline.yaml
/order-edits/{id}:
$ref: paths/order-edits_{id}.yaml
/orders/cart/{cart_id}:
$ref: paths/orders_cart_{cart_id}.yaml
/orders/{id}:
$ref: paths/orders_{id}.yaml
/orders:
$ref: paths/orders.yaml
/carts/{id}/shipping-methods:
$ref: paths/carts_{id}_shipping-methods.yaml
/carts/{id}/taxes:
@@ -90,34 +207,6 @@ paths:
$ref: paths/carts_{id}_payment-sessions_{provider_id}_refresh.yaml
/carts/{id}/payment-session:
$ref: paths/carts_{id}_payment-session.yaml
/collections/{id}:
$ref: paths/collections_{id}.yaml
/collections:
$ref: paths/collections.yaml
/customers/me/addresses:
$ref: paths/customers_me_addresses.yaml
/customers:
$ref: paths/customers.yaml
/customers/me/addresses/{address_id}:
$ref: paths/customers_me_addresses_{address_id}.yaml
/customers/me:
$ref: paths/customers_me.yaml
/customers/me/payment-methods:
$ref: paths/customers_me_payment-methods.yaml
/customers/me/orders:
$ref: paths/customers_me_orders.yaml
/customers/password-token:
$ref: paths/customers_password-token.yaml
/customers/password-reset:
$ref: paths/customers_password-reset.yaml
/gift-cards/{code}:
$ref: paths/gift-cards_{code}.yaml
/orders/cart/{cart_id}:
$ref: paths/orders_cart_{cart_id}.yaml
/orders/{id}:
$ref: paths/orders_{id}.yaml
/orders:
$ref: paths/orders.yaml
/products/{id}:
$ref: paths/products_{id}.yaml
/products:

43
docs/api/store/paths/order-edits_{id}.yaml Normal file
View File

@@ -0,0 +1,43 @@
get:
operationId: GetOrderEditsOrderEdit
summary: Retrieve an OrderEdit
description: Retrieves a OrderEdit.
parameters:
- in: path
name: id
required: true
description: The ID of the OrderEdit.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}/getundefined
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
order_edit:
$ref: ../components/schemas/order_edit.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

39
docs/api/store/paths/order-edits_{id}_complete.yaml Normal file
View File

@@ -0,0 +1,39 @@
post:
operationId: PostOrderEditsOrderEditComplete
summary: Completes an OrderEdit
description: Completes an OrderEdit.
parameters:
- in: path
name: id
required: true
description: The ID of the Order Edit.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_complete/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_complete/postundefined
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'500':
$ref: ../components/responses/500_error.yaml

47
docs/api/store/paths/order-edits_{id}_decline.yaml Normal file
View File

@@ -0,0 +1,47 @@
post:
operationId: PostOrderEditsOrderEditDecline
summary: Decline an OrderEdit
description: Declines an OrderEdit.
parameters:
- in: path
name: id
required: true
description: The ID of the OrderEdit.
schema:
type: string
requestBody:
content:
application/json:
schema:
properties:
declined_reason:
type: string
description: The reason for declining the OrderEdit.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/order-edits_{id}_decline/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/order-edits_{id}_decline/postundefined
tags:
- OrderEdit
responses:
'200':
description: OK
content:
application/json:
schema:
properties:
order_edit:
$ref: ../components/schemas/order_edit.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'500':
$ref: ../components/responses/500_error.yaml