docs: update OAS for loyalty plugin (#12836)

* updates * cleanup * generate OAS * update links
2025-06-26 17:22:18 +03:00
parent 2983c7c3a5
commit 7d95eb73d3
81 changed files with 463 additions and 2001 deletions
@@ -366,8 +366,9 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -58,8 +58,9 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -1,8 +1,9 @@
 /**
- * @oas [post] /admin/gift-cards/{id}/transfer
- * operationId: PostGiftCardsIdTransfer
- * summary: Transfer Gift Card
- * description: Transfer a gift card to another customer.
+ * @oas [get] /admin/gift-cards/{id}/orders
+ * operationId: GetGiftCardsIdOrders
+ * summary: List Gift Card's Orders
+ * x-sidebar-summary: List Orders
+ * description: Retrieve the list of orders that a gift card was used in.
 * x-authenticated: true
 * x-ignoreCleanup: true
 * parameters:
@@ -16,8 +17,8 @@
 *     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.
+ *        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
@@ -30,30 +31,17 @@
 *   - api_token: []
 *   - cookie_auth: []
 *   - jwt_token: []
- * requestBody:
- *   content:
- *     application/json:
- *       schema:
- *         $ref: "#/components/schemas/AdminTransferGiftCard"
 * x-codeSamples:
 *   - lang: Shell
 *     label: cURL
 *     source: |-
- *       curl -X POST '{backend_url}/admin/gift-cards/{id}/transfer' \
- *       -H 'Authorization: Bearer {access_token}' \
- *       -H 'Content-Type: application/json' \
- *       --data-raw '{
- *         "customer_id": "{value}"
- *       }'
+ *       curl '{backend_url}/admin/gift-cards/{id}/orders' \
+ *       -H 'Authorization: Bearer {access_token}'
 * tags:
 *   - Gift Cards
 * responses:
 *   "200":
 *     description: OK
- *     content:
- *       application/json:
- *         schema:
- *           $ref: "#/components/schemas/AdminGiftCardResponse"
 *   "400":
 *     $ref: "#/components/responses/400_error"
 *   "401":
@@ -66,10 +54,9 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
 */

@@ -404,10 +404,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -410,10 +410,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -379,10 +379,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -365,10 +365,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -68,10 +68,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -62,10 +62,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -66,10 +66,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */

@@ -61,10 +61,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
- * 
 * x-badges:
- *    - text: "Cloud"
- *      description: > 
- *        This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ *   - text: Cloud
+ *     description: |
+ *       This API route is only available in [Medusa Cloud](https://docs.medusajs.com/cloud/loyalty-plugin).
+ * 
 */