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

This commit is contained in:
Shahed Nasser
2024-09-17 19:27:28 +02:00
committed by GitHub
parent b5ffed6973
commit d2c48228df
20 changed files with 119 additions and 114 deletions
@@ -1,7 +1,7 @@
/**
* @schema AdminPriceListBatchResponse
* type: object
* description: SUMMARY
* description: The details of the created, updated, and deleted prices in a price list.
* x-schemaName: AdminPriceListBatchResponse
* required:
* - created
@@ -10,17 +10,17 @@
* properties:
* created:
* type: array
* description: The price list's created.
* description: The created prices.
* items:
* $ref: "#/components/schemas/AdminPrice"
* updated:
* type: array
* description: The price list's updated.
* description: The updated prices.
* items:
* $ref: "#/components/schemas/AdminPrice"
* deleted:
* type: object
* description: SUMMARY
* description: The details of the deleted prices.
* required:
* - ids
* - object
@@ -28,19 +28,20 @@
* properties:
* ids:
* type: array
* description: The deleted's ids.
* description: The IDs of the deleted prices.
* items:
* type: string
* title: ids
* description: The id's ids.
* description: A price's ID.
* object:
* type: string
* title: object
* description: SUMMARY
* description: The name of the deleted object.
* default: "price"
* deleted:
* type: boolean
* title: deleted
* description: SUMMARY
* description: Whether the prices were deleted.
*
*/