chore(oas): [9/n] improve oas schemas (#9166)

2024-09-17 19:27:28 +02:00
parent b5ffed6973
commit d2c48228df
20 changed files with 119 additions and 114 deletions
@@ -1,7 +1,7 @@
 /**
 * @schema AdminPricePreferenceListResponse
 * type: object
- * description: SUMMARY
+ * description: The paginated list of price preferences.
 * x-schemaName: AdminPricePreferenceListResponse
 * required:
 *   - limit
@@ -12,18 +12,18 @@
 *   limit:
 *     type: number
 *     title: limit
- *     description: The price preference's limit.
+ *     description: The maximum number of items returned.
 *   offset:
 *     type: number
 *     title: offset
- *     description: The price preference's offset.
+ *     description: The number of items skipped before retrieving the returned items.
 *   count:
 *     type: number
 *     title: count
- *     description: The price preference's count.
+ *     description: The total count of items.
 *   price_preferences:
 *     type: array
- *     description: The price preference's price preferences.
+ *     description: The list of price preferences.
 *     items:
 *       $ref: "#/components/schemas/AdminPricePreference"
 *