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
2025-06-24 19:17:55 +03:00
parent 3826bde591
commit 93cf79cb0f
164 changed files with 16001 additions and 88 deletions
@@ -0,0 +1,84 @@
+/**
+ * @schema StoreGiftCard
+ * type: object
+ * description: The gift card's details.
+ * x-schemaName: StoreGiftCard
+ * required:
+ *   - customer
+ *   - line_item
+ *   - invitation
+ *   - id
+ *   - code
+ *   - status
+ *   - value
+ *   - currency_code
+ *   - customer_id
+ *   - reference_id
+ *   - note
+ *   - reference
+ *   - expires_at
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   customer:
+ *     $ref: "#/components/schemas/StoreCustomer"
+ *   code:
+ *     type: string
+ *     title: code
+ *     description: The gift card's code.
+ *   status:
+ *     type: string
+ *     description: The gift card's status.
+ *     enum:
+ *       - pending
+ *       - redeemed
+ *   value:
+ *     type: number
+ *     title: value
+ *     description: The gift card's amount.
+ *   customer_id:
+ *     type: string
+ *     title: customer_id
+ *     description: The ID of the customer that the gift card belongs to.
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: The gift card's ID.
+ *   reference_id:
+ *     type: string
+ *     title: reference_id
+ *     description: The gift card's reference ID.
+ *   reference:
+ *     type: string
+ *     title: reference
+ *     description: The gift card's reference.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the gift card was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the gift card was updated.
+ *   currency_code:
+ *     type: string
+ *     title: currency_code
+ *     description: The gift card's currency code.
+ *     example: usd
+ *   note:
+ *     type: string
+ *     title: note
+ *     description: The gift card's note.
+ *   expires_at:
+ *     type: string
+ *     title: expires_at
+ *     description: The date the gift card expires.
+ *   invitation:
+ *     $ref: "#/components/schemas/StoreGiftCardInvitation"
+ *   line_item:
+ *     $ref: "#/components/schemas/StoreOrderLineItem"
+ * 
+*/
+