docs: add loyalty plugin routes to OAS (#12811)

* generated OAS

* remove unused schemas

* generated specs

* add cloud badge for routes

* add to loyalty plugin page

* allow clicking the tooltip
This commit is contained in:
Shahed Nasser
2025-06-24 19:17:55 +03:00
committed by GitHub
parent 3826bde591
commit 93cf79cb0f
164 changed files with 16001 additions and 88 deletions
@@ -73,6 +73,41 @@ tags:
url: https://docs.medusajs.com/resources/storefront-development/customers
x-associatedSchema:
$ref: ./components/schemas/StoreCustomer.yaml
- name: Gift Card Invitations
description: >
A gift card invitation is a way to send a gift card to a customer. They
can be sent from one customer to another.
These API routes allow logged-in customers to create and manage gift card
invitations.
<Note>
Gift Card Invitations are only available for Cloud users using the
[Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
</Note>
x-associatedSchema:
$ref: ./components/schemas/StoreGiftCardInvitation.yaml
- name: Gift Cards
description: >
A gift card is a prepaid card that customers can use to purchase products
in the store.
Customers can purchase gift cards for themselves or others, and then use
them to pay for their orders.
These API routes allow logged-in customers to create and manage their gift
cards.
<Note>
Gift Cards are only available for Cloud users using the [Loyalty
Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
</Note>
x-associatedSchema:
$ref: ./components/schemas/StoreGiftCard.yaml
- name: Orders
description: |
Guest and registered customers can view orders they placed.
@@ -159,15 +194,6 @@ tags:
url: https://docs.medusajs.com/resources/storefront-development/regions
x-associatedSchema:
$ref: ./components/schemas/StoreRegion.yaml
- name: Returns
description: >
Customers can request to return items in their order. The admin user then
receives and handles the return.
These API routes allows customers to create a return.
x-associatedSchema:
$ref: ./components/schemas/StoreReturn.yaml
- name: Return Reasons
description: >
A return reason is a possible reason a customer wants to return an item.
@@ -177,6 +203,15 @@ tags:
storefront to allow customers to select their return reason.
x-associatedSchema:
$ref: ./components/schemas/StoreReturnReason.yaml
- name: Returns
description: >
Customers can request to return items in their order. The admin user then
receives and handles the return.
These API routes allows customers to create a return.
x-associatedSchema:
$ref: ./components/schemas/StoreReturn.yaml
- name: Shipping Options
description: >
A shipping option is a way of shipping an item to or from the customer.
@@ -194,6 +229,22 @@ tags:
https://docs.medusajs.com/resources/storefront-development/checkout/shipping
x-associatedSchema:
$ref: ./components/schemas/StoreShippingOption.yaml
- name: Store Credit Accounts
x-associatedSchema:
description: >
A store credit account is a way for customers to manage their store
credit balance. Customers can use their store credit to pay for orders,
and view their store credit balance.
These API routes allow customers to view their store credit accounts.
<Note>
Store Credit Accounts are only available for Cloud users using the
[Loyalty Plugin](https://docs.medusajs.com/cloud/loyalty-plugin).
</Note>
$ref: ./components/schemas/StoreStoreCreditAccount.yaml
paths:
/auth/customer/{auth_provider}:
$ref: paths/auth_customer_{auth_provider}.yaml
@@ -217,6 +268,8 @@ paths:
$ref: paths/store_carts_{id}_complete.yaml
/store/carts/{id}/customer:
$ref: paths/store_carts_{id}_customer.yaml
/store/carts/{id}/gift-cards:
$ref: paths/store_carts_{id}_gift-cards.yaml
/store/carts/{id}/line-items:
$ref: paths/store_carts_{id}_line-items.yaml
/store/carts/{id}/line-items/{line_id}:
@@ -225,6 +278,8 @@ paths:
$ref: paths/store_carts_{id}_promotions.yaml
/store/carts/{id}/shipping-methods:
$ref: paths/store_carts_{id}_shipping-methods.yaml
/store/carts/{id}/store-credits:
$ref: paths/store_carts_{id}_store-credits.yaml
/store/carts/{id}/taxes:
$ref: paths/store_carts_{id}_taxes.yaml
/store/collections:
@@ -243,6 +298,18 @@ paths:
$ref: paths/store_customers_me_addresses.yaml
/store/customers/me/addresses/{address_id}:
$ref: paths/store_customers_me_addresses_{address_id}.yaml
/store/gift-card-invitations/{code}/accept:
$ref: paths/store_gift-card-invitations_{code}_accept.yaml
/store/gift-card-invitations/{code}/reject:
$ref: paths/store_gift-card-invitations_{code}_reject.yaml
/store/gift-cards:
$ref: paths/store_gift-cards.yaml
/store/gift-cards/{id}:
$ref: paths/store_gift-cards_{id}.yaml
/store/gift-cards/{id}/invitation:
$ref: paths/store_gift-cards_{id}_invitation.yaml
/store/gift-cards/{id}/redeem:
$ref: paths/store_gift-cards_{id}_redeem.yaml
/store/orders:
$ref: paths/store_orders.yaml
/store/orders/{id}:
@@ -291,6 +358,10 @@ paths:
$ref: paths/store_shipping-options.yaml
/store/shipping-options/{id}/calculate:
$ref: paths/store_shipping-options_{id}_calculate.yaml
/store/store-credit-accounts:
$ref: paths/store_store-credit-accounts.yaml
/store/store-credit-accounts/{id}:
$ref: paths/store_store-credit-accounts_{id}.yaml
components:
securitySchemes:
jwt_token: