chore(docs): Updated API Reference (v2) (#9437)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-10-03 07:48:54 +00:00
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions
@@ -1,11 +1,25 @@
 /**
 * @schema AdminOrderChangeAction
 * type: object
- * description: The action's details.
+ * description: The order change action's details.
 * x-schemaName: AdminOrderChangeAction
+ * required:
+ *   - order_change
+ *   - order
+ *   - order_id
+ *   - internal_note
+ *   - id
+ *   - created_at
+ *   - updated_at
+ *   - return_id
+ *   - exchange_id
+ *   - claim_id
+ *   - order_change_id
+ *   - reference
+ *   - reference_id
+ *   - action
+ *   - details
 * properties:
- *   order_change:
- *     $ref: "#/components/schemas/AdminOrderChange"
 *   id:
 *     type: string
 *     title: id
@@ -13,11 +27,31 @@
 *   order_change_id:
 *     type: string
 *     title: order_change_id
- *     description: The ID of the order change this action belongs to.
+ *     description: The ID of the order change that the action belongs to.
+ *   order_change:
+ *     $ref: "#/components/schemas/AdminOrderChange"
 *   order_id:
 *     type: string
 *     title: order_id
- *     description: The ID of the associated order.
+ *     description: The ID of the order the associated change is for.
+ *   return_id:
+ *     type: string
+ *     title: return_id
+ *     description: The ID of the associated return.
+ *   claim_id:
+ *     type: string
+ *     title: claim_id
+ *     description: The ID of the associated claim.
+ *   exchange_id:
+ *     type: string
+ *     title: exchange_id
+ *     description: The ID of the associated exchange.
+ *   order:
+ *     type: string
+ *     title: order
+ *     description: The order change's order.
+ *     externalDocs:
+ *       url: "#pagination"
 *   reference:
 *     type: string
 *     title: reference
@@ -33,8 +67,23 @@
 *     description: The ID of the record in the referenced table.
 *   action:
 *     type: string
- *     title: action
 *     description: The applied action.
+ *     enum:
+ *       - CANCEL_RETURN_ITEM
+ *       - FULFILL_ITEM
+ *       - DELIVER_ITEM
+ *       - CANCEL_ITEM_FULFILLMENT
+ *       - ITEM_ADD
+ *       - ITEM_REMOVE
+ *       - ITEM_UPDATE
+ *       - RECEIVE_DAMAGED_RETURN_ITEM
+ *       - RECEIVE_RETURN_ITEM
+ *       - RETURN_ITEM
+ *       - SHIPPING_ADD
+ *       - SHIPPING_REMOVE
+ *       - SHIP_ITEM
+ *       - WRITE_OFF_ITEM
+ *       - REINSTATE_ITEM
 *   details:
 *     type: object
 *     description: The action's details.
@@ -44,47 +93,17 @@
 *   internal_note:
 *     type: string
 *     title: internal_note
- *     description: A note viewed only by admin users.
+ *     description: A note that's viewed only by admin users.
 *   created_at:
 *     type: string
 *     format: date-time
 *     title: created_at
- *     description: The date the order change action was created.
+ *     description: The date the action was created.
 *   updated_at:
 *     type: string
 *     format: date-time
 *     title: updated_at
- *     description: The date the order change action was updated.
- *   return_id:
- *     type: string
- *     title: return_id
- *     description: The ID of the associated return.
- *   claim_id:
- *     type: string
- *     title: claim_id
- *     description: The ID of the associated claim.
- *   exchange_id:
- *     type: string
- *     title: exchange_id
- *     description: The ID of the associated exchange.
- *   order:
- *     $ref: "#/components/schemas/BaseOrder"
- * required:
- *   - order_change
- *   - id
- *   - order_change_id
- *   - order_id
- *   - reference
- *   - reference_id
- *   - action
- *   - details
- *   - internal_note
- *   - created_at
- *   - updated_at
- *   - return_id
- *   - claim_id
- *   - exchange_id
- *   - order
+ *     description: The date the action was updated.
 * 
 */