chore(oas): [16/n] improve oas schemas (#9272)

- Improve OAS schemas [16/n] - fixes and improvements to docs-generator tool
2024-09-26 13:02:32 +00:00
parent ea2cc974cc
commit d352ea8122
20 changed files with 1324 additions and 130 deletions
@@ -3,6 +3,76 @@
 * type: object
 * description: The item's detail.
 * x-schemaName: BaseOrderItemDetail
- * 
+ * required:
+ *   - id
+ *   - item_id
+ *   - quantity
+ *   - fulfilled_quantity
+ *   - delivered_quantity
+ *   - shipped_quantity
+ *   - return_requested_quantity
+ *   - return_received_quantity
+ *   - return_dismissed_quantity
+ *   - written_off_quantity
+ *   - metadata
+ *   - created_at
+ *   - updated_at
+ * properties:
+ *   id:
+ *     type: string
+ *     title: id
+ *     description: the detail's ID.
+ *   item_id:
+ *     type: string
+ *     title: id
+ *     description: the ID of the associated line item.
+ *   item:
+ *     $ref: "#/components/schemas/AdminOrderLineItem"
+ *   quantity:
+ *     type: number
+ *     title: quantity
+ *     description: The item's quantity.
+ *   fulfilled_quantity:
+ *     type: number
+ *     title: fulfilled_quantity
+ *     description: The item's fulfilled quantity.
+ *   delivered_quantity:
+ *     type: number
+ *     title: fulfilled_quantity
+ *     description: The item's delivered quantity.
+ *   shipped_quantity:
+ *     type: number
+ *     title: shipped_quantity
+ *     description: The item's shipped quantity.
+ *   return_requested_quantity:
+ *     type: number
+ *     title: return_requested_quantity
+ *     description: The item's quantity that's requested to be returned.
+ *   return_received_quantity:
+ *     type: number
+ *     title: return_received_quantity
+ *     description: The item's quantity that's returned and added to the underlying variant's stocked quantity.
+ *   return_dismissed_quantity:
+ *     type: number
+ *     title: return_dismissed_quantity
+ *     description: The item's quantity that's returned but damaged. So, it's not added to the underlying variant's stocked quantity.
+ *   written_off_quantity:
+ *     type: number
+ *     title: written_off_quantity
+ *     description: The item's quantity that's removed from the order.
+ *   metadata:
+ *     type: object
+ *     title: metadata
+ *     description: The item's metadata, can hold custom key-value pairs.
+ *   created_at:
+ *     type: string
+ *     format: date-time
+ *     title: created_at
+ *     description: The date the detail was created.
+ *   updated_at:
+ *     type: string
+ *     format: date-time
+ *     title: updated_at
+ *     description: The date the detail was updated.
 */