oas: [3/n] improve oas schemas (#9042)

Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
parent a7180e29b8
commit 4b8d9cc735
20 changed files with 285 additions and 97 deletions
@@ -1,7 +1,7 @@
 /**
 * @schema AdminCreateStockLocation
 * type: object
- * description: SUMMARY
+ * description: The stock location's details.
 * x-schemaName: AdminCreateStockLocation
 * required:
 *   - name
@@ -13,12 +13,12 @@
 *   address_id:
 *     type: string
 *     title: address_id
- *     description: The stock location's address id.
+ *     description: The ID of the stock location's address.
 *   address:
 *     $ref: "#/components/schemas/AdminUpsertStockLocationAddress"
 *   metadata:
 *     type: object
- *     description: The stock location's metadata.
+ *     description: The stock location's metadata, used to store custom key-value pairs.
 * 
 */