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

api-ref: custom API reference (#4770)

Browse Source 
* initialized next.js project

* finished markdown sections

* added operation schema component

* change page metadata

* eslint fixes

* fixes related to deployment

* added response schema

* resolve max stack issue

* support for different property types

* added support for property types

* added loading for components

* added more loading

* type fixes

* added oneOf type

* removed console

* fix replace with push

* refactored everything

* use static content for description

* fixes and improvements

* added code examples section

* fix path name

* optimizations

* fixed tag navigation

* add support for admin and store references

* general enhancements

* optimizations and fixes

* fixes and enhancements

* added search bar

* loading enhancements

* added loading

* added code blocks

* added margin top

* add empty response text

* fixed oneOf parameters

* added path and query parameters

* general fixes

* added base path env variable

* small fix for arrays

* enhancements

* design enhancements

* general enhancements

* fix isRequired

* added enum values

* enhancements

* general fixes

* general fixes

* changed oas generation script

* additions to the introduction section

* added copy button for code + other enhancements

* fix response code block

* fix metadata

* formatted store introduction

* move sidebar logic to Tags component

* added test env variables

* fix code block bug

* added loading animation

* added expand param + loading

* enhance operation loading

* made responsive + improvements

* added loading provider

* fixed loading

* adjustments for small devices

* added sidebar label for endpoints

* added feedback component

* fixed analytics

* general fixes

* listen to scroll for other headings

* added sample env file

* update api ref files + support new fields

* fix for external docs link

* added new sections

* fix last item in sidebar not showing

* move docs content to www/docs

* change redirect url

* revert change

* resolve build errors

* configure rewrites

* changed to environment variable url

* revert changing environment variable name

* add environment variable for API path

* fix links

* fix tailwind settings

* remove vercel file

* reconfigured api route

* move api page under api

* fix page metadata

* fix external link in navigation bar

* update api spec

* updated api specs

* fixed google lint error

* add max-height on request samples

* add padding before loading

* fix for one of name

* fix undefined types

* general fixes

* remove response schema example

* redesigned navigation bar

* redesigned sidebar

* fixed up paddings

* added feedback component + report issue

* fixed up typography, padding, and general styling

* redesigned code blocks

* optimization

* added error timeout

* fixes

* added indexing with algolia + fixes

* fix errors with algolia script

* redesign operation sections

* fix heading scroll

* design fixes

* fix padding

* fix padding + scroll issues

* fix scroll issues

* improve scroll performance

* fixes for safari

* optimization and fixes

* fixes to docs + details animation

* padding fixes for code block

* added tab animation

* fixed incorrect link

* added selection styling

* fix lint errors

* redesigned details component

* added detailed feedback form

* api reference fixes

* fix tabs

* upgrade + fixes

* updated documentation links

* optimizations to sidebar items

* fix spacing in sidebar item

* optimizations and fixes

* fix endpoint path styling

* remove margin

* final fixes

* change margin on small devices

* generated OAS

* fixes for mobile

* added feedback modal

* optimize dark mode button

* fixed color mode useeffect

* minimize dom size

* use new style system

* radius and spacing design system

* design fixes

* fix eslint errors

* added meta files

* change cron schedule

* fix docusaurus configurations

* added operating system to feedback data

* change content directory name

* fixes to contribution guidelines

* revert renaming content

* added api-reference to documentation workflow

* fixes for search

* added dark mode + fixes

* oas fixes

* handle bugs

* added code examples for clients

* changed tooltip text

* change authentication to card

* change page title based on selected section

* redesigned mobile navbar

* fix icon colors

* fix key colors

* fix medusa-js installation command

* change external regex in algolia

* change changeset

* fix padding on mobile

* fix hydration error

* update depedencies
This commit is contained in:
Shahed Nasser
2023-08-15 18:07:54 +03:00
committed by GitHub
parent 16249ec280
commit 914d773d3a
3270 changed files with 22075 additions and 192064 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/api-reference/specs/store/code_samples/Shell/store_auth/delete.sh Normal file
View File

@@ -0,0 +1,2 @@
curl -X DELETE '{backend_url}/store/auth' \
-H 'Cookie: connect.sid={sid}'

2
www/api-reference/specs/store/code_samples/Shell/store_auth/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/auth' \
-H 'Cookie: connect.sid={sid}'

6
www/api-reference/specs/store/code_samples/Shell/store_auth/post.sh Normal file
View File

@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/store/auth' \
-H 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"password": "supersecret"
}'

1
www/api-reference/specs/store/code_samples/Shell/store_auth_{email}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/auth/user@example.com'

1
www/api-reference/specs/store/code_samples/Shell/store_carts/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/carts'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/carts/{id}'

5
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/carts/{id}' \
-H 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_complete/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/carts/{id}/complete'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_discounts_{code}/delete.sh Normal file
View File

@@ -0,0 +1 @@
curl -X DELETE '{backend_url}/store/carts/{id}/discounts/{code}'

6
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items/post.sh Normal file
View File

@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/store/carts/{id}/line-items' \
-H 'Content-Type: application/json' \
--data-raw '{
"variant_id": "{variant_id}",
"quantity": 1
}'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/delete.sh Normal file
View File

@@ -0,0 +1 @@
curl -X DELETE '{backend_url}/store/carts/{id}/line-items/{line_id}'

5
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_line-items_{line_id}/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/carts/{id}/line-items/{line_id}' \
-H 'Content-Type: application/json' \
--data-raw '{
"quantity": 1
}'

5
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-session/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/carts/{id}/payment-sessions' \
-H 'Content-Type: application/json' \
--data-raw '{
"provider_id": "manual"
}'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-sessions/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/carts/{id}/payment-sessions'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/delete.sh Normal file
View File

@@ -0,0 +1 @@
curl -X DELETE '{backend_url}/store/carts/{id}/payment-sessions/{provider_id}'

5
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/carts/{id}/payment-sessions/manual' \
-H 'Content-Type: application/json' \
--data-raw '{
"data": {}
}'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/carts/{id}/payment-sessions/{provider_id}/refresh'

5
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_shipping-methods/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/carts/{id}/shipping-methods' \
-H 'Content-Type: application/json' \
--data-raw '{
"option_id": "{option_id}",
}'

1
www/api-reference/specs/store/code_samples/Shell/store_carts_{id}_taxes/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/carts/{id}/taxes'

1
www/api-reference/specs/store/code_samples/Shell/store_collections/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/collections'

1
www/api-reference/specs/store/code_samples/Shell/store_collections_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/collections/{id}'

8
www/api-reference/specs/store/code_samples/Shell/store_customers/post.sh Normal file
View File

@@ -0,0 +1,8 @@
curl -X POST '{backend_url}/store/customers' \
-H 'Content-Type: application/json' \
--data-raw '{
"first_name": "Alec",
"last_name": "Reynolds",
"email": "user@example.com",
"password": "supersecret"
}'

2
www/api-reference/specs/store/code_samples/Shell/store_customers_me/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/customers/me' \
-H 'Cookie: connect.sid={sid}'

6
www/api-reference/specs/store/code_samples/Shell/store_customers_me/post.sh Normal file
View File

@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/store/customers/me' \
-H 'Cookie: connect.sid={sid}' \
-H 'Content-Type: application/json' \
--data-raw '{
"first_name": "Laury"
}'

13
www/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses/post.sh Normal file
View File

@@ -0,0 +1,13 @@
curl -X POST '{backend_url}/store/customers/me/addresses' \
-H 'Cookie: connect.sid={sid}' \
-H 'Content-Type: application/json' \
--data-raw '{
"address": {
"first_name": "Celia",
"last_name": "Schumm",
"address_1": "225 Bednar Curve",
"city": "Danielville",
"country_code": "US",
"postal_code": "85137"
}
}'

2
www/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh Normal file
View File

@@ -0,0 +1,2 @@
curl -X DELETE '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'Cookie: connect.sid={sid}'

6
www/api-reference/specs/store/code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh Normal file
View File

@@ -0,0 +1,6 @@
curl -X POST '{backend_url}/store/customers/me/addresses/{address_id}' \
-H 'Cookie: connect.sid={sid}' \
-H 'Content-Type: application/json' \
--data-raw '{
"first_name": "Gina"
}'

2
www/api-reference/specs/store/code_samples/Shell/store_customers_me_orders/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/customers/me/orders' \
-H 'Cookie: connect.sid={sid}'

2
www/api-reference/specs/store/code_samples/Shell/store_customers_me_payment-methods/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/customers/me/payment-methods' \
-H 'Cookie: connect.sid={sid}'

7
www/api-reference/specs/store/code_samples/Shell/store_customers_password-reset/post.sh Normal file
View File

@@ -0,0 +1,7 @@
curl -X POST '{backend_url}/store/customers/password-reset' \
-H 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com",
"password": "supersecret",
"token": "supersecrettoken"
}'

5
www/api-reference/specs/store/code_samples/Shell/store_customers_password-token/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/customers/password-token' \
-H 'Content-Type: application/json' \
--data-raw '{
"email": "user@example.com"
}'

1
www/api-reference/specs/store/code_samples/Shell/store_gift-cards_{code}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/gift-cards/{code}'

1
www/api-reference/specs/store/code_samples/Shell/store_order-edits_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/order-edits/{id}'

1
www/api-reference/specs/store/code_samples/Shell/store_order-edits_{id}_complete/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/order-edits/{id}/complete'

1
www/api-reference/specs/store/code_samples/Shell/store_order-edits_{id}_decline/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/order-edits/{id}/decline'

1
www/api-reference/specs/store/code_samples/Shell/store_orders/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/orders?display_id=1&email=user@example.com'

5
www/api-reference/specs/store/code_samples/Shell/store_orders_batch_customer_token/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/batch/customer/token' \
-H 'Content-Type: application/json' \
--data-raw '{
"order_ids": ["id"],
}'

1
www/api-reference/specs/store/code_samples/Shell/store_orders_cart_{cart_id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/orders/cart/{cart_id}'

5
www/api-reference/specs/store/code_samples/Shell/store_orders_customer_confirm/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/orders/customer/confirm' \
-H 'Content-Type: application/json' \
--data-raw '{
"token": "{token}",
}'

1
www/api-reference/specs/store/code_samples/Shell/store_orders_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/orders/{id}'

1
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/payment-collections/{id}'

5
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_sessions/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/sessions' \
-H 'Content-Type: application/json' \
--data-raw '{
"provider_id": "stripe"
}'

14
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_sessions_batch/post.sh Normal file
View File

@@ -0,0 +1,14 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/sessions/batch' \
-H 'Content-Type: application/json' \
--data-raw '{
"sessions": [
{
"provider_id": "stripe",
"amount": 5000
},
{
"provider_id": "manual",
"amount": 5000
}
]
}'

1
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_sessions_batch_authorize/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/sessions/batch/authorize'

1
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/sessions/{session_id}'

1
www/api-reference/specs/store/code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}_authorize/post.sh Normal file
View File

@@ -0,0 +1 @@
curl -X POST '{backend_url}/store/payment-collections/{id}/sessions/{session_id}/authorize'

2
www/api-reference/specs/store/code_samples/Shell/store_product-categories/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/product-categories' \
-H 'Authorization: Bearer {api_token}'

2
www/api-reference/specs/store/code_samples/Shell/store_product-categories_{id}/get.sh Normal file
View File

@@ -0,0 +1,2 @@
curl '{backend_url}/store/product-categories/{id}' \
-H 'Authorization: Bearer {api_token}'

1
www/api-reference/specs/store/code_samples/Shell/store_product-tags/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/product-tags'

1
www/api-reference/specs/store/code_samples/Shell/store_product-types/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/product-types'

1
www/api-reference/specs/store/code_samples/Shell/store_products/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/products'

5
www/api-reference/specs/store/code_samples/Shell/store_products_search/post.sh Normal file
View File

@@ -0,0 +1,5 @@
curl -X POST '{backend_url}/store/products/search' \
-H 'Content-Type: application/json' \
--data-raw '{
"q": "Shirt"
}'

1
www/api-reference/specs/store/code_samples/Shell/store_products_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/products/{id}'

1
www/api-reference/specs/store/code_samples/Shell/store_regions/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/regions'

1
www/api-reference/specs/store/code_samples/Shell/store_regions_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/regions/{id}'

1
www/api-reference/specs/store/code_samples/Shell/store_return-reasons/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/return-reasons'

1
www/api-reference/specs/store/code_samples/Shell/store_return-reasons_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/return-reasons/{id}'

11
www/api-reference/specs/store/code_samples/Shell/store_returns/post.sh Normal file
View File

@@ -0,0 +1,11 @@
curl -X POST '{backend_url}/store/returns' \
-H 'Content-Type: application/json' \
--data-raw '{
"order_id": "asfasf",
"items": [
{
"item_id": "assfasf",
"quantity": 1
}
]
}'

1
www/api-reference/specs/store/code_samples/Shell/store_shipping-options/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/shipping-options'

1
www/api-reference/specs/store/code_samples/Shell/store_shipping-options_{cart_id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/shipping-options/{cart_id}'

17
www/api-reference/specs/store/code_samples/Shell/store_swaps/post.sh Normal file
View File

@@ -0,0 +1,17 @@
curl -X POST '{backend_url}/store/swaps' \
-H 'Content-Type: application/json' \
--data-raw '{
"order_id": "{order_id}",
"return_items": [
{
"item_id": "{item_id}",
"quantity": 1
}
],
"additional_items": [
{
"variant_id": "{variant_id}",
"quantity": 1
}
]
}'

1
www/api-reference/specs/store/code_samples/Shell/store_swaps_{cart_id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/swaps/{cart_id}'

1
www/api-reference/specs/store/code_samples/Shell/store_variants/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/variants'

1
www/api-reference/specs/store/code_samples/Shell/store_variants_{id}/get.sh Normal file
View File

@@ -0,0 +1 @@
curl '{backend_url}/store/variants/{id}'